TurnContext Interfaz

public interface TurnContext

Proporciona contexto para un turno de un bot.

El contexto proporciona información necesaria para procesar una actividad entrante. El objeto de contexto se crea mediante un BotAdapter y se conserva durante la longitud del turno.

Bot Middleware

Resumen del campo

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

Resumen del método

Modificador y tipo Método y descripción
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

Elimina una actividad existente.

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

Elimina una actividad existente.

abstract Activity getActivity()

Obtiene la actividad de este turno del bot.

abstract BotAdapter getAdapter()

Obtiene el adaptador de bot que creó este objeto de contexto.

abstract java.lang.String getLocale()

Obtiene la configuración regional de este objeto de contexto.

abstract boolean getResponded()

Obtiene un valor que indica si se envió al menos una respuesta para el turno actual.

abstract TurnContextStateCollection getTurnState()

Obtiene la colección de valores almacenados en caché con el objeto de contexto durante la vigencia del turno.

abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Agrega un controlador de respuesta para las operaciones de eliminación de actividad.

abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Agrega un controlador de respuesta para las operaciones de actividad de envío.

abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Agrega un controlador de respuesta para las operaciones de actividad de actualización.

default java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(Activity[] activities)

Método auxiliar para enviar una matriz de actividades.

abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

Envía una lista de actividades al remitente de la actividad entrante.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activity)

Envía una actividad al remitente de la actividad entrante.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

Envía una actividad de mensaje al remitente de la actividad entrante.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

Envía una actividad de mensaje al remitente de la actividad entrante.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Envía una actividad de mensaje al remitente de la actividad entrante.

default java.util.concurrent.CompletableFuture<java.lang.Void> sendActivityBlind(Activity activity)

Envía una actividad al remitente de la actividad entrante sin devolver un recursoRespuesta.

abstract void setLocale(String withLocale)

Establezca la configuración regional en este objeto de contexto.

static java.util.concurrent.CompletableFuture<ResourceResponse> traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse> traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

Envía una actividad de seguimiento a la BotAdapter con fines de registro.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Reemplaza una actividad existente.

Detalles del campo

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

Detalles del método

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

Elimina una actividad existente.

Parámetros:

conversationReference - Conversación que contiene 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 indica la actividad de la conversación que se va a eliminar.

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

Elimina una actividad existente.

Parámetros:

activityId - Identificador de la actividad que se va a eliminar.

Devoluciones:

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

getActivity

public abstract Activity getActivity()

Obtiene la actividad de este turno del bot.

Devoluciones:

La actividad de este turno del bot.

getAdapter

public abstract BotAdapter getAdapter()

Obtiene el adaptador de bot que creó este objeto de contexto.

Devoluciones:

Adaptador del bot que creó este objeto de contexto.

getLocale

public abstract String getLocale()

Obtiene la configuración regional de este objeto de contexto.

Devoluciones:

Cadena de configuración regional en este objeto de contexto.

getResponded

public abstract boolean getResponded()

Obtiene un valor que indica si se envió al menos una respuesta para el turno actual.

Devoluciones:

true si se envió al menos una respuesta para el turno actual; de lo contrario, false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

Obtiene la colección de valores almacenados en caché con el objeto de contexto durante la vigencia del turno.

Devoluciones:

Colección de servicios registrados en este objeto de contexto.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Agrega un controlador de respuesta para las operaciones de eliminación de actividad.

Cuando se llama a la deleteActivity(String activityId) del contexto, el adaptador llama a los controladores registrados en el orden en que se agregaron al objeto de contexto.

Parámetros:

handler - Controlador que se va a agregar al objeto de contexto.

Devoluciones:

Objeto de contexto actualizado.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Agrega un controlador de respuesta para las operaciones de actividad de envío.

Cuando se llama a los métodos sendActivity(Activity activity) o sendActivities(List<Activity> activities) del contexto, el adaptador llama a los controladores registrados en el orden en que se agregaron al objeto de contexto.

Parámetros:

handler - Controlador que se va a agregar al objeto de contexto.

Devoluciones:

Objeto de contexto actualizado.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Agrega un controlador de respuesta para las operaciones de actividad de actualización.

Cuando se llama a la updateActivity(Activity withActivity) del contexto, el adaptador llama a los controladores registrados en el orden en que se agregaron al objeto de contexto.

Parámetros:

handler - Controlador que se va a agregar al objeto de contexto.

Devoluciones:

Objeto de contexto actualizado.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Método auxiliar para enviar una matriz de actividades. Esto llama a sendActivities(List<Activity> activities).

Parámetros:

activities - Matriz de actividades.

Devoluciones:

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

sendActivities

public abstract CompletableFuture sendActivities(List activities)

Envía una lista de actividades al remitente de la actividad entrante.

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.

Parámetros:

activities - Las actividades que se van a enviar.

Devoluciones:

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

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

Envía una actividad al remitente de la actividad entrante.

Parámetros:

activity - Actividad que se va a enviar.

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.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

Envía una actividad de mensaje al remitente de la actividad entrante.

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.

Consulte la documentación del canal para ver los límites impuestos sobre el contenido de textReplyToSend.

Parámetros:

textReplyToSend - Texto del mensaje que se va a enviar.

Devoluciones:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

Envía una actividad de mensaje al remitente de la actividad entrante.

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.

Consulte la documentación del canal para ver los límites impuestos sobre el contenido de textReplyToSend.

Para controlar varias características de la voz del bot, como voz, velocidad, volumen, pronunciación y tono, especifique speak en formato de lenguaje de marcado de síntesis de voz (SSML).

Parámetros:

textReplyToSend - Texto del mensaje que se va a enviar.
speak - Opcional, el bot dirá texto en un canal habilitado para voz.

Devoluciones:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Envía una actividad de mensaje al remitente de la actividad entrante.

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.

Consulte la documentación del canal para ver los límites impuestos sobre el contenido de textReplyToSend.

Para controlar varias características de la voz del bot, como voz, velocidad, volumen, pronunciación y tono, especifique speak en formato de lenguaje de marcado de síntesis de voz (SSML).

Parámetros:

textReplyToSend - Texto del mensaje que se va a enviar.
speak - Opcional, el bot dirá texto en un canal habilitado para voz.
inputHint - Opcional, indica si el bot acepta, espera o ignora la entrada del usuario después de que el mensaje se entregue al cliente. Uno de: "acceptingInput", "ignoreingInput" o "expectingInput". El valor predeterminado es "acceptingInput".

Devoluciones:

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

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Envía una actividad al remitente de la actividad entrante sin devolver un resourceResponse.

Parámetros:

activity - Actividad que se va a enviar.

Devoluciones:

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

setLocale

public abstract void setLocale(String withLocale)

Establezca la configuración regional en este objeto de contexto.

Parámetros:

withLocale - Cadena de configuración regional en este objeto de contexto.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Parámetros:

turnContext - TurnContext.
name - Nombre de la actividad.

Devoluciones:

Un futuro con ResourceReponse.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

Envía una actividad de seguimiento a la BotAdapter con fines de registro.

Parámetros:

turnContext - Contexto del turno actual.
name - Valor que se va a asignar a la propiedad Activity#getName de la actividad.
value - Valor que se va a asignar a la propiedad Activity#getValue de la actividad.
valueType - Valor que se va a asignar a la propiedad Activity#getValueType de la actividad.
label - Valor que se va a asignar a la propiedad Activity#getLabel de la actividad.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Si el adaptador se hospeda en el emulador, el resultado de la tarea contiene un objeto ResourceResponse con el identificador de la actividad de seguimiento original; de lo contrario, contiene un objeto ResourceResponse que contiene el identificador asignado al canal receptor asignado a la actividad.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

Reemplaza una actividad existente.

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.

Parámetros:

withActivity - Nueva actividad de reemplazo.

Devoluciones:

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

Se aplica a