ActivityHandler Clase

Controla las actividades y debe estar subclasada.

Herencia

Bot

ActivityHandler

Constructor

ActivityHandler()

Comentarios

Derive de esta clase para controlar determinados tipos de actividad. Yon puede agregar el procesamiento previo y posterior de las actividades llamando a la clase base en la clase derivada.

Métodos

on_adaptive_card_invoke	Se invoca cuando el bot se envía una acción de tarjeta adaptable Ejecutada. Cuando el método on_invoke_activity recibe una instrucción Invoke con un Activity.name de adaptiveCard/action, llama a este método.
on_conversation_update_activity	Se invoca cuando se recibe una actividad de actualización de conversación desde el canal cuando se usa el comportamiento base de on_turn .
on_end_of_conversation_activity	Se invoca cuando se recibe una actividad final de conversación desde el canal.
on_event	Se invoca cuando se recibe un evento distinto de tokens o respuestas cuando se usa el comportamiento base de on_event_activity .
on_event_activity	Se invoca cuando se recibe una actividad de eventos desde el conector cuando se usa el comportamiento base de on_turn .
on_installation_update	Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.InstallationUpdate.
on_installation_update_add	Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.InstallationUpdate con "action" establecida en "add".
on_installation_update_remove	Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.InstallationUpdate con "action" establecido en "remove".
on_invoke_activity	Registra un controlador de eventos de actividad para el evento de invocación , emitido para cada actividad de evento entrante.
on_members_added_activity	Invalide este método en una clase derivada para proporcionar lógica para cuando los miembros distintos del bot se unan a la conversación. Puede agregar la lógica de bienvenida del bot. actividad de actualización de conversación :type members_added: List :p aram turn_context: el objeto de contexto para este turno :type turn_context: TurnContext
on_members_removed_activity	Invalide este método en una clase derivada para proporcionar lógica para cuando los miembros que no sean el bot abandonan la conversación. Puede agregar la lógica de buen bye del bot. actividad de actualización de conversación :type members_added: List :p aram turn_context: el objeto de contexto para este turno :type turn_context: TurnContext
on_message_activity	Invalide este método en una clase derivada para proporcionar lógica específica de las actividades, como la lógica conversacional.
on_message_reaction_activity	Se invoca cuando se recibe una actividad de eventos desde el conector cuando se usa el comportamiento base de on_turn .
on_reactions_added	Invalide este método en una clase derivada para proporcionar lógica para cuando se agregan reacciones a una actividad anterior a la conversación.
on_reactions_removed	Invalide este método en una clase derivada para proporcionar lógica para cuando se quitan las reacciones a una actividad anterior de la conversación.
on_sign_in_invoke	Se invoca cuando se recibe un evento signin/verifyState o signin/tokenExchange cuando se usa el comportamiento base de on_invoke_activity(TurnContext{InvokeActivity}). Si usa OAuthPrompt, invalide este método para reenviar esta actividad"/ al cuadro de diálogo actual. De forma predeterminada, este método no hace nada.
on_token_response_event	Se invoca cuando se recibe un evento de tokens o respuesta cuando se usa el comportamiento base de on_event_activity . Si usa un oauth_prompt, invalide este método para reenviar esta actividad al cuadro de diálogo actual.
on_turn	Llamado por el adaptador (por ejemplo, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) en tiempo de ejecución para procesar un entrante Activity.
on_typing_activity	Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.typing, como la lógica conversacional.
on_unrecognized_activity_type	Se invoca cuando se recibe una actividad distinta de un mensaje, una actualización de conversación o un evento cuando se usa el comportamiento base de on_turn . Si se invalida, este método podría responder potencialmente a cualquiera de los otros tipos de actividad.

on_adaptive_card_invoke

Se invoca cuando el bot se envía una acción de tarjeta adaptable Ejecutada.

Cuando el método on_invoke_activity recibe una instrucción Invoke con un Activity.name de adaptiveCard/action, llama a este método.

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

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno.
invoke_value Requerido	<xref:botframework.schema.models.AdaptiveCardInvokeValue> Objeto con tipo de cadena del valor de la actividad entrante.

Devoluciones

Tipo	Description
	El objeto HealthCheckResponse

on_conversation_update_activity

Se invoca cuando se recibe una actividad de actualización de conversación desde el canal cuando se usa el comportamiento base de on_turn .

async on_conversation_update_activity(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Cuando el on_turn método recibe una actividad de actualización de conversación, llama a este método. Además

• Si la actividad de actualización de conversación indica que los miembros distintos del bot se unieron a la conversación, llama al on_members_added_activity método .
• Si la actividad de actualización de conversación indica que los miembros que no son del bot dejan la conversación, llama al on_members_removed_activity método .
• En una clase derivada, invalide este método para agregar lógica que se aplica a todas las actividades de actualización de conversación. Agregue lógica para aplicar antes de que el miembro agregue o quite la lógica antes de la llamada a este método de clase base.

on_end_of_conversation_activity

Se invoca cuando se recibe una actividad final de conversación desde el canal.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_event

Se invoca cuando se recibe un evento distinto de tokens o respuestas cuando se usa el comportamiento base de on_event_activity .

async on_event(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

on_event_activity Cuando el método se usa recibe un evento con un nombre de actividad distinto de tokens o respuestas, llama a este método. Opcionalmente, este método se podría invalidar si el bot está pensado para controlar eventos varios.

on_event_activity

Se invoca cuando se recibe una actividad de eventos desde el conector cuando se usa el comportamiento base de on_turn .

async on_event_activity(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Cuando el on_turn método recibe una actividad de evento, llama a este método. Si el nombre de la actividad es tokens/respuesta, llama a on_token_response_event; de lo contrario, llama a on_event.

En una clase derivada, invalide este método para agregar lógica que se aplica a todas las actividades de eventos. Agregue lógica para aplicar antes de la lógica de control de eventos específica antes de la llamada a este método de clase base. Agregue lógica para que se aplique después de la lógica de control de eventos específica después de la llamada a este método de clase base.

Las actividades de evento transmiten información de programación de un cliente o un canal a un bot. El significado de una actividad de evento se define mediante la propiedad nombre de la actividad de evento, que es significativa dentro del ámbito de un canal.

on_installation_update

Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.InstallationUpdate.

async on_installation_update(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_installation_update_add

Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.InstallationUpdate con "action" establecida en "add".

async on_installation_update_add(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_installation_update_remove

Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.InstallationUpdate con "action" establecido en "remove".

async on_installation_update_remove(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_invoke_activity

Registra un controlador de eventos de actividad para el evento de invocación , emitido para cada actividad de evento entrante.

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

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_members_added_activity

Invalide este método en una clase derivada para proporcionar lógica para cuando los miembros distintos del bot se unan a la conversación. Puede agregar la lógica de bienvenida del bot.

actividad de actualización de conversación :type members_added: List :p aram turn_context: el objeto de contexto para este turno :type turn_context: TurnContext

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

Parámetros

Nombre	Description
members_added Requerido
turn_context Requerido

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Cuando el on_conversation_update_activity método recibe una actividad de actualización de conversación que indica uno o varios usuarios distintos de los que se unen a la conversación, llama a este método.

on_members_removed_activity

Invalide este método en una clase derivada para proporcionar lógica para cuando los miembros que no sean el bot abandonan la conversación. Puede agregar la lógica de buen bye del bot.

actividad de actualización de conversación :type members_added: List :p aram turn_context: el objeto de contexto para este turno :type turn_context: TurnContext

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

Parámetros

Nombre	Description
members_removed Requerido
turn_context Requerido

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Cuando el on_conversation_update_activity método recibe una actividad de actualización de conversación que indica uno o varios usuarios que no están dejando la conversación, llama a este método.

on_message_activity

Invalide este método en una clase derivada para proporcionar lógica específica de las actividades, como la lógica conversacional.

async on_message_activity(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_message_reaction_activity

Se invoca cuando se recibe una actividad de eventos desde el conector cuando se usa el comportamiento base de on_turn .

async on_message_reaction_activity(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Las reacciones de mensaje corresponden al usuario que agrega un "like" o "sad", etc. (a menudo un emoji) a una actividad enviada previamente.

Las reacciones de mensajes solo son compatibles con algunos canales. La actividad a la que corresponde la reacción del mensaje se indica en la propiedad Id de respuesta. El valor de esta propiedad es el identificador de actividad de una actividad enviada previamente que se devolvía al bot como respuesta de una llamada de envío. Cuando el on_turn método recibe una actividad de reacción de mensaje, llama a este método.

• Si la reacción del mensaje indica que las reacciones se agregaron a un mensaje, llama a .

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

• Si la reacción del mensaje indica que las reacciones se quitaron de un mensaje, llama a <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

En una clase derivada, invalide este método para agregar lógica que se aplica a todas las actividades de reacción de mensajes. Agregue lógica para aplicar antes de que se agreguen o quiten las reacciones antes de la llamada al método de clase base. Agregue lógica para aplicar después de agregar o quitar la lógica después de la llamada a este método de clase base.

on_reactions_added

Invalide este método en una clase derivada para proporcionar lógica para cuando se agregan reacciones a una actividad anterior a la conversación.

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

Parámetros

Nombre	Description
message_reactions Requerido	List Lista de reacciones agregadas
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Las reacciones de mensaje corresponden al usuario que agrega un "like" o "sad", etc. (a menudo un emoji) a un mensaje enviado previamente en la conversación. Las reacciones de mensajes solo son compatibles con algunos canales. La actividad a la que el mensaje está en reacción se identifica mediante la respuesta de la actividad a la propiedad ID. El valor de esta propiedad es el identificador de actividad de una actividad enviada previamente. Cuando el bot envía una actividad, el canal le asigna un identificador, que está disponible en el identificador de respuesta del recurso del resultado.

on_reactions_removed

Invalide este método en una clase derivada para proporcionar lógica para cuando se quitan las reacciones a una actividad anterior de la conversación.

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

Parámetros

Nombre	Description
message_reactions Requerido	List Lista de reacciones eliminadas
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Las reacciones de mensaje corresponden al usuario que agrega un "like" o "sad", etc. (a menudo un emoji) a un mensaje enviado previamente en la conversación. Las reacciones de mensajes solo son compatibles con algunos canales. La actividad a la que está en reacción el mensaje se identifica mediante la respuesta de la actividad a la propiedad Id. El valor de esta propiedad es el identificador de actividad de una actividad enviada previamente. Cuando el bot envía una actividad, el canal le asigna un identificador, que está disponible en el identificador de respuesta del recurso del resultado.

on_sign_in_invoke

Se invoca cuando se recibe un evento signin/verifyState o signin/tokenExchange cuando se usa el comportamiento base de on_invoke_activity(TurnContext{InvokeActivity}). Si usa OAuthPrompt, invalide este método para reenviar esta actividad"/ al cuadro de diálogo actual. De forma predeterminada, este método no hace nada.

async on_sign_in_invoke(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

on_token_response_event

Se invoca cuando se recibe un evento de tokens o respuesta cuando se usa el comportamiento base de on_event_activity . Si usa un oauth_prompt, invalide este método para reenviar esta actividad al cuadro de diálogo actual.

async on_token_response_event(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar

Comentarios

Cuando el on_event método recibe un evento con un nombre de actividad de tokens/respuesta, llama a este método. Si el bot usa un oauth_prompt, reenvíe la actividad entrante al cuadro de diálogo actual.

on_turn

Llamado por el adaptador (por ejemplo, <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) en tiempo de ejecución para procesar un entrante Activity.

async on_turn(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar.

Comentarios

Llama a otros métodos de esta clase en función del tipo de la actividad que se va a procesar, lo que permite que una clase derivada proporcione lógica específica del tipo de forma controlada. En una clase derivada, invalide este método para agregar lógica que se aplica a todos los tipos de actividad. Además

• Agregue lógica para aplicarla antes de la lógica específica del tipo y antes de llamar a on_turn.
• Agregue lógica para aplicar después de la lógica específica del tipo después de llamar a on_turn.

on_typing_activity

Invalide esto en una clase derivada para proporcionar lógica específica de las actividades ActivityTypes.typing, como la lógica conversacional.

async on_typing_activity(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar.

on_unrecognized_activity_type

Se invoca cuando se recibe una actividad distinta de un mensaje, una actualización de conversación o un evento cuando se usa el comportamiento base de on_turn . Si se invalida, este método podría responder potencialmente a cualquiera de los otros tipos de actividad.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parámetros

Nombre	Description
turn_context Requerido	TurnContext Objeto de contexto para este turno

Devoluciones

Tipo	Description
	Tarea que representa el trabajo en cola que se va a ejecutar.

Comentarios

Cuando el on_turn método recibe una actividad que no es un mensaje, una actualización de conversación, una reacción de mensaje o una actividad de evento, llama a este método.