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.
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
Bot |
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
Turn |
getTurnState()
Obtiene la colección de valores almacenados en caché con el objeto de contexto durante la vigencia del turno. |
|
abstract
Turn |
onDeleteActivity(DeleteActivityHandler handler)
Agrega un controlador de respuesta para las operaciones de eliminación de actividad. |
|
abstract
Turn |
onSendActivities(SendActivitiesHandler handler)
Agrega un controlador de respuesta para las operaciones de actividad de envío. |
|
abstract
Turn |
onUpdateActivity(UpdateActivityHandler handler)
Agrega un controlador de respuesta para las operaciones de actividad de actualización. |
|
default
java.util.concurrent.CompletableFuture<Resource |
sendActivities(Activity[] activities)
Método auxiliar para enviar una matriz de actividades. |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivities(List<Activity> activities)
Envía una lista de actividades al remitente de la actividad entrante. |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(Activity activity)
Envía una actividad al remitente de la actividad entrante. |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend)
Envía una actividad de mensaje al remitente de la actividad entrante. |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
sendActivity(String textReplyToSend, String speak)
Envía una actividad de mensaje al remitente de la actividad entrante. |
|
abstract
java.util.concurrent.CompletableFuture<Resource |
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 recurso |
| abstract void |
setLocale(String withLocale)
Establezca la configuración regional en este objeto de contexto. |
|
static
java.util.concurrent.CompletableFuture<Resource |
traceActivity(TurnContext turnContext, String name) |
|
static
java.util.concurrent.CompletableFuture<Resource |
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<Resource |
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
Elimina una actividad existente.
Parámetros:
Devoluciones:
deleteActivity
public abstract CompletableFuture
Elimina una actividad existente.
Parámetros:
Devoluciones:
getActivity
public abstract Activity getActivity()
Obtiene la actividad de este turno del bot.
Devoluciones:
getAdapter
public abstract BotAdapter getAdapter()
Obtiene el adaptador de bot que creó este objeto de contexto.
Devoluciones:
getLocale
public abstract String getLocale()
Obtiene la configuración regional de este objeto de contexto.
Devoluciones:
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:
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:
Devoluciones:
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:
Devoluciones:
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:
Devoluciones:
sendActivities
public default CompletableFuture
Método auxiliar para enviar una matriz de actividades. Esto llama a sendActivities(List<Activity> activities).
Parámetros:
Devoluciones:
sendActivities
public abstract CompletableFuture
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:
Devoluciones:
sendActivity
public abstract CompletableFuture
Envía una actividad al remitente de la actividad entrante.
Parámetros:
Devoluciones:
sendActivity
public abstract CompletableFuture
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:
Devoluciones:
sendActivity
public abstract CompletableFuture
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:
Devoluciones:
sendActivity
public abstract CompletableFuture
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:
Devoluciones:
sendActivityBlind
public default CompletableFuture
Envía una actividad al remitente de la actividad entrante sin devolver un resourceResponse.
Parámetros:
Devoluciones:
setLocale
public abstract void setLocale(String withLocale)
Establezca la configuración regional en este objeto de contexto.
Parámetros:
traceActivity
public static CompletableFuture
Parámetros:
Devoluciones:
traceActivity
public static CompletableFuture
Envía una actividad de seguimiento a la BotAdapter con fines de registro.
Parámetros:
Devoluciones:
updateActivity
public abstract CompletableFuture
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:
Devoluciones: