BotFrameworkAdapter Classe

can_process_outgoing_activity(activity: Activity) -> bool

Parâmetros

Continua uma conversa com um usuário.

e geralmente é encontrado no parâmetro MicrosoftAppId no config.py. :type bot_id: <xref:typing.str> :p aram claims_identity: The bot claims identity :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience: :type audience: <xref:typing.str>

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

Parâmetros

Retornos

Exceções

Comentários

Isso geralmente é chamado de bots fluxo proativo de mensagens, pois permite que o bot envie mensagens proativamente para uma conversa ou usuário que já está em uma comunicação. Cenários como enviar notificações ou cupons para um usuário são habilitados por essa função.

Implementação de ConnectorClientProvider.create_connector_client.

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

Parâmetros

Retornos

Inicia uma nova conversa com um usuário. Usado para direcionar a mensagem para um membro de um grupo.

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)

Parâmetros

Retornos

Exceções

Comentários

Para iniciar uma conversa, o bot deve saber suas informações de conta e as informações da conta do usuário nesse canal. A maioria dos canais dá suporte apenas ao início de uma conversa direta (não em grupo). O adaptador tenta criar uma nova conversa no canal e envia uma atividade de atualização de conversa por meio de seu pipeline de middleware para o método de retorno de chamada. Se a conversa for estabelecida com os usuários especificados, a ID da atividade conterá a ID da nova conversa.

Exclui uma atividade que foi enviada anteriormente para um canal. Observe que nem todos os canais dão suporte a esse recurso.

async delete_activity(context: TurnContext, reference: ConversationReference)

Parâmetros

Retornos

Exceções

Exclui um membro da conversa atual.

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

Parâmetros

Retornos

Exceções

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

Parâmetros

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

Parâmetros

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.

da atividade no TurnContext. :type user_id: str :p aram oauth_app_credentials: (Opcional) AppCredentials for 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]

Parâmetros

Retornos

Lista os membros de uma determinada atividade.

Se não for especificado, a ID das atividades atuais será usada.

async get_activity_members(context: TurnContext, activity_id: str)

Parâmetros

Retornos

Exceções

Recuperar um membro de uma conversa atual.

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

Parâmetros

Retornos

Exceções

Lista os membros de uma conversa atual.

async get_conversation_members(context: TurnContext)

Parâmetros

Retornos

Exceções

Lista as conversas nas quais esse bot participou para um determinado servidor de canal.

context.activity.serviceUrl :type service_url: str

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

Parâmetros

Retornos

Exceções

Comentários

O servidor de canal retorna resultados em páginas e cada página incluirá um continuationToken que pode ser usado para buscar a próxima página de resultados do servidor. Se a tarefa for concluída com êxito, o resultado conterá uma página dos membros da conversa atual. Essa sobrecarga pode ser chamada de fora do contexto de uma conversa, pois somente a URL de serviço e as credenciais do bot são necessárias.

Obtém o link de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão.

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

Parâmetros

Retornos

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

Parâmetros

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

Parâmetros

Recupera o status do token para cada conexão configurada para o usuário fornecido.

Em branco retornará o status do token para todas as conexões configuradas. :type include_filter: str :p aram oauth_app_credentials: (Opcional) AppCredentials for 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]

Parâmetros

Retornos

Tenta recuperar o token de um usuário que está em um fluxo de logon.

:p aram magic_code" (Opcional) o usuário inseriu o código para validar :str magic_code" str :p aram oauth_app_credentials: (Opcional) AppCredentials for 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

Parâmetros

Retornos

Exceções

static key_for_app_credentials(app_id: str, scope: str)

Parâmetros

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

Parâmetros

Analisa e valida a solicitação :p aram req: :return:

async static parse_request(req)

Parâmetros

Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada.

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

Parâmetros

Retornos

Comentários

Essa classe processa uma atividade recebida pelo servidor Web de bots. Isso inclui todas as mensagens enviadas de um usuário e é o método que conduz o que geralmente é chamado de bots fluxo de mensagens reativas. Chame esse método para enviar novamente uma mensagem para uma conversa. Se a tarefa for concluída com êxito, um InvokeResponse será retornado; caso contrário. nulo é retornado.

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

Parâmetros

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

Parâmetros

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

Parâmetros

Desconscreve o usuário com o servidor de token.

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

Parâmetros

Substitui uma atividade que foi enviada anteriormente para um canal. Observe que nem todos os canais dão suporte a esse recurso.

async update_activity(context: TurnContext, activity: Activity)

Parâmetros

Retornos

Exceções

Comentários

Se a atividade for enviada com êxito, o resultado da tarefa conterá um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade. Antes de chamar essa função, defina a ID da atividade de substituição como a ID da atividade a ser substituída.