Class UserState

Manages the state of a user.

Hierarchy (View Summary)

AgentState
- UserState

Index

Constructors

Properties

storage storageKey

Methods

clear createProperty delete get load saveChanges

Constructors

constructor

new UserState(storage: Storage, namespace?: string): UserState
Creates a new instance of UserState.
Parameters
- storage: Storage
  The storage provider.
- namespace: string = ''
Returns UserState
Overrides AgentState.constructor
- Defined in packages/agents-hosting/src/state/userState.ts:19

Properties

`Protected`storage

storage: Storage

The storage provider used to persist state between turns

`Protected`storageKey

storageKey: StorageKeyFactory

A factory function that generates keys for storing state data

Methods

clear

clear(context: TurnContext): Promise<void>
Clears the state by setting it to an empty object in the turn context.
Parameters
- context: TurnContext
  The turn context containing the state to clear
Returns Promise<void>
A promise that resolves when the clear operation is complete

Remarks
This does not remove the state from storage, it only clears the in-memory representation. Call saveChanges() after this to persist the empty state to storage.
Inherited from AgentState.clear
- Defined in packages/agents-hosting/src/state/agentState.ts:174

createProperty

createProperty<T = any>(name: string): AgentStatePropertyAccessor<T>
Creates a property accessor for the specified property.
Type Parameters
- T = any
Parameters
- name: string
  The name of the property to access
Returns AgentStatePropertyAccessor<T>
A property accessor for the specified property

Remarks
Property accessors provide typed access to properties within the state object.
Inherited from AgentState.createProperty
- Defined in packages/agents-hosting/src/state/agentState.ts:79

delete

delete(context: TurnContext, customKey?: CustomKey): Promise<void>
Deletes the state from both the turn context and storage.
Parameters
- context: TurnContext
  The turn context containing the state to delete
- OptionalcustomKey: CustomKey
  Optional custom storage key to use instead of the default
Returns Promise<void>
A promise that resolves when the delete operation is complete
Inherited from AgentState.delete
- Defined in packages/agents-hosting/src/state/agentState.ts:187

get

get(context: TurnContext): any
Gets the state from the turn context without loading it from storage.
Parameters
- context: TurnContext
  The turn context containing the state to get
Returns any
The state object, or undefined if no state is found in the turn context
Inherited from AgentState.get
- Defined in packages/agents-hosting/src/state/agentState.ts:202

load

load(context: TurnContext, force?: boolean, customKey?: CustomKey): Promise<any>
Loads the state from storage into the turn context.
Parameters
- context: TurnContext
  The turn context to load state into
- force: boolean = false
  If true, forces a reload from storage even if state is cached
- OptionalcustomKey: CustomKey
  Optional custom storage key to use instead of the default
Returns Promise<any>
A promise that resolves to the loaded state object

Remarks
If state is already cached in the turn context and force is not set, the cached version will be used.
Inherited from AgentState.load
- Defined in packages/agents-hosting/src/state/agentState.ts:95

saveChanges

saveChanges(
    context: TurnContext,
    force?: boolean,
    customKey?: CustomKey,
): Promise<void>
Saves the state to storage if it has changed since it was loaded.
Parameters
- context: TurnContext
  The turn context containing the state to save
- force: boolean = false
  If true, forces a save to storage even if no changes are detected
- OptionalcustomKey: CustomKey
  Optional custom storage key to use instead of the default
Returns Promise<void>
A promise that resolves when the save operation is complete

Remarks
Change detection uses a hash of the state object to determine if saving is necessary.
Inherited from AgentState.saveChanges
- Defined in packages/agents-hosting/src/state/agentState.ts:124