Partilhar via


ActivityHandler Classe

Definição

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

public class ActivityHandler : Microsoft.Bot.Builder.IBot
type ActivityHandler = class
    interface IBot
Public Class ActivityHandler
Implements IBot
Herança
ActivityHandler
Derivado
Implementações

Observações

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

Construtores

ActivityHandler()

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

Métodos

CreateInvokeResponse(Object)

Uma fábrica de InvokeResponse 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 Adaptive Card Action Execute.

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 recetores normalmente respondem com uma ou mais atividades commandResult. Espera-se também que os recetores rejeitem explicitamente as atividades de comando não suportadas.

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 do OnTurnAsync(ITurnContext, CancellationToken) é usado. As atividades de atualização de conversação são úteis quando se trata de responder a 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á 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 o ID do membro para que ele só responda a atualizações sobre membros diferentes do próprio bot.

OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)

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

OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken)

Invocado quando uma atividade de evento é recebida do conector quando o comportamento base do OnTurnAsync(ITurnContext, CancellationToken) é usado. As atividades do evento podem ser usadas para comunicar muitas 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) de outra forma. Um evento tokens/response pode ser acionado 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 pode ser substituído se o bot se destinar 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 para InstallationUpdate atividades.

OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

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

OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

Substitua isso em uma classe derivada para fornecer lógica específica para 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 muitas 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 ou signin/tokenExchange invocar pode ser acionada por um OAuthCard.

OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)

Substitua isso em uma classe derivada para fornecer lógica para quando outros membros além 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 outros membros além do bot deixarem a conversa, como a lógica de despedida do bot.

OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)

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

OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken)

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

OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken)

Invocado quando uma atividade de evento é recebida do conector quando o comportamento base do OnTurnAsync(ITurnContext, CancellationToken) é usado. As reações de mensagem correspondem ao usuário adicionar um "like" ou "triste", etc. (geralmente um emoji) a uma atividade enviada anteriormente. As reações de mensagem são suportadas apenas por alguns canais. A atividade à qual a reação da mensagem corresponde é indicada na propriedade replyToId. O valor dessa propriedade é o ID de atividade de uma atividade enviada anteriormente dada de volta ao bot como a resposta de uma chamada de envio.

OnMessageUpdateActivityAsync(ITurnContext<IMessageUpdateActivity>, CancellationToken)

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

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 são 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 nome de 'application/search'.

OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken)

Invocado quando um evento signin/verifyState 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 esse 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 evento tokens/response é recebido quando o comportamento base de OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) é 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.

OnTurnAsync(ITurnContext, CancellationToken)

Chamado pelo adaptador (por exemplo, um BotFrameworkAdapter) em tempo de execução para processar um Activityde entrada.

OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)

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

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