Class UserMemoryScope

ReadonlyincludeInSnapshot

Readonlyname

delete

• delete(_dialogContext: DialogContext): Promise<void>

  Deletes any state in storage and the cache for this AgentState.

  Parameters

  • _dialogContext: DialogContext

    The DialogContext object for this turn.

  Returns Promise<void>

  A Promise that represents the work queued to execute.

getMemory

• getMemory(dialogContext: DialogContext): object

  Get the backing memory for this scope.

  Parameters

  • dialogContext: DialogContext

    current dialog context.

  Returns object

  Memory for the scope.

load

• load(dialogContext: DialogContext, force?: boolean): Promise<void>

  Populates the state cache for this AgentState from the storage layer.

  Parameters

  • dialogContext: DialogContext

    The DialogContext object for this turn.

  • force: boolean = false

    Optional, true to overwrite any existing state cache; or false to load state from storage only if the cache doesn't already exist.

  Returns Promise<void>

  A Promise that represents the work queued to execute.

saveChanges

• saveChanges(dialogContext: DialogContext, force?: boolean): Promise<void>

  Writes the state cache for this AgentState to the storage layer.

  Parameters

  • dialogContext: DialogContext

    The DialogContext object for this turn.

  • force: boolean = false

    Optional, true to save the state cache to storage; or false to save state to storage only if a property in the cache has changed.

  Returns Promise<void>

  A Promise that represents the work queued to execute.

setMemory

• setMemory(dialogContext: DialogContext, _memory: object): void

  Changes the backing object for the memory scope.

  Parameters

  • dialogContext: DialogContext

    current dialog context

  • _memory: object

    memory

  Returns void