Compartir a través de

BotStatePropertyAccessor class

  • Referencia
Paquete:
botbuilder-core

Una BotState implementación específica de la StatePropertyAccessor interfaz.

Comentarios

Las propiedades se pueden definir para una instancia determinada BotState mediante createProperty().

const dialogStateProperty = ConversationState.createProperty('dialogState');
const dialogs = new DialogSet(dialogStateProperty);

Constructores

BotStatePropertyAccessor(BotState, string)

Crea una nueva instancia de BotStatePropertyAccessor.

Propiedades

name

Métodos

delete(TurnContext)

Elimina la propiedad persistente de su objeto de almacenamiento de respaldo.
get(TurnContext)

Lee una propiedad persistente de su objeto de almacenamiento de respaldo.
get(TurnContext, T)
set(TurnContext, T)

Asigna un nuevo valor a las propiedades que respaldan el objeto de almacenamiento.

Detalles del constructor

BotStatePropertyAccessor(BotState, string)

Crea una nueva instancia de BotStatePropertyAccessor.

new BotStatePropertyAccessor(state: BotState, name: string)

Parámetros

state
BotState

Instancia de BotState primaria.

name

string

Nombre único de la propiedad del elemento primario BotState.

Detalles de las propiedades

name 

name: string

Valor de propiedad

string

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

(xref:botbuilder-core. TurnContext) objeto para este turno.

Devoluciones

Promise<void>

get(TurnContext)

Lee una propiedad persistente de su objeto de almacenamiento de respaldo.

function get(context: TurnContext): Promise<T | undefined>

Parámetros

context
TurnContext

(xref:botbuilder-core. TurnContext) objeto para este turno.

Devoluciones

Promise<T | undefined>

Representación JSON del estado almacenado en caché.

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

(xref:botbuilder-core. TurnContext) objeto para este turno.

value

T

Valor que se va a establecer en la propiedad .

Devoluciones

Promise<void>