Microsoft.Bot.Connector.BotState Class Reference

BotState operations. More...

Inheritance diagram for Microsoft.Bot.Connector.BotState:

Public Member Functions

 BotState (StateClient client)
 Initializes a new instance of the BotState class. More...
 
async Task< HttpOperationResponse< object > > DeleteStateForUserWithHttpMessagesAsync (string channelId, string userId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 DeleteStateForUser More...
 
async Task< HttpOperationResponse< object > > GetConversationDataWithHttpMessagesAsync (string channelId, string conversationId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetConversationData More...
 
async Task< HttpOperationResponse< object > > GetPrivateConversationDataWithHttpMessagesAsync (string channelId, string conversationId, string userId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetPrivateConversationData More...
 
async Task< HttpOperationResponse< object > > GetUserDataWithHttpMessagesAsync (string channelId, string userId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetUserData More...
 
async Task< HttpOperationResponse< object > > SetConversationDataWithHttpMessagesAsync (string channelId, string conversationId, BotData botData, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 SetConversationData More...
 
async Task< HttpOperationResponse< object > > SetPrivateConversationDataWithHttpMessagesAsync (string channelId, string conversationId, string userId, BotData botData, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 SetPrivateConversationData More...
 
async Task< HttpOperationResponse< object > > SetUserDataWithHttpMessagesAsync (string channelId, string userId, BotData botData, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 SetUserData More...
 

Properties

StateClient Client [get]
 Gets a reference to the StateClient More...
 

Detailed Description

BotState operations.

Definition at line 25 of file BotState.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Connector.BotState.BotState ( StateClient  client)
inline

Initializes a new instance of the BotState class.

Parameters
clientReference to the service client.

Definition at line 33 of file BotState.cs.

Member Function Documentation

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.DeleteStateForUserWithHttpMessagesAsync ( string  channelId,
string  userId,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

DeleteStateForUser

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

Parameters
channelIdchannelId
userIdid for the user on the channel
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 507 of file BotState.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.GetConversationDataWithHttpMessagesAsync ( string  channelId,
string  conversationId,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

GetConversationData

get the bots data for all users in a conversation

Parameters
channelIdthe channelId
conversationIdThe id for the conversation on the channel
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 729 of file BotState.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.GetPrivateConversationDataWithHttpMessagesAsync ( string  channelId,
string  conversationId,
string  userId,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

GetPrivateConversationData

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

Parameters
channelIdchannelId
conversationIdThe id for the conversation on the channel
userIdid for the user on the channel
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 1172 of file BotState.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.GetUserDataWithHttpMessagesAsync ( string  channelId,
string  userId,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

GetUserData

Get a bots data for the user across all conversations

Parameters
channelIdchannelId
userIdid for the user on the channel
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 66 of file BotState.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.SetConversationDataWithHttpMessagesAsync ( string  channelId,
string  conversationId,
BotData  botData,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

SetConversationData

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

Parameters
channelIdchannelId
conversationIdThe id for the conversation on the channel
botDatathe new botdata
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 936 of file BotState.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.SetPrivateConversationDataWithHttpMessagesAsync ( string  channelId,
string  conversationId,
string  userId,
BotData  botData,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

SetPrivateConversationData

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

Parameters
channelIdchannelId
conversationIdThe id for the conversation on the channel
userIdid for the user on the channel
botDatathe new botdata
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 1388 of file BotState.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.BotState.SetUserDataWithHttpMessagesAsync ( string  channelId,
string  userId,
BotData  botData,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

SetUserData

Update the bot's data for a user

Parameters
channelIdchannelId
userIdid for the user on the channel
botDatathe new botdata
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IBotState.

Definition at line 273 of file BotState.cs.

Property Documentation

StateClient Microsoft.Bot.Connector.BotState.Client
get

Gets a reference to the StateClient

Definition at line 45 of file BotState.cs.


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