TurnContextImpl Clase

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

Implementaciones

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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 constructor

Constructor Description
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Crea un objeto de contexto.

Resumen del método

Modificador y tipo Método y descripción
void close()

AutoClosable#close.
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(ConversationReference conversationReference)

Elimina una actividad existente.
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String activityId)

Elimina una actividad existente.
void finalize()

Llamada automática de #close.
Activity getActivity()

Obtiene la actividad asociada a este turno; o null al procesar un mensaje proactivo.
BotAdapter getAdapter()

Obtiene el adaptador de bot que creó este objeto de contexto.
java.util.List<Activity> getBufferedReplyActivities()

Obtiene una lista de actividades que se van a enviar cuando "context".Actividad.modo de entrega== "espererespuestas".
java.lang.String getLocale()

Obtiene la configuración regional de este objeto de contexto.
boolean getResponded()

Indica si se envió al menos una respuesta para el turno actual.
TurnContextStateCollection getTurnState()

Obtiene los servicios registrados en este objeto de contexto.
TurnContext onDeleteActivity(DeleteActivityHandler handler)

Agrega un controlador de respuesta para las operaciones de eliminación de actividad.
TurnContext onSendActivities(SendActivitiesHandler handler)

Agrega un controlador de respuesta para las operaciones de actividad de envío.
TurnContext onUpdateActivity(UpdateActivityHandler handler)

Agrega un controlador de respuesta para las operaciones de actividad de actualización.
java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(List<Activity> activities)

Envía un conjunto de actividades al remitente de la actividad entrante.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(Activity activityToSend)

Envía una actividad al remitente de la actividad entrante.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend)

Envía una actividad de mensaje al remitente de la actividad entrante.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak)

Envía una actividad de mensaje al remitente de la actividad entrante.
java.util.concurrent.CompletableFuture<ResourceResponse> sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Envía una actividad de mensaje al remitente de la actividad entrante.
void setLocale(String withLocale)

Establezca la configuración regional en este objeto de contexto.
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity withActivity)

Reemplaza una actividad existente.

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 constructor

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Crea un objeto de contexto.

Parámetros:

withAdapter - Adaptador que crea el contexto.
withActivity - La actividad entrante para el turno; o null para un turno para un mensaje proactivo.

Detalles del método

close

public void close()

AutoClosable#close.

Produce:

java.lang.Exception - Si turnContextStateCollection.

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

Elimina una actividad existente. El ConversationReference#getActivityId de la referencia de conversación indica la actividad de la conversación que se va a eliminar.

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.

deleteActivity

public 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.

finalize

public void finalize()

Llamada automática de #close.

Invalidaciones:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

Obtiene la actividad asociada a este turno; o null al procesar un mensaje proactivo.

getAdapter

public BotAdapter getAdapter()

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

Devoluciones:

BotAdaptor para este turno.

getBufferedReplyActivities

public List getBufferedReplyActivities()

Obtiene una lista de actividades que se van a enviar cuando "context". Activity.DeliveryMode == 'expectReplies'.

Devoluciones:

Lista de actividades.

getLocale

public 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 boolean getResponded()

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.

getTurnState

public TurnContextStateCollection getTurnState()

Obtiene los servicios registrados en este objeto de contexto.

Devoluciones:

TurnContextStateCollection para este turno.

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

Parámetros:

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

Devoluciones:

Objeto de contexto actualizado.

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

Parámetros:

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

Devoluciones:

Objeto de contexto actualizado.

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

Parámetros:

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

Devoluciones:

Objeto de contexto actualizado.

sendActivities

public CompletableFuture sendActivities(List activities)

Envía un conjunto de actividades al remitente de la actividad entrante.

Parámetros:

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.

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

Parámetros:

activityToSend - Actividad que se va a enviar.

Devoluciones:

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

sendActivity

public 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 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.

Parámetros:

textReplyToSend - Texto del mensaje que se va a enviar.
speak - Para controlar varias características de la voz del bot, como la velocidad de voz, el volumen, la pronunciación y el tono, especifique el formato del lenguaje de marcado de síntesis de voz (SSML).

Devoluciones:

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

sendActivity

public 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.

Parámetros:

textReplyToSend - Texto del mensaje que se va a enviar.
speak - Para controlar varias características de la voz del bot, como la velocidad de voz, el volumen, la pronunciación y el tono, especifique el formato del lenguaje de marcado de síntesis de voz (SSML).
inputHint - (Opcional) Sugerencia de entrada.

Devoluciones:

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

setLocale

public 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.

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

Reemplaza una actividad existente.

Parámetros:

withActivity - Nueva actividad de reemplazo.

Devoluciones:

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

Se aplica a