ActivityHandler Classe

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

Quando o método on_invoke_activity recebe um Invoke com um Activity.name de adaptiveCard/action, ele chama esse método.

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

Parâmetros

Retornos

Invocado quando uma atividade de atualização de conversa é recebida do canal quando o comportamento base de on_turn é usado.

async on_conversation_update_activity(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_turn recebe uma atividade de atualização de conversa, ele chama esse método. Também

• Se a atividade de atualização de conversa indicar que membros diferentes do bot ingressaram na conversa, ele chamará o método on_members_added_activity.
• Se a atividade de atualização de conversa indicar que membros diferentes do bot deixaram a conversa, ele chamará o método on_members_removed_activity.
• Em uma classe derivada, substitua esse método para adicionar lógica que se aplica a todas as atividades de atualização de conversa. Adicione lógica a ser aplicada antes que o membro adicione ou remova a lógica antes da chamada para esse método de classe base.

Invocado quando uma atividade de fim de conversa é recebida do canal.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parâmetros

Retornos

Invocado quando um evento diferente de tokens/ de resposta é recebido quando o comportamento base de on_event_activity é usado.

async on_event(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_event_activity é usado recebe um evento com um nome de atividade diferente de tokens/de resposta, ele chama esse método. Esse método poderá ser substituído opcionalmente se o bot for destinado a lidar com eventos diversos.

Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de on_turn é usado.

async on_event_activity(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_turn recebe uma atividade de evento, ele chama esse método. Se o nome da atividade for tokens/de resposta, ele chamará on_token_response_event; caso contrário, ele chama on_event.

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 para esse 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 a esse 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 nome da atividade do evento, que é significativa dentro do escopo de um canal.

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

async on_installation_update(turn_context: TurnContext)

Parâmetros

Retornos

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

async on_installation_update_add(turn_context: TurnContext)

Parâmetros

Retornos

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

async on_installation_update_remove(turn_context: TurnContext)

Parâmetros

Retornos

Registra um manipulador de eventos de atividade para o invocar evento, emitido para cada atividade de evento de entrada.

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

Parâmetros

Retornos

Substitua esse método em uma classe derivada para fornecer lógica para quando membros diferentes do bot ingressarem na conversa. Você pode adicionar a lógica de boas-vindas do bot.

atividade de atualização de conversa :type members_added: List :p aram turn_context: O objeto de contexto desta vez :type turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_conversation_update_activity recebe uma atividade de atualização de conversa que indica que um ou mais usuários diferentes do bot estão ingressando na conversa, ele chama esse método.

Substitua esse método em uma classe derivada para fornecer lógica para quando membros diferentes do bot deixarem a conversa. Você pode adicionar a lógica de adeus do bot.

atividade de atualização de conversa :type members_added: List :p aram turn_context: O objeto de contexto desta vez :type turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_conversation_update_activity 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.

Substitua esse método em uma classe derivada para fornecer lógica específica às atividades, como a lógica de conversação.

async on_message_activity(turn_context: TurnContext)

Parâmetros

Retornos

Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de on_turn é usado.

async on_message_reaction_activity(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

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 de resposta à ID. 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 on_turn 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á

<xref:botbuilder.core.ActivityHandler.on_reaction_added>.

• Se a reação da mensagem indicar que as reações foram removidas de uma mensagem, ela chamará <xref:botbuilder.core.ActivityHandler.on_reaction_removed>.

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 para esse 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 para esse método de classe base.

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

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parâmetros

Retornos

Comentários

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 resposta da atividade à propriedade ID. 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 na ID de resposta do recurso do resultado.

Substitua esse método em uma classe derivada para fornecer lógica para quando as reações a uma atividade anterior são removidas da conversa.

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parâmetros

Retornos

Comentários

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 resposta da atividade à propriedade Id. 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 na ID de resposta do recurso do resultado.

Invocado quando um evento signin/verifyState ou signin/tokenExchange é recebido quando o comportamento base de on_invoke_activity(TurnContext{InvokeActivity}) é 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.

async on_sign_in_invoke(turn_context: TurnContext)

Parâmetros

Retornos

Invocado quando um evento tokens/resposta é recebido quando o comportamento base de on_event_activity é usado. Se estiver usando um oauth_prompt, substitua esse método para encaminhar essa atividade para a caixa de diálogo atual.

async on_token_response_event(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_event recebe um evento com um nome de atividade de tokens/de resposta, ele chama esse método. Se o bot usar um oauth_prompt, encaminhe a atividade de entrada para a caixa de diálogo atual.

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

async on_turn(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Ele 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. Também

• Adicione lógica para aplicar antes da lógica específica do tipo e antes de chamar on_turn.
• Adicione lógica a ser aplicada após a lógica específica do tipo depois de chamar on_turn.

Substitua isso em uma classe derivada para fornecer lógica específica às atividades ActivityTypes.typing, como a lógica de conversa.

async on_typing_activity(turn_context: TurnContext)

Parâmetros

Retornos

Invocado quando uma atividade diferente de uma mensagem, atualização de conversa ou evento é recebida quando o comportamento base de on_turn é usado. Se substituído, esse método poderá responder potencialmente a qualquer um dos outros tipos de atividade.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parâmetros

Retornos

Comentários

Quando o método on_turn 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.