Microsoft.Bot.Connector.BotStateExtensions Class Reference

Extension methods for BotState. More...

Static Public Member Functions

static string[] DeleteStateForUser (this IBotState operations, string channelId, string userId)
 DeleteStateForUser More...
 
static async Task< string[]> DeleteStateForUserAsync (this IBotState operations, string channelId, string userId, CancellationToken cancellationToken=default(CancellationToken))
 DeleteStateForUser More...
 
static BotData GetConversationData (this IBotState operations, string channelId, string conversationId)
 GetConversationData More...
 
static async Task< BotDataGetConversationDataAsync (this IBotState operations, string channelId, string conversationId, CancellationToken cancellationToken=default(CancellationToken))
 GetConversationData More...
 
static BotData GetPrivateConversationData (this IBotState operations, string channelId, string conversationId, string userId)
 GetPrivateConversationData More...
 
static async Task< BotDataGetPrivateConversationDataAsync (this IBotState operations, string channelId, string conversationId, string userId, CancellationToken cancellationToken=default(CancellationToken))
 GetPrivateConversationData More...
 
static BotData GetUserData (this IBotState operations, string channelId, string userId)
 GetUserData More...
 
static async Task< BotDataGetUserDataAsync (this IBotState operations, string channelId, string userId, CancellationToken cancellationToken=default(CancellationToken))
 GetUserData More...
 
static BotData SetConversationData (this IBotState operations, string channelId, string conversationId, BotData botData)
 SetConversationData More...
 
static async Task< BotDataSetConversationDataAsync (this IBotState operations, string channelId, string conversationId, BotData botData, CancellationToken cancellationToken=default(CancellationToken))
 SetConversationData More...
 
static BotData SetPrivateConversationData (this IBotState operations, string channelId, string conversationId, string userId, BotData botData)
 SetPrivateConversationData More...
 
static async Task< BotDataSetPrivateConversationDataAsync (this IBotState operations, string channelId, string conversationId, string userId, BotData botData, CancellationToken cancellationToken=default(CancellationToken))
 SetPrivateConversationData More...
 
static BotData SetUserData (this IBotState operations, string channelId, string userId, BotData botData)
 SetUserData More...
 
static async Task< BotDataSetUserDataAsync (this IBotState operations, string channelId, string userId, BotData botData, CancellationToken cancellationToken=default(CancellationToken))
 SetUserData More...
 

Detailed Description

Extension methods for BotState.

Definition at line 18 of file BotStateExtensions.cs.

Member Function Documentation

static string [] Microsoft.Bot.Connector.BotStateExtensions.DeleteStateForUser ( this IBotState  operations,
string  channelId,
string  userId 
)
inlinestatic

DeleteStateForUser

Delete all data for a user in a channel (UserData and PrivateConversationData)

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
userIdid for the user on the channel

Definition at line 124 of file BotStateExtensions.cs.

static async Task<string[]> Microsoft.Bot.Connector.BotStateExtensions.DeleteStateForUserAsync ( this IBotState  operations,
string  channelId,
string  userId,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

DeleteStateForUser

Delete all data for a user in a channel (UserData and PrivateConversationData)

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
userIdid for the user on the channel
cancellationTokenThe cancellation token.

Definition at line 146 of file BotStateExtensions.cs.

static BotData Microsoft.Bot.Connector.BotStateExtensions.GetConversationData ( this IBotState  operations,
string  channelId,
string  conversationId 
)
inlinestatic

GetConversationData

get the bots data for all users in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdthe channelId
conversationIdThe id for the conversation on the channel

Definition at line 167 of file BotStateExtensions.cs.

static async Task<BotData> Microsoft.Bot.Connector.BotStateExtensions.GetConversationDataAsync ( this IBotState  operations,
string  channelId,
string  conversationId,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

GetConversationData

get the bots data for all users in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdthe channelId
conversationIdThe id for the conversation on the channel
cancellationTokenThe cancellation token.

Definition at line 188 of file BotStateExtensions.cs.

static BotData Microsoft.Bot.Connector.BotStateExtensions.GetPrivateConversationData ( this IBotState  operations,
string  channelId,
string  conversationId,
string  userId 
)
inlinestatic

GetPrivateConversationData

get bot's data for a single user in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
conversationIdThe id for the conversation on the channel
userIdid for the user on the channel

Definition at line 260 of file BotStateExtensions.cs.

static async Task<BotData> Microsoft.Bot.Connector.BotStateExtensions.GetPrivateConversationDataAsync ( this IBotState  operations,
string  channelId,
string  conversationId,
string  userId,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

GetPrivateConversationData

get bot's data for a single user in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
conversationIdThe id for the conversation on the channel
userIdid for the user on the channel
cancellationTokenThe cancellation token.

Definition at line 284 of file BotStateExtensions.cs.

static BotData Microsoft.Bot.Connector.BotStateExtensions.GetUserData ( this IBotState  operations,
string  channelId,
string  userId 
)
inlinestatic

GetUserData

Get a bots data for the user across all conversations

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
userIdid for the user on the channel

Definition at line 33 of file BotStateExtensions.cs.

static async Task<BotData> Microsoft.Bot.Connector.BotStateExtensions.GetUserDataAsync ( this IBotState  operations,
string  channelId,
string  userId,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

GetUserData

Get a bots data for the user across all conversations

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
userIdid for the user on the channel
cancellationTokenThe cancellation token.

Definition at line 54 of file BotStateExtensions.cs.

static BotData Microsoft.Bot.Connector.BotStateExtensions.SetConversationData ( this IBotState  operations,
string  channelId,
string  conversationId,
BotData  botData 
)
inlinestatic

SetConversationData

Update the bot's data for all users in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
conversationIdThe id for the conversation on the channel
botDatathe new botdata

Definition at line 212 of file BotStateExtensions.cs.

static async Task<BotData> Microsoft.Bot.Connector.BotStateExtensions.SetConversationDataAsync ( this IBotState  operations,
string  channelId,
string  conversationId,
BotData  botData,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

SetConversationData

Update the bot's data for all users in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
conversationIdThe id for the conversation on the channel
botDatathe new botdata
cancellationTokenThe cancellation token.

Definition at line 236 of file BotStateExtensions.cs.

static BotData Microsoft.Bot.Connector.BotStateExtensions.SetPrivateConversationData ( this IBotState  operations,
string  channelId,
string  conversationId,
string  userId,
BotData  botData 
)
inlinestatic

SetPrivateConversationData

Update the bot's data for a single user in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
conversationIdThe id for the conversation on the channel
userIdid for the user on the channel
botDatathe new botdata

Definition at line 311 of file BotStateExtensions.cs.

static async Task<BotData> Microsoft.Bot.Connector.BotStateExtensions.SetPrivateConversationDataAsync ( this IBotState  operations,
string  channelId,
string  conversationId,
string  userId,
BotData  botData,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

SetPrivateConversationData

Update the bot's data for a single user in a conversation

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
conversationIdThe id for the conversation on the channel
userIdid for the user on the channel
botDatathe new botdata
cancellationTokenThe cancellation token.

Definition at line 338 of file BotStateExtensions.cs.

static BotData Microsoft.Bot.Connector.BotStateExtensions.SetUserData ( this IBotState  operations,
string  channelId,
string  userId,
BotData  botData 
)
inlinestatic

SetUserData

Update the bot's data for a user

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
userIdid for the user on the channel
botDatathe new botdata

Definition at line 78 of file BotStateExtensions.cs.

static async Task<BotData> Microsoft.Bot.Connector.BotStateExtensions.SetUserDataAsync ( this IBotState  operations,
string  channelId,
string  userId,
BotData  botData,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inlinestatic

SetUserData

Update the bot's data for a user

Parameters
operationsThe operations group for this extension method.
channelIdchannelId
userIdid for the user on the channel
botDatathe new botdata
cancellationTokenThe cancellation token.

Definition at line 102 of file BotStateExtensions.cs.


The documentation for this class was generated from the following file: