ActivityHandler Clase

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

Crea un objeto InvokeResponse correcto con el cuerpo especificado.

Parámetros:

Devoluciones:

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

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

Parámetros:

Devoluciones:

protected CompletableFuture onCommandActivity(TurnContext turnContext)

Se invoca cuando se recibe una actividad de comando cuando se usa el comportamiento base de onTurn(TurnContext turnContext). Los comandos son solicitudes para realizar una acción y los receptores suelen responder con una o varias actividades commandResult. También se espera que los receptores rechacen explícitamente las actividades de comandos no admitidas.

Parámetros:

Devoluciones:

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

Se invoca cuando se recibe una actividad CommandResult cuando se usa el comportamiento base de onTurn(TurnContext turnContext). Las actividades CommandResult se pueden usar para comunicar el resultado de una ejecución de comandos.

Parámetros:

Devoluciones:

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

Se invoca cuando se recibe una actividad de actualización de conversación desde el canal cuando se usa el comportamiento base de onTurn(TurnContext turnContext).

Las actividades de actualización de conversación son útiles cuando se trata de responder a los usuarios que se agregan o quitan de la conversación.

Por ejemplo, un bot podría responder a un usuario que se va a agregar saludando al usuario. De forma predeterminada, este método llamará a onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) si se han agregado usuarios o onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) si se han quitado usuarios. El método comprueba el identificador de miembro para que solo responda a las actualizaciones con respecto a los miembros que no sean el propio bot.

Parámetros:

Devoluciones:

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

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

Parámetros:

Devoluciones:

protected CompletableFuture onEvent(TurnContext turnContext)

Se invoca cuando se recibe un evento distinto de tokens o respuesta cuando se usa el comportamiento base de onEventActivity(TurnContext turnContext).

Este método podría invalidarse opcionalmente si el bot está diseñado para controlar eventos varios.

De forma predeterminada, este método no hace nada.

Cuando el método onEventActivity(TurnContext turnContext) recibe un evento con un Activity#getName() distinto de "tokens/respuesta", llama a este método.

Parámetros:

Devoluciones:

protected CompletableFuture onEventActivity(TurnContext turnContext)

Se invoca cuando se recibe una actividad de evento del conector cuando se usa el comportamiento base de onTurn(TurnContext turnContext).

Las actividades de eventos se pueden usar para comunicar muchas cosas diferentes.

De forma predeterminada, este método llamará a onTokenResponseEvent(TurnContext turnContext) si el nombre de la actividad es "tokens/respuesta" o onEvent(TurnContext turnContext) de lo contrario. Un evento "tokens/respuesta" se puede desencadenar mediante un com.microsoft.bot.schema.OAuthCard.

Cuando el método onTurn(TurnContext turnContext) recibe una actividad de evento, llama a este método.

Si el evento Activity#getName es "tokens/respuesta", llama a onTokenResponseEvent(TurnContext turnContext) de lo contrario, llama a onEvent(TurnContext turnContext).

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 que se aplique antes de la lógica de control de eventos específica antes de la llamada al 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 al método de clase base.

Las actividades de eventos comunican información mediante programación de un cliente o canal a un bot. El significado de una actividad de evento se define mediante la propiedad Activity#getName, que es significativa dentro del ámbito de un canal. Un evento "tokens/respuesta" se puede desencadenar mediante un com.microsoft.bot.schema.OAuthCard o un mensaje de OAuth.

Parámetros:

Devoluciones:

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

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

Parámetros:

Devoluciones:

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

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

Parámetros:

Devoluciones:

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

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

Parámetros:

Devoluciones:

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

Se invoca cuando se recibe una actividad de invocación del conector cuando se usa el comportamiento base de onTurn.

Las actividades de invocación se pueden usar para comunicar muchas cosas diferentes. De forma predeterminada, este método llamará a onSignInInvokeAsync si el nombre de la actividad es "signin/verifyState" o "signin/tokenExchange".

Un OAuthCard puede desencadenar una invocación de "signin/verifyState" o "signin/tokenExchange".

Parámetros:

Devoluciones:

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

Invalide esto en una clase derivada para proporcionar lógica para cuando los miembros distintos del bot se unan a la conversación, como la lógica de bienvenida del bot.

Cuando el método onConversationUpdateActivity(TurnContext turnContext) recibe una actividad de actualización de conversación que indica uno o varios usuarios distintos de bo que se unen a la conversación, llama a este método.

Parámetros:

Devoluciones:

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

Invalide esto en una clase derivada para proporcionar lógica cuando los miembros que no sean el bot abandonan la conversación, como la lógica del buen bye del bot.

Cuando el método onConversationUpdateActivity(TurnContext turnContext) recibe una actividad de actualización de conversación que indica que uno o varios usuarios distintos del bot abandonan la conversación, llama a este método.

Parámetros:

Devoluciones:

protected CompletableFuture onMessageActivity(TurnContext turnContext)

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

Cuando el método onTurn(TurnContext turnContext) recibe una actividad de mensaje, llama a este método.

Parámetros:

Devoluciones:

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

Se invoca cuando se recibe una actividad de evento del conector cuando se usa el comportamiento base de onTurn(TurnContext turnContext).

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 replyToId. 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 método onTurn(TurnContext turnContext) 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 onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext). Si la reacción del mensaje indica que las reacciones se quitaron de un mensaje, llama a onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext).

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 que se aplique 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 las reacciones agregadas o eliminadas lógica después de la llamada a la clase base.

Parámetros:

Devoluciones:

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

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

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 son compatibles con solo unos pocos canales. La actividad a la que el mensaje está en reacción se identifica mediante la propiedad Activity#getReplyToId() de la actividad. 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 com.microsoft.bot.schema.ResourceResponse#getId del resultado.

Parámetros:

Devoluciones:

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

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

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 son compatibles con solo unos pocos canales. La actividad a la que el mensaje está en reacción se identifica mediante la propiedad Activity#getReplyToId() de la actividad. 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 com.microsoft.bot.schema.ResourceResponse#getId del resultado.

Parámetros:

Devoluciones:

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

Se invoca cuando se recibe un evento "signin/verifyState" o "signin/tokenExchange" cuando se usa el comportamiento base de onInvokeActivity.

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.

Cuando el método onInvokeActivity recibe una invoke con un nombre de "tokens/response", llama a este método.

Si el bot usa OAuthPrompt, reenvíe la actividad entrante al cuadro de diálogo actual.

Parámetros:

Devoluciones:

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

Se invoca cuando se recibe un evento "tokens/respuesta" cuando se usa el comportamiento base de onEventActivity(TurnContext turnContext).

Si usa OAuthPrompt, invalide este método para reenviar este Activity al cuadro de diálogo actual.

De forma predeterminada, este método no hace nada.

Cuando el método onEventActivity(TurnContext turnContext) recibe un evento con un Activity#getName() de "tokens/respuesta", llama a este método.

Parámetros:

Devoluciones:

public CompletableFuture onTurn(TurnContext turnContext)

Lo llama el adaptador (por ejemplo, un BotFrameworkAdapter) en tiempo de ejecución para procesar un Activityentrante.

Este método 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. Agregue lógica para que se aplique antes de la lógica específica del tipo antes de la llamada a la clase base onTurn(TurnContext turnContext) método. Agregue lógica para aplicar después de la lógica específica del tipo después de la llamada a la clase base onTurn(TurnContext turnContext) método.

Parámetros:

Devoluciones:

protected CompletableFuture onTypingActivity(TurnContext turnContext)

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

Parámetros:

Devoluciones:

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

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 onTurn(TurnContext turnContext).

Si se reemplaza, esto podría responder a cualquiera de los otros tipos de actividad, como com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE o com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION.

De forma predeterminada, este método no hace nada.

Cuando el método onTurn(TurnContext turnContext) recibe una actividad que no es un mensaje, actualización de conversación, reacción de mensajes o actividad de eventos, llama a este método.

Parámetros:

Devoluciones: