Idioma

ActivityHandler Classe

Definição

Uma implementação da IBot interface, destinada a subclasses adicionais.

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 pós-processamento dos Activity objetos pode ser adicionado chamando a implementação da classe base a partir da classe derivada.

Construtores

Name Descrição
ActivityHandler()

Uma implementação da IBot interface, destinada a subclasses adicionais.

Métodos

Name Descrição
CreateInvokeResponse(Object)

Uma InvokeResponse fábrica que inicializa o corpo ao parâmetro passado e estado 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) é utilizado. 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) é utilizado. 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 defeito, este método avisa OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) se algum utilizador foi adicionado ou OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) se algum utilizador foi 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 isto numa classe derivada para fornecer lógica específica para EndOfConversation atividades, como a lógica conversacional.

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 defeito, este método chama OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) se o nome da atividade é tokens/response ou OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) não. Um tokens/response evento pode ser desencadeado 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 isto numa classe derivada para fornecer lógica específica para InstallationUpdate atividades.

OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

Substitua isto numa classe derivada para fornecer lógica específica para InstallationUpdate atividades com 'ação' definida como 'adicionar'.

OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

Substitua isto numa classe derivada para fornecer lógica específica para InstallationUpdate atividades com 'ação' definida como 'remove'.

OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken)

Invocado quando uma atividade de invocação é recebida do conector quando o comportamento base de OnTurnAsync(ITurnContext, CancellationToken) é utilizado. As atividades de invocação podem ser usadas para comunicar muitas coisas diferentes. Por defeito, este método chamará OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) se o nome da atividade for signin/verifyState ou signin/tokenExchange. A signin/verifyState ou signin/tokenExchange invocar pode ser desencadeado 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 isto numa classe derivada para fornecer lógica específica para Message atividades, como a lógica conversacional.

OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken)

Substitua isto numa classe derivada para fornecer lógica específica para MessageDelete atividades, como a lógica conversacional.

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 isto numa classe derivada para fornecer lógica específica para MessageUpdate atividades, como a lógica conversacional.

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 signin/verifyState evento ou signin/tokenExchange é recebido quando o comportamento base de OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) é utilizado. Se usar um OAuthPrompt, sobreescreva este método para encaminhar Activity para o 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) é utilizado. Se usar um OAuthPrompt, sobreescreva este método para encaminhar Activity para o 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 inbound Activity.

OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)

Substitua isto numa classe derivada para fornecer lógica específica para Typing atividades, como a lógica conversacional.

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 for sobreposto, isto 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