ActivityHandler Classe

Manipula atividades e deve ser subclasse.

Herança

Bot

ActivityHandler

Construtor

ActivityHandler()

Comentários

Derivar dessa classe para lidar com tipos de atividade específicos. Yon pode adicionar pré e pós-processamento de atividades chamando a classe base na classe derivada.

Métodos

on_adaptive_card_invoke	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.
on_conversation_update_activity	Invocado quando uma atividade de atualização de conversa é recebida do canal quando o comportamento base de on_turn é usado.
on_end_of_conversation_activity	Invocado quando uma atividade de fim de conversa é recebida do canal.
on_event	Invocado quando um evento diferente de tokens/resposta é recebido quando o comportamento base de on_event_activity é usado.
on_event_activity	Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de on_turn é usado.
on_installation_update	Substitua isso em uma classe derivada para fornecer lógica específica às atividades ActivityTypes.InstallationUpdate.
on_installation_update_add	Substitua isso em uma classe derivada para fornecer lógica específica às atividades ActivityTypes.InstallationUpdate com 'action' definido como 'add'.
on_installation_update_remove	Substitua isso em uma classe derivada para fornecer lógica específica às atividades ActivityTypes.InstallationUpdate com 'action' definido como 'remove'.
on_invoke_activity	Registra um manipulador de eventos de atividade para o evento invoke , emitido para cada atividade de evento de entrada.
on_members_added_activity	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 para este turno :type turn_context: TurnContext
on_members_removed_activity	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 para este turno :type turn_context: TurnContext
on_message_activity	Substitua esse método em uma classe derivada para fornecer lógica específica às atividades, como a lógica de conversa.
on_message_reaction_activity	Invocado quando uma atividade de evento é recebida do conector quando o comportamento base de on_turn é usado.
on_reactions_added	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.
on_reactions_removed	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.
on_sign_in_invoke	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.
on_token_response_event	Invocado quando um evento de 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.
on_turn	Chamado pelo adaptador (por exemplo, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) em runtime para processar um de entrada Activity.
on_typing_activity	Substitua isso em uma classe derivada para fornecer lógica específica para atividades ActivityTypes.typing, como a lógica de conversa.
on_unrecognized_activity_type	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 responder potencialmente a qualquer um dos outros tipos de atividade.

on_adaptive_card_invoke

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

Nome	Description
turn_context Obrigatório	TurnContext Um objeto de contexto para essa vez.
invoke_value Obrigatório	<xref:botframework.schema.models.AdaptiveCardInvokeValue> Um objeto tipo cadeia de caracteres do valor da atividade de entrada.

Retornos

Tipo	Description
	O objeto HealthCheckResponse

on_conversation_update_activity

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

Quando o on_turn método 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 on_members_added_activity método .
• Se a atividade de atualização de conversa indicar que membros diferentes do bot deixaram a conversa, ele chamará o on_members_removed_activity método .
• 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.

on_end_of_conversation_activity

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

async on_end_of_conversation_activity(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_event

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

async on_event(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

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

on_event_activity

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

Quando o on_turn método recebe uma atividade de evento, ele chama esse método. Se o nome da atividade for tokens/resposta, ele chamará on_token_response_event; caso contrário, chamará on_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 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.

on_installation_update

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

async on_installation_update(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_installation_update_add

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_installation_update_remove

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_invoke_activity

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

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

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_members_added_activity

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 para este turno :type turn_context: TurnContext

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

Parâmetros

Nome	Description
members_added Obrigatório
turn_context Obrigatório

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

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

on_members_removed_activity

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 para este turno :type turn_context: TurnContext

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

Parâmetros

Nome	Description
members_removed Obrigatório
turn_context Obrigatório

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

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

on_message_activity

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

async on_message_activity(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_message_reaction_activity

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

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 em alguns canais. A atividade à qual a reação da mensagem corresponde é indicada na propriedade responder à 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 on_turn método 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 a ser aplicada antes que as reações sejam 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.

on_reactions_added

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

Nome	Description
message_reactions Obrigatório	List A lista de reações adicionada
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

As reações de mensagem correspondem ao usuário adicionar um 'like' ou 'sad' etc. (geralmente 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 propriedade de resposta da atividade à 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.

on_reactions_removed

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

Nome	Description
message_reactions Obrigatório	List A lista de reações removidas
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

As reações de mensagem correspondem ao usuário adicionar um 'like' ou 'sad' etc. (geralmente 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 propriedade de resposta da atividade à 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.

on_sign_in_invoke

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_token_response_event

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

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para esta vez

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

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

on_turn

Chamado pelo adaptador (por exemplo, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) em runtime para processar um de entrada Activity.

async on_turn(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para este turno

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

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 maneira controlada. Em uma classe derivada, substitua esse método para adicionar a 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 a lógica a ser aplicada após a lógica específica do tipo depois de chamar on_turn.

on_typing_activity

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

async on_typing_activity(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para este turno

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

on_unrecognized_activity_type

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

async on_unrecognized_activity_type(turn_context: TurnContext)

Parâmetros

Nome	Description
turn_context Obrigatório	TurnContext O objeto de contexto para este turno

Retornos

Tipo	Description
	Uma tarefa que representa o trabalho enfileirado para execução

Comentários

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