UserState.GetStorageKey(ITurnContext) Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.18.1

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.

Gets the key to use when reading and writing state to and from storage.

protected override string GetStorageKey (Microsoft.Bot.Builder.ITurnContext turnContext);

override this.GetStorageKey : Microsoft.Bot.Builder.ITurnContext -> string

Protected Overrides Function GetStorageKey (turnContext As ITurnContext) As String

Parameters

turnContext: ITurnContext

The context object for this turn.

Returns

String

The storage key.

Exceptions

ArgumentNullException

The Activity for the current turn is missing ChannelId or From information, or the sender's Id is missing.

Remarks

User state includes the channel ID and user ID as part of its storage key.

Applies to