ActivityHandler Classe

Invocado quando o bot é enviado uma Adaptive Card Action Execute.

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

Devoluções

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

async on_conversation_update_activity(turn_context: TurnContext)

Parâmetros

Devoluções

Observações

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

• Se a atividade de atualização de conversa indicar que outros membros além do bot ingressaram na conversa, ela chamará o método on_members_added_activity.
• Se a atividade de atualização de conversa indicar que outros membros além do bot deixaram a conversa, ela 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 para aplicar antes que o membro adicione ou remova a lógica antes da chamada para esse método de classe base.

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

async on_end_of_conversation_activity(turn_context: TurnContext)

Parâmetros

Devoluções

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

Devoluções

Observações

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. Opcionalmente, esse método pode ser substituído se o bot se destinar a lidar com eventos diversos.

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

async on_event_activity(turn_context: TurnContext)

Parâmetros

Devoluções

Observações

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, chamaon_event.

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

As atividades do evento comunicam informações programáticas de um cliente ou canal para um bot. O significado de uma atividade de evento é definido pela propriedade de nome da atividade de evento, que é significativa dentro do escopo de um canal.

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

async on_installation_update(turn_context: TurnContext)

Parâmetros

Devoluções

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

async on_installation_update_add(turn_context: TurnContext)

Parâmetros

Devoluções

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

async on_installation_update_remove(turn_context: TurnContext)

Parâmetros

Devoluções

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

Devoluções

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 seu bot.

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

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

Parâmetros

Devoluções

Observações

Quando o método on_conversation_update_activity recebe uma atividade de atualização de conversa que indica que um ou mais usuários além 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 seu bot.

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

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

Parâmetros

Devoluções

Observações

Quando o método on_conversation_update_activity recebe uma atividade de atualização de conversação que indica que um ou mais usuários além 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 para atividades, como a lógica conversacional.

async on_message_activity(turn_context: TurnContext)

Parâmetros

Devoluções

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

async on_message_reaction_activity(turn_context: TurnContext)

Parâmetros

Devoluções

Observações

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 de mensagem corresponde é indicada na propriedade reply to Id. 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. 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.activity_handler.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.activity_handler.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 para aplicar antes das reações adicionadas ou removidas antes da chamada para o método desta classe base. Adicione lógica para aplicar após as reações adicionadas ou removidas após a chamada para o método desta 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

Devoluções

Observações

As reações de mensagem correspondem ao usuário adicionar um "like" ou "triste" etc. (geralmente um emoji) a uma mensagem enviada anteriormente na conversa. As reações de mensagem são apoiadas por apenas alguns canais. A atividade à qual a mensagem está em reação é identificada pela propriedade reply to ID da atividade. O valor dessa propriedade é o ID da 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 forem removidas da conversa.

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

Parâmetros

Devoluções

Observações

As reações de mensagem correspondem ao usuário adicionar um "like" ou "triste" etc. (geralmente um emoji) a uma mensagem enviada anteriormente na conversa. As reações de mensagem são apoiadas por apenas alguns canais. A atividade à qual a mensagem está em reação é identificada pela resposta da atividade à propriedade Id. O valor dessa propriedade é o ID da 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 esta 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

Devoluções

Invocado quando um evento tokens/ de 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

Devoluções

Observações

Quando o método on_event recebe um evento com um nome de atividade de tokens/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, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) em tempo de execução para processar um Activityde entrada.

async on_turn(turn_context: TurnContext)

Parâmetros

Devoluções

Observações

Ele chama outros métodos nessa classe com base no tipo de atividade a ser processada, o que permite que uma classe derivada forneça lógica específica do 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 para aplicar 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 para atividades ActivityTypes.typeing, como a lógica de conversação.

async on_typing_activity(turn_context: TurnContext)

Parâmetros

Devoluções

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 pode potencialmente responder a qualquer um dos outros tipos de atividade.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parâmetros

Devoluções

Observações

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.