Microsoft.Bot.Connector.IBotState Interface Reference

BotState operations. More...

Inheritance diagram for Microsoft.Bot.Connector.IBotState:

Public Member Functions

Task< HttpOperationResponse< object > > DeleteStateForUserWithHttpMessagesAsync (string channelId, string userId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 DeleteStateForUser More...
 
Task< HttpOperationResponse< object > > GetConversationDataWithHttpMessagesAsync (string channelId, string conversationId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetConversationData More...
 
Task< HttpOperationResponse< object > > GetPrivateConversationDataWithHttpMessagesAsync (string channelId, string conversationId, string userId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetPrivateConversationData More...
 
Task< HttpOperationResponse< object > > GetUserDataWithHttpMessagesAsync (string channelId, string userId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetUserData More...
 
Task< HttpOperationResponse< object > > SetConversationDataWithHttpMessagesAsync (string channelId, string conversationId, BotData botData, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 SetConversationData More...
 
Task< HttpOperationResponse< object > > SetPrivateConversationDataWithHttpMessagesAsync (string channelId, string conversationId, string userId, BotData botData, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 SetPrivateConversationData More...
 
Task< HttpOperationResponse< object > > SetUserDataWithHttpMessagesAsync (string channelId, string userId, BotData botData, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 SetUserData More...
 

Detailed Description

BotState operations.

Definition at line 18 of file IBotState.cs.

Member Function Documentation

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

DeleteStateForUser

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

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

Implemented in Microsoft.Bot.Connector.BotState.

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

GetConversationData

get the bots data for all users in a conversation

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

Implemented in Microsoft.Bot.Connector.BotState.

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

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
customHeadersThe headers that will be added to request.
cancellationTokenThe cancellation token.

Implemented in Microsoft.Bot.Connector.BotState.

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

GetUserData

Get a bots data for the user across all conversations

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

Implemented in Microsoft.Bot.Connector.BotState.

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

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
customHeadersThe headers that will be added to request.
cancellationTokenThe cancellation token.

Implemented in Microsoft.Bot.Connector.BotState.

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

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
customHeadersThe headers that will be added to request.
cancellationTokenThe cancellation token.

Implemented in Microsoft.Bot.Connector.BotState.

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

SetUserData

Update the bot's data for a user

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

Implemented in Microsoft.Bot.Connector.BotState.


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