Microsoft.Bot.Connector.IStateClient Interface Reference

The Bot State REST API allows your bot to store and retrieve state associated with conversations conducted through the Bot Connector REST API. The Bot State REST API uses REST and HTTPS to send and receive encoded content that your bot controls. More...

Inheritance diagram for Microsoft.Bot.Connector.IStateClient:

Properties

Uri BaseUri [get, set]
 The base URI of the service. More...
 
IBotState BotState [get]
 Gets the IBotState. More...
 
ServiceClientCredentials Credentials [get]
 Subscription credentials which uniquely identify client subscription. More...
 
JsonSerializerSettings DeserializationSettings [get]
 Gets or sets json deserialization settings. More...
 
JsonSerializerSettings SerializationSettings [get]
 Gets or sets json serialization settings. More...
 

Detailed Description

The Bot State REST API allows your bot to store and retrieve state associated with conversations conducted through the Bot Connector REST API. The Bot State REST API uses REST and HTTPS to send and receive encoded content that your bot controls.

Client libraries for this REST API are available. See below for a list.

Your bot may store data for a user, a conversation, or a single user within a conversation (called "private" data). Each payload may be up to 32 kilobytes in size. The data may be removed by the bot or upon a user's request, e.g. if the user requests the channel to inform the bot (and therefore, the Bot Framework) to delete the user's data.

The Bot State REST API is only useful in conjunction with the Bot Connector REST API.

Authentication for both the Bot State and Bot Connector REST APIs is accomplished with JWT Bearer tokens, and is described in detail in the Connector Authentication document.

Client Libraries for the Bot State REST API

© 2016 Microsoft

Definition at line 50 of file IStateClient.cs.

Property Documentation

Uri Microsoft.Bot.Connector.IStateClient.BaseUri
getset

The base URI of the service.

Definition at line 55 of file IStateClient.cs.

IBotState Microsoft.Bot.Connector.IStateClient.BotState
get

Gets the IBotState.

Definition at line 77 of file IStateClient.cs.

ServiceClientCredentials Microsoft.Bot.Connector.IStateClient.Credentials
get

Subscription credentials which uniquely identify client subscription.

Definition at line 71 of file IStateClient.cs.

JsonSerializerSettings Microsoft.Bot.Connector.IStateClient.DeserializationSettings
get

Gets or sets json deserialization settings.

Definition at line 65 of file IStateClient.cs.

JsonSerializerSettings Microsoft.Bot.Connector.IStateClient.SerializationSettings
get

Gets or sets json serialization settings.

Definition at line 60 of file IStateClient.cs.


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