Class DialogStateManager

constructor

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

  Initializes a new instance of the DialogStateManager class.

  Parameters

  • dc: DialogContext

    The dialog context for the current turn of the conversation.

  • Optionalconfiguration: DialogStateManagerConfiguration

    Configuration for the dialog state manager.

  Returns DialogStateManager

configuration

anyPathChanged

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

  Check to see if any path has changed since watermark.

  Parameters

  • counter: number

    Time counter to compare to.

  • paths: string[]

    Paths from trackPaths method to check.

  Returns boolean

  True if any path has changed since counter.

deleteScopesMemory

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

  Deletes all of the backing memory for a given scope.

  Parameters

  • name: string

    Name of the scope.

  Returns Promise<void>

deleteValue

• deleteValue(pathExpression: string): void

  Delete property from memory

  Parameters

  • pathExpression: string

    The leaf property to remove.

  Returns void

getMemorySnapshot

• getMemorySnapshot(): object

  Gets all memory scopes suitable for logging.

  Returns object

  Object which represents all memory scopes.

getValue

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

  Get the value from memory using path expression.

  Type Parameters

  • T = any

    The value type to return.

  Parameters

  • pathExpression: string

    Path expression to use.

  • OptionaldefaultValue: T | (() => T)

    (Optional) default value to use if the path isn't found. May be a function that returns the default value to use.

  Returns T

  The found value or undefined if not found and no defaultValue specified.

  Remarks

  This always returns a CLONE of the memory, any modifications to the result will not affect memory.

loadAllScopes

• loadAllScopes(): Promise<void>

  Ensures that all memory scopes have been loaded for the current turn.

  Returns Promise<void>

  Remarks

  This should be called at the beginning of the turn.

parsePath

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

  Normalizes the path segments of a passed in path.

  Parameters

  • pathExpression: string

    The path to normalize.

  • allowNestedPaths: boolean = true

    Optional. If false then detection of a nested path will cause an empty path to be returned. Defaults to 'true'.

  Returns (string | number)[]

  The normalized path.

  Remarks

  A path of profile.address[0] will be normalized to profile.address.0.

saveAllChanges

• saveAllChanges(): Promise<void>

  Saves any changes made to memory scopes.

  Returns Promise<void>

  Remarks

  This should be called at the end of the turn.

setValue

• setValue(pathExpression: string, value: any): void

  Set memory to value.

  Parameters

  • pathExpression: string

    Path to memory.

  • value: any

    Value to set.

  Returns void

trackPaths

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

  Track when specific paths are changed.

  Parameters

  • paths: string[]

    Paths to track.

  Returns string[]

  Normalized paths to pass to anyPathChanged method.

transformPath

• transformPath(pathExpression: string): string

  Transform the path using the registered path transformers.

  Parameters

  • pathExpression: string

    The path to transform.

  Returns string

  The transformed path.

version

• version(): string

  Gets the version number.

  Returns string

  A string with the version number.