StatePropertyAccessor interface

Definisce i metodi per accedere a una proprietà di stato creata in un oggetto BotState.

Commenti

Per creare una proprietà di stato in un oggetto objet di gestione dello stato, usare il metodoT createProperty .

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 metodo

delete(TurnContext)

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

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

Parametri

context
TurnContext

Contesto per il turno di conversazione corrente con l'utente.

Restituisce

Promise<void>

Commenti

Le proprietà di backup dell'oggetto di archiviazione DEVONO essere caricate in memoria al primo accesso.

await myProperty.delete(context);

get(TurnContext)

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

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

Parametri

context
TurnContext

Contesto per il turno di conversazione corrente con l'utente.

Restituisce

Promise<T | undefined>

Commenti

Le proprietà di backup dell'oggetto di archiviazione DEVONO essere caricate in memoria al primo accesso.

Se la proprietà non esiste attualmente nell'oggetto di archiviazione ed è stato specificato un defaultValue, un clone del defaultValue DEVE essere copiato nell'oggetto di archiviazione. Se non è stato specificato un defaultValue, verrà restituito un valore di undefined SHOULD.

const value = await myProperty.get(context, { count: 0 });

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

Contesto per il turno di conversazione corrente con l'utente.

value

T

Valore da assegnare.

Restituisce

Promise<void>

Commenti

Le proprietà di backup dell'oggetto di archiviazione DEVONO essere caricate in memoria al primo accesso.

A seconda dell'implementazione dei sistemi di stato, potrebbe essere necessario un passaggio aggiuntivo per rendere persistenti le modifiche effettive apportate al disco.

await myProperty.set(context, value);