UserState Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a state management object for user state.
public class UserState : Microsoft.Bot.Builder.BotStatetype UserState = class
inherit BotStatePublic Class UserState
Inherits BotState- Inheritance
Remarks
User state is available in any turn that the bot is conversing with that user on that channel, regardless of the conversation.
Constructors
| UserState(IStorage) |
Initializes a new instance of the UserState class. |
Methods
| ClearStateAsync(ITurnContext, CancellationToken) |
Clears the state cache for this BotState. (Inherited from BotState) |
| CreateProperty<T>(String) |
Creates a named state property within the scope of a BotState and returns an accessor for the property. (Inherited from BotState) |
| DeleteAsync(ITurnContext, CancellationToken) |
Deletes any state in storage and the cache for this BotState. (Inherited from BotState) |
| DeletePropertyValueAsync(ITurnContext, String, CancellationToken) |
Deletes a property from the state cache for this BotState. (Inherited from BotState) |
| Get(ITurnContext) |
Gets a copy of the raw cached data for this BotState from the turn context. (Inherited from BotState) |
| GetCachedState(ITurnContext) |
Gets the cached bot state instance that wraps the raw cached data for this BotState from the turn context. (Inherited from BotState) |
| GetPropertyValueAsync<T>(ITurnContext, String, CancellationToken) |
Gets the value of a property from the state cache for this BotState. (Inherited from BotState) |
| GetStorageKey(ITurnContext) |
Gets the key to use when reading and writing state to and from storage. |
| LoadAsync(ITurnContext, Boolean, CancellationToken) |
Populates the state cache for this BotState from the storage layer. (Inherited from BotState) |
| SaveChangesAsync(ITurnContext, Boolean, CancellationToken) |
Writes the state cache for this BotState to the storage layer. (Inherited from BotState) |
| SetPropertyValueAsync(ITurnContext, String, Object, CancellationToken) |
Sets the value of a property in the state cache for this BotState. (Inherited from BotState) |