ActivityHandler Classe

Referência

Definição

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Pacote:: Microsoft.Bot.Builder v4.18.1

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Uma implementação da IBot interface, destinada a subclasse adicional.

public class ActivityHandler : Microsoft.Bot.Builder.IBot

type ActivityHandler = class
    interface IBot

Public Class ActivityHandler
Implements IBot

Herança: Object
ActivityHandler

Derivado: Microsoft.Bot.Builder.Teams.TeamsActivityHandler

Implementações: IBot

Comentários

Derive dessa classe para conectar o código para lidar com tipos de atividade específicos. O pré e o pós-processamento de Activity objetos podem ser adicionados chamando a implementação da classe base da classe derivada.

Construtores

ActivityHandler()

Uma implementação da IBot interface, destinada a subclasse adicional.

Métodos

CreateInvokeResponse(Object)	Uma InvokeResponse fábrica que inicializa o corpo para o parâmetro passado e status igual a OK.
OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken)	Invocado quando o bot é enviado uma Ação de Cartão Adaptável Executar.
OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken)	Invocado quando uma atividade de comando é recebida quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é 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.
OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken)	Invocado quando uma atividade CommandResult é recebida quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é usado. As atividades CommandResult podem ser usadas para comunicar o resultado de uma execução de comando.
OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken)	Invocado quando uma atividade de atualização de conversa é recebida do canal quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é 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 saudando o usuário. Por padrão, esse método chamará OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) se algum usuário tiver sido adicionado ou OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) se algum usuário tiver sido removido. O método verifica a ID do membro para que ela responda apenas a atualizações relacionadas a membros diferentes do próprio bot.
OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica específica às EndOfConversation atividades, como a lógica de conversa.
OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken)	Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é usado. As atividades de evento podem ser usadas para comunicar várias coisas diferentes. Por padrão, esse método chamará OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) se o nome da atividade for `tokens/response` ou OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) não. Um `tokens/response` evento pode ser disparado por um OAuthCard.
OnEventAsync(ITurnContext<IEventActivity>, CancellationToken)	Invocado quando um evento diferente de `tokens/response` é recebido quando o comportamento base de OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) é usado. Opcionalmente, esse método poderá ser substituído se o bot for destinado a lidar com eventos diversos. Por padrão, esse método não faz nada.
OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica específica às InstallationUpdate atividades.
OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica específica às InstallationUpdate atividades com 'action' definido como 'add'.
OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica específica às InstallationUpdate atividades com 'action' definido como 'remove'.
OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken)	Invocado quando uma atividade de invocação é recebida do conector quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é usado. As atividades de invocação podem ser usadas para comunicar várias coisas diferentes. Por padrão, esse método chamará OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) se o nome da atividade for `signin/verifyState` ou `signin/tokenExchange`. Uma `signin/verifyState` invocação ou `signin/tokenExchange` pode ser disparada por um OAuthCard.
OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	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.
OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)	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.
OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica específica às Message atividades, como a lógica de conversa.
OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken)	Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é usado. As reações de mensagem correspondem ao usuário adicionar um 'like' ou 'sad' etc. (geralmente um emoji) a uma atividade enviada anteriormente. As reações de mensagem só têm suporte de 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.
OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica para quando as reações a uma atividade anterior forem adicionadas à conversa.
OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica para quando as reações a uma atividade anterior forem removidas da conversa.
OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken)	Invocado quando o bot é enviado uma atividade 'invoke' com o nome de 'application/search'.
OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken)	Invocado quando um `signin/verifyState` evento ou `signin/tokenExchange` é recebido quando o comportamento base de OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) é usado. Se estiver usando um `OAuthPrompt`, substitua esse método para encaminhar isso Activity para a caixa de diálogo atual. Por padrão, esse método não faz nada.
OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken)	Invocado quando um `tokens/response` evento é recebido quando o comportamento base de OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) é usado. Se estiver usando um `OAuthPrompt`, substitua esse método para encaminhar isso Activity para a caixa de diálogo atual. Por padrão, esse método não faz nada.
OnTurnAsync(ITurnContext, CancellationToken)	Chamado pelo adaptador (por exemplo, um BotFrameworkAdapter) em runtime para processar um de entrada Activity.
OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)	Substitua isso em uma classe derivada para fornecer lógica específica às Typing atividades, como a lógica de conversa.
OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken)	Invocado quando uma atividade diferente de uma mensagem, atualização de conversa ou evento é recebida quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é usado. Se substituído, isso pode potencialmente responder a qualquer um dos outros tipos de atividade, como ContactRelationUpdate ou EndOfConversation. Por padrão, esse método não faz nada.

Aplica-se a

Compartilhar via