DialogMemoryScope class
A memory scope that provides access to the active dialog's state. This scope binds to the active dialog if it is a container, or to its parent dialog if applicable.
- Extends
Constructors
| Dialog |
Initializes a new instance of the DialogMemoryScope class. |
Inherited Properties
| include |
|
| name |
Methods
| get |
Gets the backing memory for this scope. |
| set |
Changes the backing object for the memory scope. |
Inherited Methods
| delete(Dialog |
Deletes the backing memory for a scope. |
| load(Dialog |
Loads a scopes backing memory at the start of a turn. |
| save |
Saves a scopes backing memory at the end of a turn. |
Constructor Details
DialogMemoryScope()
Initializes a new instance of the DialogMemoryScope class.
new DialogMemoryScope()Inherited Property Details
includeInSnapshot
name
Method Details
getMemory(DialogContext)
Gets the backing memory for this scope.
function getMemory(dialogContext: DialogContext): objectParameters
- dialogContext
- DialogContext
The DialogContext object for this turn.
Returns
object
The memory for the scope.
setMemory(DialogContext, object)
Changes the backing object for the memory scope.
function setMemory(dialogContext: DialogContext, memory: object)Parameters
- dialogContext
- DialogContext
The DialogContext object for this turn.
- memory
-
object
Memory object to set for the scope.
Inherited Method Details
delete(DialogContext)
Deletes the backing memory for a scope.
function delete(_dialogContext: DialogContext): Promise<void>Parameters
- _dialogContext
- DialogContext
Current dialog context.
Returns
Promise<void>
Inherited From MemoryScope.delete
load(DialogContext)
Loads a scopes backing memory at the start of a turn.
function load(_dialogContext: DialogContext): Promise<void>Parameters
- _dialogContext
- DialogContext
Current dialog context.
Returns
Promise<void>
Inherited From MemoryScope.load
saveChanges(DialogContext)
Saves a scopes backing memory at the end of a turn.
function saveChanges(_dialogContext: DialogContext): Promise<void>Parameters
- _dialogContext
- DialogContext
Current dialog context.
Returns
Promise<void>
Inherited From MemoryScope.saveChanges