StatePropertyAccessor interface
Define métodos para acceder a una propiedad de estado creada en un objeto BotState .
Comentarios
Para crear una propiedad de estado en un objeto de administración de estado, use el método createProperty<T> .
Métodos
| delete(Turn |
Elimina la propiedad persistente de su objeto de almacenamiento de respaldo. |
| get(Turn |
Lee una propiedad persistente de su objeto de almacenamiento de respaldo. |
| get(Turn |
|
| set(Turn |
Asigna un nuevo valor a las propiedades que respaldan el objeto de almacenamiento. |
Detalles del método
delete(TurnContext)
Elimina la propiedad persistente de su objeto de almacenamiento de respaldo.
function delete(context: TurnContext): Promise<void>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
Devoluciones
Promise<void>
Comentarios
Las propiedades que respaldan el objeto de almacenamiento DEBEN cargarse en memoria en el primer acceso.
await myProperty.delete(context);
get(TurnContext)
Lee una propiedad persistente de su objeto de almacenamiento de respaldo.
function get(context: TurnContext): Promise<T | undefined>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
Devoluciones
Promise<T | undefined>
Comentarios
Las propiedades que respaldan el objeto de almacenamiento DEBEN cargarse en memoria en el primer acceso.
Si la propiedad no existe actualmente en el objeto de almacenamiento y se ha especificado un defaultValue , se debe copiar un clon del defaultValue objeto de almacenamiento. Si no se ha especificado , defaultValue se debe devolver un valor de undefined SHOULD.
const value = await myProperty.get(context, { count: 0 });
get(TurnContext, T)
function get(context: TurnContext, defaultValue: T): Promise<T>Parámetros
- context
- TurnContext
- defaultValue
-
T
Devoluciones
Promise<T>
set(TurnContext, T)
Asigna un nuevo valor a las propiedades que respaldan el objeto de almacenamiento.
function set(context: TurnContext, value: T): Promise<void>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- value
-
T
Valor que se va a asignar.
Devoluciones
Promise<void>
Comentarios
Las propiedades que respaldan el objeto de almacenamiento DEBEN cargarse en memoria en el primer acceso.
En función de la implementación de los sistemas de estado, es posible que se requiera un paso adicional para conservar los cambios reales en el disco.
await myProperty.set(context, value);