ActivityHandler Classe

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

Cria um InvokeResponse de êxito com o corpo especificado.

Parâmetros:

Retornos:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

Invocado quando o bot é enviado uma ação de cartão adaptável executar.

Parâmetros:

Retornos:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

Invocado quando uma atividade de comando é recebida quando o comportamento base de onTurn(TurnContext turnContext) é usado. Comandos são solicitações para executar uma ação e os receptores normalmente respondem com uma ou mais atividades commandResult. Espera-se também que os receptores rejeitem explicitamente atividades de comando sem suporte.

Parâmetros:

Retornos:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

Invocado quando uma atividade CommandResult é recebida quando o comportamento base de onTurn(TurnContext turnContext) é usado. As atividades CommandResult podem ser usadas para comunicar o resultado de uma execução de comando.

Parâmetros:

Retornos:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

Invocado quando uma atividade de atualização de conversa é recebida do canal quando o comportamento base de onTurn(TurnContext turnContext) é usado.

As atividades de atualização de conversa são úteis quando se trata de responder aos usuários que estão sendo adicionados ou removidos da conversa.

Por exemplo, um bot pode responder a um usuário que está sendo adicionado cumprimentando o usuário. Por padrão, esse método chamará onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) se algum usuário tiver sido adicionado ou onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) se algum usuário tiver sido removido. O método verifica a ID do membro para que ele responda apenas às atualizações relacionadas a membros diferentes do próprio bot.

Parâmetros:

Retornos:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica específica para atividades de ActivityTypes.END_OF_CONVERSATION.

Parâmetros:

Retornos:

protected CompletableFuture onEvent(TurnContext turnContext)

Invocado quando um evento diferente de tokens/resposta é recebido quando o comportamento base de onEventActivity(TurnContext turnContext) é usado.

Esse método poderá ser substituído opcionalmente se o bot for destinado a lidar com eventos diversos.

Por padrão, esse método não faz nada.

Quando o método onEventActivity(TurnContext turnContext) recebe um evento com um Activity#getName() diferente de "tokens/resposta", ele chama esse método.

Parâmetros:

Retornos:

protected CompletableFuture onEventActivity(TurnContext turnContext)

Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de onTurn(TurnContext turnContext) é usado.

As atividades de evento podem ser usadas para comunicar várias coisas diferentes.

Por padrão, esse método chamará onTokenResponseEvent(TurnContext turnContext) se o nome da atividade for "tokens/resposta" ou onEvent(TurnContext turnContext) caso contrário. O evento "tokens/resposta" pode ser disparado por um com.microsoft.bot.schema.OAuthCard.

Quando o método onTurn(TurnContext turnContext) recebe uma atividade de evento, ele chama esse método.

Se o evento Activity#getName for "tokens/resposta", ele chamará onTokenResponseEvent(TurnContext turnContext) caso contrário, ele chamará onEvent(TurnContext turnContext).

Em uma classe derivada, substitua esse método para adicionar a lógica que se aplica a todas as atividades de evento. Adicione lógica a ser aplicada antes da lógica específica de tratamento de eventos antes da chamada ao método de classe base. Adicione lógica a ser aplicada após a lógica específica de tratamento de eventos após a chamada ao método de classe base.

As atividades de evento comunicam informações programáticas de um cliente ou canal para um bot. O significado de uma atividade de evento é definido pela propriedade Activity#getName, que é significativa dentro do escopo de um canal. Um evento "tokens/resposta" pode ser disparado por um com.microsoft.bot.schema.OAuthCard ou um prompt OAuth.

Parâmetros:

Retornos:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer uma lógica específica às atividades ActivityTypes.InstallationUpdate.

Parâmetros:

Retornos:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica específica às atividades ActivityTypes.InstallationUpdate com 'action' definido como 'add'.

Parâmetros:

Retornos:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica específica às atividades ActivityTypes.InstallationUpdate com 'action' definido como 'remove'.

Parâmetros:

Retornos:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

Invocado quando uma atividade de invocação é recebida do conector quando o comportamento base do onTurn é usado.

As atividades de invocação podem ser usadas para comunicar várias coisas diferentes. Por padrão, esse método chamará onSignInInvokeAsync se o nome da atividade for 'signin/verifyState' ou 'signin/tokenExchange'.

Uma invocação "signin/verifyState" ou "signin/tokenExchange" pode ser disparada por um OAuthCard.

Parâmetros:

Retornos:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica para quando membros diferentes do bot ingressarem na conversa, como a lógica de boas-vindas do bot.

Quando o método onConversationUpdateActivity(TurnContext turnContext) recebe uma atividade de atualização de conversa que indica que um ou mais usuários diferentes do bo estão ingressando na conversa, ele chama esse método.

Parâmetros:

Retornos:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica para quando membros diferentes do bot deixarem a conversa, como a lógica de adeus do bot.

Quando o método onConversationUpdateActivity(TurnContext turnContext) recebe uma atividade de atualização de conversa que indica que um ou mais usuários diferentes do bot estão deixando a conversa, ele chama esse método.

Parâmetros:

Retornos:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica específica para atividades de ActivityTypes#MESSAGE, como a lógica de conversação.

Quando o método onTurn(TurnContext turnContext) recebe uma atividade de mensagem, ele chama esse método.

Parâmetros:

Retornos:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de onTurn(TurnContext turnContext) é usado.

As reações de mensagem correspondem ao usuário adicionando um 'like' ou 'sad' etc. (geralmente um emoji) a uma atividade enviada anteriormente. As reações de mensagem só têm suporte em alguns canais.

A atividade à qual a reação da mensagem corresponde é indicada na propriedade replyToId. O valor dessa propriedade é a ID de atividade de uma atividade enviada anteriormente dada de volta ao bot como a resposta de uma chamada de envio.

Quando o método onTurn(TurnContext turnContext) recebe uma atividade de reação de mensagem, ele chama esse método. Se a reação da mensagem indicar que as reações foram adicionadas a uma mensagem, ela chamará onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext). Se a reação da mensagem indicar que as reações foram removidas de uma mensagem, ela chamará onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext).

Em uma classe derivada, substitua esse método para adicionar lógica que se aplica a todas as atividades de reação de mensagem. Adicione lógica a ser aplicada antes das reações adicionadas ou removidas da lógica antes da chamada ao método de classe base. Adicione lógica a ser aplicada após as reações adicionadas ou removidas da lógica após a chamada à classe base.

Parâmetros:

Retornos:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica para quando as reações a uma atividade anterior são adicionadas à conversa.

As reações de mensagem correspondem ao usuário adicionando um 'like' ou 'sad' etc. (muitas vezes um emoji) a uma mensagem enviada anteriormente na conversa. As reações de mensagem são suportadas por apenas alguns canais. A atividade à qual a mensagem está em reação é identificada pela propriedade Activity#getReplyToId() da atividade. O valor dessa propriedade é a ID de atividade de uma atividade enviada anteriormente. Quando o bot envia uma atividade, o canal atribui uma ID a ela, que está disponível no com.microsoft.bot.schema.ResourceResponse#getId do resultado.

Parâmetros:

Retornos:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer lógica para quando as reações a uma atividade anterior forem removidas da conversa.

As reações de mensagem correspondem ao usuário adicionando um 'like' ou 'sad' etc. (muitas vezes um emoji) a uma mensagem enviada anteriormente na conversa. As reações de mensagem são suportadas por apenas alguns canais. A atividade à qual a mensagem está em reação é identificada pela propriedade Activity#getReplyToId() da atividade. O valor dessa propriedade é a ID de atividade de uma atividade enviada anteriormente. Quando o bot envia uma atividade, o canal atribui uma ID a ela, que está disponível no com.microsoft.bot.schema.ResourceResponse#getId do resultado.

Parâmetros:

Retornos:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

Invocado quando um evento 'signin/verifyState' ou 'signin/tokenExchange' é recebido quando o comportamento base de onInvokeActivity é usado.

Se estiver usando um OAuthPrompt, substitua esse método para encaminhar essa Atividade para a caixa de diálogo atual. Por padrão, esse método não faz nada.

Quando o método onInvokeActivity recebe uma Invocação com um nome de 'tokens/resposta', ele chama esse método.

Se o bot usar o OAuthPrompt, encaminhe a Atividade de entrada para a caixa de diálogo atual.

Parâmetros:

Retornos:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

Invocado quando um evento "tokens/resposta" é recebido quando o comportamento base de onEventActivity(TurnContext turnContext) é usado.

Se estiver usando um OAuthPrompt, substitua esse método para encaminhar esse Activity para a caixa de diálogo atual.

Por padrão, esse método não faz nada.

Quando o método onEventActivity(TurnContext turnContext) recebe um evento com um Activity#getName() de "tokens/resposta", ele chama esse método.

Parâmetros:

Retornos:

public CompletableFuture onTurn(TurnContext turnContext)

Chamado pelo adaptador (por exemplo, um BotFrameworkAdapter) em runtime para processar um Activityde entrada.

Esse método chama outros métodos nessa classe com base no tipo da atividade a ser processada, o que permite que uma classe derivada forneça lógica específica de tipo de forma controlada.

Em uma classe derivada, substitua esse método para adicionar lógica que se aplica a todos os tipos de atividade. Adicione lógica a ser aplicada antes da lógica específica do tipo antes da chamada para a classe base onTurn(TurnContext turnContext) método. Adicione lógica a ser aplicada após a lógica específica do tipo após a chamada para a classe base onTurn(TurnContext turnContext) método.

Parâmetros:

Retornos:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

Substitua isso em uma classe derivada para fornecer uma lógica específica às atividades ActivityTypes.Typing.

Parâmetros:

Retornos:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

Invocado quando uma atividade diferente de uma mensagem, atualização de conversa ou evento é recebida quando o comportamento base de onTurn(TurnContext turnContext) é usado.

Se substituído, isso pode potencialmente responder a qualquer um dos outros tipos de atividade, como com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE ou com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION.

Por padrão, esse método não faz nada.

Quando o método onTurn(TurnContext turnContext) recebe uma atividade que não é uma mensagem, atualização de conversa, reação de mensagem ou atividade de evento, ele chama esse método.

Parâmetros:

Retornos: