Share via


UserMemoryScope Class

Definition

UserMemoryScope represents User scoped memory.

public class UserMemoryScope : Microsoft.Bot.Builder.Dialogs.Memory.Scopes.BotStateMemoryScope<Microsoft.Bot.Builder.UserState>
type UserMemoryScope = class
    inherit BotStateMemoryScope<UserState>
Public Class UserMemoryScope
Inherits BotStateMemoryScope(Of UserState)
Inheritance

Remarks

This relies on the UserState object being accessible from turnContext.TurnState.Get<UserState>().

Constructors

UserMemoryScope()

Initializes a new instance of the UserMemoryScope class.

Properties

IncludeInSnapshot

Gets or sets a value indicating whether this memory should be included in snapshot.

(Inherited from MemoryScope)
Name

Gets or sets name of the scope.

(Inherited from MemoryScope)

Methods

DeleteAsync(DialogContext, CancellationToken)

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

(Inherited from BotStateMemoryScope<T>)
GetMemory(DialogContext)

Get the backing memory for this scope.

(Inherited from BotStateMemoryScope<T>)
LoadAsync(DialogContext, Boolean, CancellationToken)

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

(Inherited from BotStateMemoryScope<T>)
SaveChangesAsync(DialogContext, Boolean, CancellationToken)

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

(Inherited from BotStateMemoryScope<T>)
SetMemory(DialogContext, Object)

Changes the backing object for the memory scope.

(Inherited from BotStateMemoryScope<T>)

Applies to