BotAdapter Clase

  • Referencia
Paquete:
com.microsoft.bot.builder
Artefacto Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.BotAdapter

public abstract class BotAdapter

Representa un adaptador de bot que puede conectar un bot a un punto de conexión de servicio. Esta clase es abstracta.

El adaptador de bot encapsula los procesos de autenticación y envía actividades a y recibe actividades de Bot Connector Service. Cuando el bot recibe una actividad, el adaptador crea un objeto de contexto, lo pasa a la lógica de la aplicación del bot y envía respuestas de vuelta al canal del usuario.

Use use(Middleware middleware) para agregar objetos Middleware al adaptador\u2019colección de middleware. El adaptador procesa y dirige las actividades entrantes en a través de la canalización de middleware del bot a la lógica del bot\u2019s y, a continuación, vuelve a salir. A medida que cada actividad fluye dentro y fuera del bot, cada fragmento de middleware puede inspeccionar o actuar sobre la actividad, tanto antes como después de que se ejecute la lógica del bot.

TurnContext Activity Bot Middleware

Resumen del campo

Modificador y tipo Campo y descripción
static final java.lang.String BOT_IDENTITY_KEY

Clave para almacenar la identidad de notificaciones del bot.
static final java.lang.String OAUTH_CLIENT_KEY

Clave para almacenar el cliente oauth del bot.
static final java.lang.String OAUTH_SCOPE_KEY

Clave para almacenar el ámbito de oauth del bot.

Resumen del constructor

Constructor Description
BotAdapter()

Resumen del método

Modificador y tipo Método y descripción
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

Cuando se invalida en una clase derivada, elimina una actividad existente en la conversación.
protected MiddlewareSet getMiddlewareSet()

Obtiene la colección de middleware en la canalización del adaptador.
OnTurnErrorHandler getOnTurnError()

Obtiene el controlador de errores que puede detectar excepciones en el middleware o la aplicación.
protected java.util.concurrent.CompletableFuture<java.lang.Void> runPipeline(TurnContext context, BotCallbackHandler callback)

Inicia el procesamiento de actividad para el turno de bot actual.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

Cuando se reemplaza en una clase derivada, envía actividades a la conversación.
void setOnTurnError(OnTurnErrorHandler withTurnError)

Establece el controlador de errores que puede detectar excepciones en el middleware o la aplicación.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

Cuando se invalida en una clase derivada, reemplaza una actividad existente en la conversación.
BotAdapter use(Middleware middleware)

Agrega middleware a la canalización del adaptador.

Métodos heredados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalles del campo

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Clave para almacenar la identidad de notificaciones del bot.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

Clave para almacenar el cliente oauth del bot.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

Clave para almacenar el ámbito de oauth del bot.

Detalles del constructor

BotAdapter

public BotAdapter()

Detalles del método

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Parámetros:

claimsIdentity - ClaimsIdentity para la conversación.
continuationActivity - Actividad con conversationReference adecuada con la que continuar la conversación.
callback - Método que se va a llamar al turno del bot de resultados.

Devoluciones:

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Parámetros:

claimsIdentity - ClaimsIdentity para la conversación.
continuationActivity - Actividad con conversationReference adecuada con la que continuar la conversación.
audience - Valor que indica al destinatario del mensaje proactivo.
callback - Método que se va a llamar al turno del bot de resultados.

Devoluciones:

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Parámetros:

claimsIdentity - Referencia claimsIdentity para la conversación.
reference - Referencia a la conversación que se va a continuar.
callback - Método que se va a llamar al turno del bot de resultados.

Devoluciones:

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Parámetros:

claimsIdentity - Referencia claimsIdentity para la conversación.
reference - Referencia a la conversación que se va a continuar.
audience - Valor que indica al destinatario del mensaje proactivo.
callback - Método que se va a llamar al turno del bot de resultados.

Devoluciones:

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

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Parámetros:

botId - Identificador de aplicación del bot. Este parámetro se omite en un solo inquilino los adaptadores (consola, prueba, etcetera), pero es fundamental para BotFrameworkAdapter, que es compatible con varios inquilinos.
continuationActivity - Actividad con conversationReference adecuada con la que continuar la conversación.
callback - Método que se va a llamar al turno del bot de resultados.

Devoluciones:

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

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Envía un mensaje proactivo a una conversación.

Parámetros:

botAppId - Identificador de aplicación del bot. Este parámetro se omite en un solo inquilino los adaptadores (consola, prueba, etcetera), pero es fundamental para BotFrameworkAdapter, que es compatible con varios inquilinos.
reference - Referencia a la conversación que se va a continuar.
callback - Método que se va a llamar al turno del bot resultante.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario. 
     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Cuando se invalida en una clase derivada, elimina una actividad existente en la conversación.

Parámetros:

context - Objeto de contexto del turno.
reference - Referencia de conversación para la actividad que se va a eliminar.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. El ConversationReference#getActivityId de la referencia de conversación identifica la actividad que se va a eliminar. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

Obtiene la colección de middleware en la canalización del adaptador.

Devoluciones:

Colección de middleware para la canalización.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

Obtiene el controlador de errores que puede detectar excepciones en el middleware o la aplicación.

Devoluciones:

Un controlador de errores que puede detectar excepciones en el middleware o la aplicación.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Inicia el procesamiento de actividad para el turno de bot actual. El adaptador llama al middleware en el orden en que lo agregó. El adaptador pasa el objeto de contexto para el turno y un delegado siguiente, y el middleware llama al delegado para pasar el control al siguiente middleware de la canalización. Una vez que el control llega al final de la canalización, el adaptador llama al método callback. Si un componente de middleware no llama al siguiente delegado, el adaptador no llama a ninguno de los siguientes métodos de\u2019onTurn(TurnContext turnContext, NextDelegate next) de middleware ni al método de devolución de llamada y a los cortocircuitos de canalización.

Cuando un usuario inicia el turno (mensajería reactiva), el método de devolución de llamada será una referencia al método onTurn(TurnContext turnContext) del bot. Cuando se inicia el turno mediante una llamada a continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (mensajería proactiva), el método de devolución de llamada es el método de devolución de llamada que se proporcionó en la llamada.

Parámetros:

context - Objeto de contexto del turno.
callback - Método de devolución de llamada para ejecutarse al final de la canalización.

Devoluciones:

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

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

Cuando se reemplaza en una clase derivada, envía actividades a la conversación.

Parámetros:

context - Objeto de contexto del turno.
activities - Las actividades que se van a enviar.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Si las actividades se envían correctamente, el resultado de la tarea contiene una matriz de ResourceResponse objetos que contienen los identificadores asignados al canal receptor asignado a las actividades. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

Establece el controlador de errores que puede detectar excepciones en el middleware o la aplicación.

Parámetros:

withTurnError - Un controlador de errores que puede detectar excepciones en el middleware o la aplicación.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

Cuando se invalida en una clase derivada, reemplaza una actividad existente en la conversación.

Parámetros:

context - Objeto de contexto del turno.
activity - Nueva actividad de reemplazo.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Si la actividad se envía correctamente, el resultado de la tarea contiene un objeto ResourceResponse que contiene el identificador asignado al canal receptor asignado a la actividad.

Antes de llamar a esto, establezca el identificador de la actividad de reemplazo en el identificador de la actividad que se va a reemplazar. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

Agrega middleware a la canalización del adaptador.

Parámetros:

middleware - Middleware que se va a agregar.

Devoluciones:

Objeto de adaptador actualizado. El middleware se agrega al adaptador en el momento de la inicialización. Para cada turno, el adaptador llama al middleware en el orden en que lo agregó.

Se aplica a