Condividi tramite

BotStatePropertyAccessor class

  • Riferimento
Pacchetto:
botbuilder-core

BotState'implementazione specifica dell'interfaccia StatePropertyAccessor.

Commenti

Le proprietà possono essere definite per una determinata istanza di BotState usando createProperty().

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

Costruttori

BotStatePropertyAccessor(BotState, string)

Crea una nuova istanza di BotStatePropertyAccessor.

Proprietà

name

Metodi

delete(TurnContext)

Elimina la proprietà persistente dal relativo oggetto di archiviazione di backup.
get(TurnContext)

Legge una proprietà persistente dall'oggetto di archiviazione di backup.
get(TurnContext, T)
set(TurnContext, T)

Assegna un nuovo valore all'oggetto di archiviazione di backup delle proprietà.

Dettagli costruttore

BotStatePropertyAccessor(BotState, string)

Crea una nuova istanza di BotStatePropertyAccessor.

new BotStatePropertyAccessor(state: BotState, name: string)

Parametri

state
BotState

Istanza di BotState padre.

name

string

Nome univoco della proprietà per BotState padre.

Dettagli proprietà

name 

name: string

Valore della proprietà

string

Dettagli metodo

delete(TurnContext)

Elimina la proprietà persistente dal relativo oggetto di archiviazione di backup.

function delete(context: TurnContext): Promise<void>

Parametri

context
TurnContext

(xref:botbuilder-core. Oggetto TurnContext) per questo turno.

Restituisce

Promise<void>

get(TurnContext)

Legge una proprietà persistente dall'oggetto di archiviazione di backup.

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

Parametri

context
TurnContext

(xref:botbuilder-core. Oggetto TurnContext) per questo turno.

Restituisce

Promise<T | undefined>

Rappresentazione JSON dello stato memorizzato nella cache.

get(TurnContext, T) 

function get(context: TurnContext, defaultValue: T): Promise<T>

Parametri

context
TurnContext
defaultValue

T

Restituisce

Promise<T>

set(TurnContext, T)

Assegna un nuovo valore all'oggetto di archiviazione di backup delle proprietà.

function set(context: TurnContext, value: T): Promise<void>

Parametri

context
TurnContext

(xref:botbuilder-core. Oggetto TurnContext) per questo turno.

value

T

Valore da impostare sulla proprietà .

Restituisce

Promise<void>