BotStateMemoryScope class
Base class for memory scopes based on BotState.
- Extends
Constructors
| Bot |
Initializes a new instance of the BotStateMemoryScope class. |
Inherited Properties
| include |
Gets a value indicating whether this memory should be included in snapshot. |
| name | Gets or sets name of the scope |
Methods
| delete(Dialog |
Deletes any state in storage and the cache for this BotState. |
| get |
Get the backing memory for this scope. |
| load(Dialog |
Populates the state cache for this BotState from the storage layer. |
| save |
Writes the state cache for this BotState to the storage layer. |
| set |
Changes the backing object for the memory scope. |
Constructor Details
BotStateMemoryScope(string)
Initializes a new instance of the BotStateMemoryScope class.
new BotStateMemoryScope(name: string)Parameters
- name
-
string
name of the property.
Inherited Property Details
includeInSnapshot
Gets a value indicating whether this memory should be included in snapshot.
includeInSnapshot: booleanProperty Value
boolean
Inherited From MemoryScope.includeInSnapshot
name
Method Details
delete(DialogContext)
Deletes any state in storage and the cache for this BotState.
function delete(_dc: DialogContext): Promise<void>Parameters
- _dc
- DialogContext
The DialogContext object for this turn.
Returns
Promise<void>
A Promise that represents the work queued to execute.
getMemory(DialogContext)
Get the backing memory for this scope.
function getMemory(dc: DialogContext): objectParameters
current dialog context.
Returns
object
Memory for the scope.
load(DialogContext, boolean)
Populates the state cache for this BotState from the storage layer.
function load(dc: DialogContext, force?: boolean): Promise<void>Parameters
The DialogContext object for this turn.
- force
-
boolean
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(DialogContext, boolean)
Writes the state cache for this BotState to the storage layer.
function saveChanges(dc: DialogContext, force?: boolean): Promise<void>Parameters
The DialogContext object for this turn.
- force
-
boolean
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(DialogContext, object)
Changes the backing object for the memory scope.
function setMemory(dc: DialogContext, _memory: object)Parameters
current dialog context
- _memory
-
object
memory