Freigeben über

BotStatePropertyAccessor class

  • Referenz
Paket:
botbuilder-core

Eine BotState spezifische Implementierung der StatePropertyAccessor-Schnittstelle.

Hinweise

Eigenschaften können für eine bestimmte BotState Instanz mithilfe von createProperty()definiert werden.

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

Konstruktoren

BotStatePropertyAccessor(BotState, string)

Erstellt eine neue BotStatePropertyAccessor-Instanz.

Eigenschaften

name

Methoden

delete(TurnContext)

Löscht die beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt.
get(TurnContext)

Liest eine beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt.
get(TurnContext, T)
set(TurnContext, T)

Weist den Eigenschaften, die das Speicherobjekt sichern, einen neuen Wert zu.

Details zum Konstruktor

BotStatePropertyAccessor(BotState, string)

Erstellt eine neue BotStatePropertyAccessor-Instanz.

new BotStatePropertyAccessor(state: BotState, name: string)

Parameter

state
BotState

Übergeordnete BotState-Instanz.

name

string

Eindeutiger Name der Eigenschaft für den übergeordneten BotState.

Details zur Eigenschaft

name 

name: string

Eigenschaftswert

string

Details zur Methode

delete(TurnContext)

Löscht die beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt.

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

Parameter

context
TurnContext

(xref:botbuilder-core. TurnContext)-Objekt für diese Drehung.

Gibt zurück

Promise<void>

get(TurnContext)

Liest eine beibehaltene Eigenschaft aus dem sicherungseigenen Speicherobjekt.

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

Parameter

context
TurnContext

(xref:botbuilder-core. TurnContext)-Objekt für diese Drehung.

Gibt zurück

Promise<T | undefined>

Eine JSON-Darstellung des zwischengespeicherten Zustands.

get(TurnContext, T) 

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

Parameter

context
TurnContext
defaultValue

T

Gibt zurück

Promise<T>

set(TurnContext, T)

Weist den Eigenschaften, die das Speicherobjekt sichern, einen neuen Wert zu.

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

Parameter

context
TurnContext

(xref:botbuilder-core. TurnContext)-Objekt für diese Drehung.

value

T

Wert, der für die Eigenschaft festgelegt werden soll.

Gibt zurück

Promise<void>