Partager via

DialogStateManager class

  • Référence
Paquet:
botbuilder-dialogs

DialogStateManager gère les étendues de mémoire et les programmes de résolution de chemin d’accès.

Remarques

Les MemoryScopes sont des objets de niveau racine nommés, qui peuvent exister dans le contexte de boîte de dialogue ou désactivé de l’état de désactivation. Les résolveurs de chemins autorisent le comportement de raccourci pour le mappage d’éléments tels que $foo -> dialog.foo

Constructeurs

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Initialise une nouvelle instance de la classe DialogStateManager.

Propriétés

configuration

Obtient ou définit les programmes de résolution de chemin configurés et les étendues de mémoire pour le gestionnaire d’état de boîte de dialogue.

Méthodes

anyPathChanged(number, string[])

Vérifiez si un chemin d’accès a changé depuis le filigrane.
deleteScopesMemory(string)

Supprime toute la mémoire de stockage pour une étendue donnée.
deleteValue(string)

Supprimer la propriété de la mémoire
getMemorySnapshot()

Obtient toutes les étendues de mémoire appropriées pour la journalisation.
getValue<T>(string, T | () => T)

Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès.
loadAllScopes()

Garantit que toutes les étendues de mémoire ont été chargées pour le tour actuel.
parsePath(string, boolean)

Normalise les segments de chemin d’accès d’un chemin passé.
saveAllChanges()

Enregistre les modifications apportées aux étendues de mémoire.
setValue(string, any)

Définissez la mémoire sur la valeur.
trackPaths(string[])

Effectuez le suivi lorsque des chemins spécifiques sont modifiés.
transformPath(string)

Transformez le chemin à l’aide des transformateurs de chemins inscrits.
version()

Obtient le numéro de version.

Détails du constructeur

DialogStateManager(DialogContext, DialogStateManagerConfiguration)

Initialise une nouvelle instance de la classe DialogStateManager.

new DialogStateManager(dc: DialogContext, configuration?: DialogStateManagerConfiguration)

Paramètres

dc
DialogContext

Contexte de boîte de dialogue pour le tour actuel de la conversation.

configuration
DialogStateManagerConfiguration

Configuration du gestionnaire d’état de boîte de dialogue.

Détails de la propriété

configuration

Obtient ou définit les programmes de résolution de chemin configurés et les étendues de mémoire pour le gestionnaire d’état de boîte de dialogue.

configuration: DialogStateManagerConfiguration

Valeur de propriété

DialogStateManagerConfiguration

Remarques

Il existe un ensemble unique d’informations de configuration pour une chaîne donnée de contextes de dialogue. L’affectation d’une nouvelle configuration à n’importe quel DialogStateManager au sein de la chaîne met à jour la configuration de l’ensemble de la chaîne.

Détails de la méthode

anyPathChanged(number, string[])

Vérifiez si un chemin d’accès a changé depuis le filigrane.

function anyPathChanged(counter: number, paths: string[]): boolean

Paramètres

counter

number

Compteur de temps à comparer.

paths

string[]

Chemins d'trackPaths() à vérifier.

Retours

boolean

True si un chemin d’accès a changé depuis le compteur.

deleteScopesMemory(string)

Supprime toute la mémoire de stockage pour une étendue donnée.

function deleteScopesMemory(name: string): Promise<void>

Paramètres

name

string

Nom de l’étendue.

Retours

Promise<void>

deleteValue(string)

Supprimer la propriété de la mémoire

function deleteValue(pathExpression: string)

Paramètres

pathExpression

string

Propriété feuille à supprimer.

getMemorySnapshot()

Obtient toutes les étendues de mémoire appropriées pour la journalisation.

function getMemorySnapshot(): object

Retours

object

Objet qui représente toutes les étendues de mémoire.

getValue<T>(string, T | () => T)

Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès.

function getValue<T>(pathExpression: string, defaultValue?: T | () => T): T

Paramètres

pathExpression

string

Expression de chemin à utiliser.

defaultValue

T | () => T

(Facultatif) valeur par défaut à utiliser si le chemin d’accès est introuvable. Il peut s’agir d’une fonction qui retourne la valeur par défaut à utiliser.

Retours

T

Valeur trouvée ou non définie si introuvable et aucune defaultValue spécifiée.

Remarques

Cela retourne toujours un CLONE de la mémoire, toutes les modifications apportées au résultat n’affectent pas la mémoire.

loadAllScopes()

Garantit que toutes les étendues de mémoire ont été chargées pour le tour actuel.

function loadAllScopes(): Promise<void>

Retours

Promise<void>

Remarques

Cela doit être appelé au début du tour.

parsePath(string, boolean)

Normalise les segments de chemin d’accès d’un chemin passé.

function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]

Paramètres

pathExpression

string

Chemin d’accès à normaliser.

allowNestedPaths

boolean

Optionnel. Si false la détection d’un chemin imbriqué entraîne le retour d’un chemin vide. La valeur par défaut est « true ».

Retours

string | number[]

Chemin normalisé.

Remarques

Un chemin d'profile.address[0] sera normalisé pour profile.address.0.

saveAllChanges()

Enregistre les modifications apportées aux étendues de mémoire.

function saveAllChanges(): Promise<void>

Retours

Promise<void>

Remarques

Cela doit être appelé à la fin du tour.

setValue(string, any)

Définissez la mémoire sur la valeur.

function setValue(pathExpression: string, value: any)

Paramètres

pathExpression

string

Chemin d’accès à la mémoire.

value

any

Valeur à définir.

trackPaths(string[])

Effectuez le suivi lorsque des chemins spécifiques sont modifiés.

function trackPaths(paths: string[]): string[]

Paramètres

paths

string[]

Chemins d’accès au suivi.

Retours

string[]

Chemins normalisés à passer à anyPathChanged().

transformPath(string)

Transformez le chemin à l’aide des transformateurs de chemins inscrits.

function transformPath(pathExpression: string): string

Paramètres

pathExpression

string

Chemin d’accès à transformer.

Retours

string

Chemin transformé.

version()

Obtient le numéro de version.

function version(): string

Retours

string

Chaîne avec le numéro de version.