DialogStateManager class
DialogStateManager gère les étendues de mémoire et les résolveurs de chemins d’accès.
Remarques
Les MemoryScopes sont des objets de niveau racine nommés, qui peuvent exister soit dans le contexte de la boîte de dialogue, soit dans un état de désactivation. Les résolveurs de chemin d’accès autorisent le comportement de raccourci pour le mappage d’éléments tels que $foo -> dialog.foo
Constructeurs
Dialog |
Initialise une nouvelle instance de la classe DialogStateManager . |
Propriétés
configuration | Obtient ou définit les résolveurs de chemin d’accès et les étendues de mémoire configurés pour le gestionnaire d’état de boîte de dialogue. |
Méthodes
any |
Vérifiez si un chemin d’accès a changé depuis le filigrane. |
delete |
Supprime toute la mémoire de stockage pour une étendue donnée. |
delete |
Supprimer la propriété de la mémoire |
get |
Obtient toutes les étendues de mémoire appropriées pour la journalisation. |
get |
Obtenez la valeur de la mémoire à l’aide de l’expression de chemin d’accès. |
load |
Vérifie que toutes les étendues de mémoire ont été chargées pour le tour actuel. |
parse |
Normalise les segments de chemin d’accès d’un chemin d’accès passé. |
save |
Enregistre toutes les modifications apportées aux étendues de mémoire. |
set |
Définissez la mémoire sur valeur. |
track |
Effectuez le suivi des modifications de chemins d’accès spécifiques. |
transform |
Transformez le chemin à l’aide des transformateurs de chemin d’accès 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
Contexte 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 résolveurs de chemin d’accès et les étendues de mémoire configurés pour le gestionnaire d’état de boîte de dialogue.
configuration: DialogStateManagerConfiguration
Valeur de propriété
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 à un 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’accès de 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 d’accès à 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 aucun defaultValue
spécifié.
Remarques
Cela retourne toujours un CLONE de la mémoire. Les modifications apportées au résultat n’affectent pas la mémoire.
loadAllScopes()
Vérifie 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 d’accès passé.
function parsePath(pathExpression: string, allowNestedPaths?: boolean): string | number[]
Paramètres
- pathExpression
-
string
Chemin d'accès à normaliser.
- allowNestedPaths
-
boolean
facultatif. 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 d'accès normalisé.
Remarques
Un chemin d’accès de profile.address[0]
sera normalisé en profile.address.0
.
saveAllChanges()
Enregistre toutes 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 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 des modifications de chemins d’accès spécifiques.
function trackPaths(paths: string[]): string[]
Paramètres
- paths
-
string[]
Chemins à suivre.
Retours
string[]
Chemins normalisés à passer à anyPathChanged().
transformPath(string)
Transformez le chemin à l’aide des transformateurs de chemin d’accès inscrits.
function transformPath(pathExpression: string): string
Paramètres
- pathExpression
-
string
Chemin à 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.