AgentStateMemoryScope class
Base class for memory scopes based on AgentState.
- Extends
Constructors
| Agent |
Initializes a new instance of the AgentStateMemoryScope class. |
Inherited Properties
| include |
|
| name |
Methods
| delete(Dialog |
Deletes any state in storage and the cache for this AgentState. |
| get |
Get the backing memory for this scope. |
| load(Dialog |
Populates the state cache for this AgentState from the storage layer. |
| save |
Writes the state cache for this AgentState to the storage layer. |
| set |
Changes the backing object for the memory scope. |
Constructor Details
AgentStateMemoryScope(string)
Initializes a new instance of the AgentStateMemoryScope class.
new AgentStateMemoryScope(name: string)Parameters
- name
-
string
name of the property.
Inherited Property Details
includeInSnapshot
name
Method Details
delete(DialogContext)
Deletes any state in storage and the cache for this AgentState.
function delete(_dialogContext: DialogContext): Promise<void>Parameters
- _dialogContext
- 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(dialogContext: DialogContext): objectParameters
- dialogContext
- DialogContext
current dialog context.
Returns
object
Memory for the scope.
load(DialogContext, boolean)
Populates the state cache for this AgentState from the storage layer.
function load(dialogContext: DialogContext, force?: boolean): Promise<void>Parameters
- dialogContext
- DialogContext
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 AgentState to the storage layer.
function saveChanges(dialogContext: DialogContext, force?: boolean): Promise<void>Parameters
- dialogContext
- DialogContext
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(dialogContext: DialogContext, _memory: object)Parameters
- dialogContext
- DialogContext
current dialog context
- _memory
-
object
memory