BotAdapter Classe

Pacote:

com.microsoft.bot.builder

Artefato Maven:

com.microsoft.bot:bot-builder:4.14.3

• java.lang.Object
• • com.microsoft.bot.builder.BotAdapter

public abstract class BotAdapter

Representa um adaptador de bot que pode conectar um bot a um ponto de extremidade de serviço. Essa classe é abstrata.

O adaptador de bot encapsula processos de autenticação e envia atividades para e recebe atividades do Serviço do Bot Connector. Quando o bot recebe uma atividade, o adaptador cria um objeto de contexto, passa-o para a lógica do aplicativo do bot e envia respostas de volta para o canal do usuário.

Use use(Middleware middleware) para adicionar objetos Middleware ao adaptador\u2019coleção de middleware. O adaptador processa e direciona as atividades de entrada por meio do pipeline de middleware de bot para o bot\u2019lógica e, em seguida, voltar para fora novamente. À medida que cada atividade entra e sai do bot, cada parte do middleware pode inspecionar ou agir sobre a atividade, antes e depois da execução da lógica do bot.

TurnContext Activity Bot Middleware

Resumo do campo

Modificador e tipo	Campo e descrição
static final java.lang.String	BOT_IDENTITY_KEY Chave para armazenar a identidade de declarações do bot.
static final java.lang.String	OAUTH_CLIENT_KEY Chave para armazenar o cliente do bot oauth.
static final java.lang.String	OAUTH_SCOPE_KEY Chave para armazenar o escopo do bot oauth.

Resumo do Construtor

Construtor	Description
BotAdapter()

Resumo do método

Modificador e tipo	Método e descrição
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(TurnContext context, ConversationReference reference) Quando substituído em uma classe derivada, exclui uma atividade existente na conversa.
protected MiddlewareSet	getMiddlewareSet() Obtém a coleção de middleware no pipeline do adaptador.
OnTurnErrorHandler	getOnTurnError() Obtém o manipulador de erros que pode capturar exceções no middleware ou aplicativo.
protected java.util.concurrent.CompletableFuture<java.lang.Void>	runPipeline(TurnContext context, BotCallbackHandler callback) Inicia o processamento de atividades para a curva do bot atual.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(TurnContext context, List<Activity> activities) Quando substituído em uma classe derivada, envia atividades para a conversa.
void	setOnTurnError(OnTurnErrorHandler withTurnError) Define o manipulador de erros que pode capturar exceções no middleware ou aplicativo.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(TurnContext context, Activity activity) Quando substituído em uma classe derivada, substitui uma atividade existente na conversa.
BotAdapter	use(Middleware middleware) Adiciona middleware ao pipeline do adaptador.

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do campo

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Chave para armazenar a identidade de declarações do bot.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

Chave para armazenar o cliente do bot oauth.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

Chave para armazenar o escopo do bot oauth.

Detalhes do construtor

BotAdapter

public BotAdapter()

Detalhes do método

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

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.

Parâmetros:

claimsIdentity - Uma ClaimsIdentity para a conversa.

continuationActivity - Uma atividade com a ConversationReference apropriada com a qual continuar a conversa.

callback - O método a ser chamado para a curva do bot de resultado.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

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.

Parâmetros:

claimsIdentity - Uma ClaimsIdentity para a conversa.

continuationActivity - Uma atividade com a ConversationReference apropriada com a qual continuar a conversa.

audience - Um valor que significa o destinatário da mensagem proativa.

callback - O método a ser chamado para a curva do bot de resultado.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

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.

Parâmetros:

claimsIdentity - Uma referência claimsIdentity para a conversa.

reference - Uma referência à conversa a continuar.

callback - O método a ser chamado para a curva do bot de resultado.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

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.

Parâmetros:

claimsIdentity - Uma referência claimsIdentity para a conversa.

reference - Uma referência à conversa a continuar.

audience - Um valor que significa o destinatário da mensagem proativa.

callback - O método a ser chamado para a curva do bot de resultado.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

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.

Parâmetros:

botId - A ID do aplicativo do bot. Esse parâmetro é ignorado em um único locatário dos Adaptadores (Console, Teste etc.), mas é fundamental para o BotFrameworkAdapter, que tem reconhecimento multilocatário.

continuationActivity - Uma atividade com a ConversationReference apropriada com a qual continuar a conversa.

callback - O método a ser chamado para a curva do bot de resultado.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Envia uma mensagem proativa para uma conversa.

Parâmetros:

botAppId - A ID do aplicativo do bot. Esse parâmetro é ignorado em um único locatário dos Adaptadores (Console, Teste etc.), mas é fundamental para o BotFrameworkAdapter, que tem reconhecimento multilocatário.

reference - Uma referência à conversa a continuar.

callback - O método a ser chamado para a curva de bot resultante.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. 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.

     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Quando substituído em uma classe derivada, exclui uma atividade existente na conversa.

Parâmetros:

context - O objeto de contexto para a curva.

reference - Referência de conversa para a atividade a ser excluída.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. O ConversationReference#getActivityId da referência de conversa identifica a atividade a ser excluída. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

Obtém a coleção de middleware no pipeline do adaptador.

Retornos:

A coleção de middleware para o pipeline.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

Obtém o manipulador de erros que pode capturar exceções no middleware ou aplicativo.

Retornos:

Um manipulador de erros que pode capturar exceções no middleware ou aplicativo.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Inicia o processamento de atividades para a curva do bot atual. O adaptador chama o middleware na ordem em que você o adicionou. O adaptador passa o objeto de contexto para a curva e um próximo delegado, e o middleware chama o delegado para passar o controle para o próximo middleware no pipeline. Depois que o controle atinge o final do pipeline, o adaptador chama o método callback. Se um componente de middleware não chamar o próximo delegado, o adaptador não chamará nenhum dos métodos de onTurn(TurnContext turnContext, NextDelegate next) de\u2019de middleware subsequentes ou o método de retorno de chamada e os curtos-circuitos do pipeline.

Quando a curva for iniciada por uma atividade do usuário (mensagens reativas), o método de retorno de chamada será uma referência ao método onTurn(TurnContext turnContext) do bot. Quando a curva é iniciada por uma chamada para continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (mensagens proativas), o método de retorno de chamada é o método de retorno de chamada fornecido na chamada.

Parâmetros:

context - O objeto de contexto da curva.

callback - Um método de retorno de chamada a ser executado no final do pipeline.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

Quando substituído em uma classe derivada, envia atividades para a conversa.

Parâmetros:

context - O objeto de contexto para a curva.

activities - As atividades a serem enviadas.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se as atividades forem enviadas com êxito, o resultado da tarefa conterá uma matriz de objetos ResourceResponse contendo as IDs que o canal de recebimento atribuiu às atividades. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

Define o manipulador de erros que pode capturar exceções no middleware ou aplicativo.

Parâmetros:

withTurnError - Um manipulador de erros que pode capturar exceções no middleware ou aplicativo.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

Quando substituído em uma classe derivada, substitui uma atividade existente na conversa.

Parâmetros:

context - O objeto de contexto para a curva.

activity - Nova atividade de substituição.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. 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 isso, defina a ID da atividade de substituição como a ID da atividade a ser substituída. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

Adiciona middleware ao pipeline do adaptador.

Parâmetros:

middleware - O middleware a ser adicionado.

Retornos:

O objeto do adaptador atualizado. O middleware é adicionado ao adaptador no momento da inicialização. Para cada turno, o adaptador chama o middleware na ordem em que você o adicionou.