BotAdapter Classe

Herança

ABC

BotAdapter

Construtor

BotAdapter(on_turn_error: Callable[[TurnContext, Exception], Awaitable] = None)

Parâmetros

Nome	Description
on_turn_error	valor padrão: None

Métodos

continue_conversation	Envia uma mensagem proativa para uma conversa. Chame esse método para enviar proativamente uma mensagem para uma conversa. A maioria dos canais exige que um usuário inicie uma conversa com um bot antes que o bot possa enviar atividades ao usuário. locatário único, os Adaptadores (Console, Teste etc.), mas é fundamental para o BotFrameworkAdapter, que tem reconhecimento multilocatário. referência :p aram: uma referência à conversa para continuar. :type reference: ConversationReference :p aram callback: o método a ser chamado para a volta do bot resultante. :type callback: Callable :p aram claims_identity: A <xref:botframework.connector.auth.ClaimsIdentity> para a conversa. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value significando o destinatário da mensagem proativa. :type audience: str
create_conversation	Inicia uma nova conversa com um usuário. Usado para direcionar a mensagem a um membro de um grupo.
delete_activity	Exclui uma atividade existente.
run_pipeline	Chamado pela classe pai para executar o conjunto de middleware de adaptadores e chama o manipulador callback() passado no final da cadeia.
send_activities	Envia um conjunto de atividades para o usuário. Uma matriz de respostas do servidor será retornada.
update_activity	Substitui uma atividade existente.
use	Registra um manipulador de middleware com o adaptador .

continue_conversation

Envia uma mensagem proativa para uma conversa. Chame esse método para enviar proativamente uma mensagem para uma conversa. A maioria dos canais exige que um usuário inicie uma conversa com um bot antes que o bot possa enviar atividades ao usuário.

locatário único, os Adaptadores (Console, Teste etc.), mas é fundamental para o BotFrameworkAdapter, que tem reconhecimento multilocatário. referência :p aram: uma referência à conversa para continuar. :type reference: ConversationReference :p aram callback: o método a ser chamado para a volta do bot resultante. :type callback: Callable :p aram claims_identity: A <xref:botframework.connector.auth.ClaimsIdentity> para a conversa. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value significando o destinatário da mensagem proativa. :type audience: str

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

Parâmetros

Nome	Description
bot_id	A ID do aplicativo do bot. Esse parâmetro é ignorado em valor padrão: None
reference Obrigatório
callback Obrigatório
claims_identity	valor padrão: None
audience	valor padrão: None

create_conversation

Inicia uma nova conversa com um usuário. Usado para direcionar a mensagem a 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

Nome	Description
reference Obrigatório	ConversationReference A referência de conversa que contém o locatário
logic	Callable A lógica a ser usada para a criação da conversa valor padrão: None
conversation_parameters	As informações a serem usadas para criar a conversa valor padrão: None
channel_id	<xref:typing.str> A ID do canal. valor padrão: None
service_url	<xref:typing.str> O ponto de extremidade da URL de serviço do canal. valor padrão: None
credentials	<xref:botframework.connector.auth.AppCredentials> As credenciais do aplicativo para o bot. valor padrão: None

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução.

Exceções

Tipo	Description
It raises a generic exception error.

Comentários

Para iniciar uma conversa, seu 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 de mensagem direta (não grupo). O adaptador tenta criar uma nova conversa no canal e, em seguida, 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.

delete_activity

Exclui uma atividade existente.

abstract async delete_activity(context: TurnContext, reference: ConversationReference)

Parâmetros

Nome	Description
context Obrigatório	<xref:botbuilder.core.bot_adapter.TurnContext> O objeto de contexto para a curva.
reference Obrigatório	ConversationReference Referência de conversa para a atividade a ser excluída.

run_pipeline

Chamado pela classe pai para executar o conjunto de middleware de adaptadores e chama o manipulador callback() passado no final da cadeia.

async run_pipeline(context: TurnContext, callback: Callable[[TurnContext], Awaitable] = None)

Parâmetros

Nome	Description
context Obrigatório	<xref:botbuilder.core.bot_adapter.TurnContext> O objeto de contexto para a curva.
callback	Callable[[<xref:TurnContext>],<xref: Awaitable>] Um método de retorno de chamada a ser executado no final do pipeline. valor padrão: None

send_activities

Envia um conjunto de atividades para o usuário. Uma matriz de respostas do servidor será retornada.

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

Parâmetros

Nome	Description
context Obrigatório	<xref:botbuilder.core.bot_adapter.TurnContext> O objeto de contexto para a curva.
activities Obrigatório	List[<xref:Activity>] As atividades a serem enviadas.

update_activity

Substitui uma atividade existente.

abstract async update_activity(context: TurnContext, activity: Activity)

Parâmetros

Nome	Description
context Obrigatório	<xref:botbuilder.core.bot_adapter.TurnContext> O objeto de contexto para a curva.
activity Obrigatório	Activity Nova atividade de substituição.

use

Registra um manipulador de middleware com o adaptador .

use(middleware)

Parâmetros

Nome	Description
middleware Obrigatório	O middleware a ser registrado.

Atributos

BOT_CALLBACK_HANDLER_KEY

BOT_CALLBACK_HANDLER_KEY = 'BotCallbackHandler'

BOT_CONNECTOR_CLIENT_KEY

BOT_CONNECTOR_CLIENT_KEY = 'ConnectorClient'

BOT_IDENTITY_KEY

BOT_IDENTITY_KEY = 'BotIdentity'

BOT_OAUTH_SCOPE_KEY

BOT_OAUTH_SCOPE_KEY = 'botbuilder.core.BotAdapter.OAuthScope'