BotState Clase

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

Implementaciones

PropertyManager

public abstract class BotState
implements PropertyManager

Define un objeto de administración de estado y automatiza la lectura y escritura de propiedades de estado asociadas en una capa de almacenamiento.

Cada objeto de administración de estados define un ámbito para una capa de almacenamiento. Las propiedades de estado se crean dentro de un ámbito de administración de estado y Bot Framework define estos ámbitos: ConversationState, UserStatey PrivateConversationState. Puede definir ámbitos adicionales para el bot.

Resumen del constructor

Constructor Description
BotState(Storage withStorage, String withContextServiceKey)

Inicializa una nueva instancia de la clase BotState.

Resumen del método

Modificador y tipo Método y descripción
StatePropertyAccessor<T> <T>createProperty(String name)

Crea una propiedad de estado con nombre dentro del ámbito de un botState y devuelve un descriptor de acceso para la propiedad .
protected java.util.concurrent.CompletableFuture<T> <T>getPropertyValue(TurnContext turnContext, String propertyName)

Obtiene el valor de una propiedad de la caché de estado de este botState.
java.util.concurrent.CompletableFuture<java.lang.Void> clearState(TurnContext turnContext)

Borra la caché de estado de este botState.
java.util.concurrent.CompletableFuture<java.lang.Void> delete(TurnContext turnContext)

Elimine cualquier estado almacenado actualmente en este ámbito de estado.
protected java.util.concurrent.CompletableFuture<java.lang.Void> deletePropertyValue(TurnContext turnContext, String propertyName)

Elimina una propiedad de la caché de estado de este botState.
com.fasterxml.jackson.databind.JsonNode get(TurnContext turnContext)

Obtiene una copia de los datos almacenados en caché sin procesar para este botEstado del contexto de turno.
CachedBotState getCachedState(TurnContext turnContext)

Obtiene la instancia de estado del bot almacenada en caché que encapsula los datos almacenados en caché sin procesar para este botEstado del contexto de turno.
abstract java.lang.String getStorageKey(TurnContext turnContext)

Cuando se invalida en una clase derivada, obtiene la clave que se va a usar al leer y escribir el estado en y desde el almacenamiento.
java.util.concurrent.CompletableFuture<java.lang.Void> load(TurnContext turnContext)

Rellena la caché de estado de este botEstado de la capa de almacenamiento.
java.util.concurrent.CompletableFuture<java.lang.Void> load(TurnContext turnContext, boolean force)

Lee en el objeto de estado actual y lo almacena en caché en el objeto de contexto de este turno.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(TurnContext turnContext)

Escribe la caché de estado de este botEstado en la capa de almacenamiento.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(TurnContext turnContext, boolean force)

Escribe la caché de estado de este botEstado en la capa de almacenamiento.
protected java.util.concurrent.CompletableFuture<java.lang.Void> setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Establece el valor de una propiedad en la caché de estado de este botState.

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

BotState

public BotState(Storage withStorage, String withContextServiceKey)

Inicializa una nueva instancia de la clase BotState.

Parámetros:

withStorage - Proveedor de almacenamiento que se va a usar.
withContextServiceKey - Clave de la caché de estado para este BotState.

Produce:

java.lang.IllegalArgumentException - Argumentos null Storage o clave de servicio vacía.

Detalles del método

<T>createProperty

public StatePropertyAccessor createProperty(String name)

Crea una propiedad de estado con nombre dentro del ámbito de un BotState y devuelve un descriptor de acceso para la propiedad .

Parámetros:

name - nombre de la propiedad.

Devoluciones:

Un StatePropertyAccessor<T> para la propiedad .

Produce:

java.lang.IllegalArgumentException - Nombre vacío

<T>getPropertyValue

protected CompletableFuture getPropertyValue(TurnContext turnContext, String propertyName)

Obtiene el valor de una propiedad de la caché de estado de este BotState.

Parámetros:

turnContext - Objeto de contexto para este turno.
propertyName - Nombre de la propiedad que se va a obtener.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Si la tarea se realiza correctamente, el resultado contiene el valor de la propiedad .

clearState

public CompletableFuture clearState(TurnContext turnContext)

Borra la caché de estado de este BotState.

Este método borra la memoria caché de estado en el contexto de turno. Llame a saveChanges(TurnContext turnContext, boolean force) para conservar este cambio en la capa de almacenamiento.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

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

delete

public CompletableFuture delete(TurnContext turnContext)

Elimine cualquier estado almacenado actualmente en este ámbito de estado.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

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

deletePropertyValue

protected CompletableFuture deletePropertyValue(TurnContext turnContext, String propertyName)

Elimina una propiedad de la caché de estado de este BotState.

Parámetros:

turnContext - Objeto de contexto para este turno.
propertyName - Nombre de la propiedad que se va a eliminar.

Devoluciones:

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

get

public JsonNode get(TurnContext turnContext)

Obtiene una copia de los datos almacenados en caché sin procesar para este BotState desde el contexto de turno.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

Representación JSON del estado almacenado en caché.

getCachedState

public BotState.CachedBotState getCachedState(TurnContext turnContext)

Obtiene la instancia de estado del bot almacenada en caché que encapsula los datos almacenados en caché sin procesar para este BotState desde el contexto de turno.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

Instancia de estado del bot almacenado en caché.

getStorageKey

public abstract String getStorageKey(TurnContext turnContext)

Cuando se invalida en una clase derivada, obtiene la clave que se va a usar al leer y escribir el estado en y desde el almacenamiento.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

Clave de almacenamiento.

Produce:

java.lang.IllegalArgumentException - TurnContext no contiene todos los datos necesarios.

load

public CompletableFuture load(TurnContext turnContext)

Rellena la caché de estado de este BotState desde la capa de almacenamiento.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

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

load

public CompletableFuture load(TurnContext turnContext, boolean force)

Lee en el objeto de estado actual y lo almacena en caché en el objeto de contexto de este turno.

Parámetros:

turnContext - Objeto de contexto para este turno.
force - true para sobrescribir cualquier caché de estado existente; o false para cargar el estado desde el almacenamiento solo si la memoria caché aún no existe.

Devoluciones:

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

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext)

Escribe la caché de estado para este BotState en la capa de almacenamiento.

Parámetros:

turnContext - Objeto de contexto para este turno.

Devoluciones:

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

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext, boolean force)

Escribe la caché de estado para este BotState en la capa de almacenamiento.

Parámetros:

turnContext - Objeto de contexto para este turno.
force - true para guardar la caché de estado en el almacenamiento; o false para guardar el estado en el almacenamiento solo si ha cambiado una propiedad de la memoria caché.

Devoluciones:

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

setPropertyValue

protected CompletableFuture setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Establece el valor de una propiedad en la memoria caché de estado para este BotState.

Parámetros:

turnContext - Objeto de contexto para este turno.
propertyName - Nombre de la propiedad que se va a establecer.
value - Valor que se va a establecer en la propiedad .

Devoluciones:

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

Se aplica a