BotFrameworkAdapter Класс

can_process_outgoing_activity(activity: Activity) -> bool

Параметры

Продолжает беседу с пользователем.

и обычно находится в параметре MicrosoftAppId в config.py. :type bot_id: <xref:typing.str> :p aram claims_identity: удостоверение утверждения бота :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram аудитория: :type audience: <xref:typing.str>

async continue_conversation(reference: ConversationReference, callback: Callable, bot_id: str = None, claims_identity: ClaimsIdentity = None, audience: str = None)

Параметры

Возвращаемое значение

Исключения

Комментарии

Это часто называется ботами, упреждающим обменом сообщениями потоком, так как он позволяет боту заранее отправлять сообщения в беседу или пользователя, которые уже находятся в обмене данными. Такие сценарии, как отправка уведомлений или купонов пользователю, включены этой функцией.

Реализация ConnectorClientProvider.create_connector_client.

async create_connector_client(service_url: str, identity: ClaimsIdentity = None, audience: str = None) -> ConnectorClient

Параметры

Возвращаемое значение

Запускает новую беседу с пользователем. Используется для направления сообщения участнику группы.

async create_conversation(reference: ConversationReference, logic: Callable[[TurnContext], Awaitable] = None, conversation_parameters: ConversationParameters = None, channel_id: str = None, service_url: str = None, credentials: AppCredentials = None)

Параметры

Возвращаемое значение

Исключения

Комментарии

Чтобы начать беседу, бот должен знать сведения о своей учетной записи и сведения об учетной записи пользователя в этом канале. Большинство каналов поддерживают только инициирование прямой беседы (негрупповой). Адаптер пытается создать новую беседу в канале, а затем отправляет действие обновления беседы через конвейер по промежуточному слоям в метод обратного вызова. Если беседа установлена с указанными пользователями, идентификатор действия будет содержать идентификатор нового диалога.

Удаляет действие, которое ранее было отправлено в канал. Следует отметить, что не все каналы поддерживают эту функцию.

async delete_activity(context: TurnContext, reference: ConversationReference)

Параметры

Возвращаемое значение

Исключения

Удаляет члена из текущей беседы.

async delete_conversation_member(context: TurnContext, member_id: str) -> None

Параметры

Возвращаемое значение

Исключения

async exchange_token(turn_context: TurnContext, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

Параметры

async exchange_token_from_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

Параметры

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.

из действия в TurnContext. :type user_id: str :p aram oauth_app_credentials: (необязательно) AppCredentials для OAuth. :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

async get_aad_tokens(context: TurnContext, connection_name: str, resource_urls: List[str], user_id: str = None, oauth_app_credentials: AppCredentials = None) -> Dict[str, TokenResponse]

Параметры

Возвращаемое значение

Выводит список членов заданного действия.

Если не указан идентификатор текущей активности, будет использоваться.

async get_activity_members(context: TurnContext, activity_id: str)

Параметры

Возвращаемое значение

Исключения

Получение члена текущей беседы.

async get_conversation_member(context: TurnContext, member_id: str) -> ChannelAccount

Параметры

Возвращаемое значение

Исключения

Выводит список членов текущей беседы.

async get_conversation_members(context: TurnContext)

Параметры

Возвращаемое значение

Исключения

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов.

context.activity.serviceUrl :type service_url: str

async get_conversations(service_url: str, credentials: AppCredentials, continuation_token: str = None)

Параметры

Возвращаемое значение

Исключения

Комментарии

Сервер каналов возвращает результаты на страницах, и каждая страница будет включать продолженияToken, которые можно использовать для получения следующей страницы результатов с сервера. Если задача выполнена успешно, результат содержит страницу членов текущей беседы. Эта перегрузка может вызываться извне контекста беседы, так как требуются только URL-адрес службы бота и учетные данные.

Возвращает необработанную ссылку на вход, отправляемую пользователю для входа в имя подключения.

async get_oauth_sign_in_link(context: TurnContext, connection_name: str, final_redirect: str = None, oauth_app_credentials: AppCredentials = None) -> str

Параметры

Возвращаемое значение

async get_sign_in_resource_from_user(turn_context: TurnContext, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

Параметры

async get_sign_in_resource_from_user_and_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

Параметры

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.

Пустой возвращает состояние маркера для всех настроенных подключений. :type include_filter: str :p aram oauth_app_credentials: (необязательно) AppCredentials для OAuth. :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

async get_token_status(context: TurnContext, connection_name: str = None, user_id: str = None, include_filter: str = None, oauth_app_credentials: AppCredentials = None) -> List[TokenStatus]

Параметры

Возвращаемое значение

Пытается получить маркер для пользователя, который находится в потоке входа.

:p aram magic_code" (необязательно) ввел код для проверки :str magic_code" str :p aram oauth_app_credentials: (необязательно) AppCredentials для OAuth. :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

async get_user_token(context: TurnContext, connection_name: str, magic_code: str = None, oauth_app_credentials: AppCredentials = None) -> TokenResponse

Параметры

Возвращаемое значение

Исключения

static key_for_app_credentials(app_id: str, scope: str)

Параметры

static key_for_connector_client(service_url: str, app_id: str, scope: str)

Параметры

Анализирует и проверяет запрос :p aram req: :return:

async static parse_request(req)

Параметры

Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.

async process_activity(req, auth_header: str, logic: Callable)

Параметры

Возвращаемое значение

Комментарии

Этот класс обрабатывает действие, полученное веб-сервером ботов. Это включает все сообщения, отправленные пользователем, и является методом, который часто называется ботами, реактивного обмена сообщениями потока. Вызовите этот метод для реактивной отправки сообщения в беседу. Если задача выполнена успешно, возвращается InvokeResponse; иначе. возвращается null.

async process_activity_with_identity(activity: Activity, identity: ClaimsIdentity, logic: Callable)

Параметры

async process_outgoing_activity(turn_context: TurnContext, activity: Activity) -> ResourceResponse

Параметры

async send_activities(context: TurnContext, activities: List[Activity]) -> List[ResourceResponse]

Параметры

Подписывает пользователя с помощью сервера токенов.

async sign_out_user(context: TurnContext, connection_name: str = None, user_id: str = None, oauth_app_credentials: AppCredentials = None)

Параметры

Заменяет действие, которое ранее было отправлено в канал. Следует отметить, что не все каналы поддерживают эту функцию.

async update_activity(context: TurnContext, activity: Activity)

Параметры

Возвращаемое значение

Исключения

Комментарии

Если действие успешно отправлено, результат задачи содержит объект ResourceResponse, содержащий идентификатор, назначенный принимающему каналу действия. Перед вызовом этой функции задайте идентификатор действия замены идентификатору действия для замены.