Partager via

BotStatePropertyAccessor class

  • Référence
Paquet:
botbuilder-core

Implémentation BotState spécifique de l’interface StatePropertyAccessor.

Remarques

Les propriétés peuvent être définies pour une instance de BotState donnée à l’aide de createProperty().

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

Constructeurs

BotStatePropertyAccessor(BotState, string)

Crée une instance BotStatePropertyAccessor.

Propriétés

name

Méthodes

delete(TurnContext)

Supprime la propriété persistante de son objet de stockage de stockage.
get(TurnContext)

Lit une propriété persistante à partir de son objet de stockage de stockage de stockage.
get(TurnContext, T)
set(TurnContext, T)

Affecte une nouvelle valeur à l’objet de stockage de stockage de propriétés.

Détails du constructeur

BotStatePropertyAccessor(BotState, string)

Crée une instance BotStatePropertyAccessor.

new BotStatePropertyAccessor(state: BotState, name: string)

Paramètres

state
BotState

Instance BotState parente.

name

string

Nom unique de la propriété pour le BotState parent.

Détails de la propriété

name 

name: string

Valeur de propriété

string

Détails de la méthode

delete(TurnContext)

Supprime la propriété persistante de son objet de stockage de stockage.

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

Paramètres

context
TurnContext

(xref :botbuilder-core. Objet TurnContext) pour ce tour.

Retours

Promise<void>

get(TurnContext)

Lit une propriété persistante à partir de son objet de stockage de stockage de stockage.

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

Paramètres

context
TurnContext

(xref :botbuilder-core. Objet TurnContext) pour ce tour.

Retours

Promise<T | undefined>

Représentation JSON de l’état mis en cache.

get(TurnContext, T) 

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

Paramètres

context
TurnContext
defaultValue

T

Retours

Promise<T>

set(TurnContext, T)

Affecte une nouvelle valeur à l’objet de stockage de stockage de propriétés.

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

Paramètres

context
TurnContext

(xref :botbuilder-core. Objet TurnContext) pour ce tour.

value

T

Valeur à définir sur la propriété.

Retours

Promise<void>