Microsoft.Bot.Connector.ConnectorClient Class Reference

The Bot Connector REST API allows your bot to send and receive messages to channels configured in the Bot Framework Developer Portal. The Connector service uses industry-standard REST and JSON over HTTPS. More...

Inheritance diagram for Microsoft.Bot.Connector.ConnectorClient:

Public Member Functions

 ConnectorClient (Uri baseUri, string microsoftAppId=null, string microsoftAppPassword=null, params DelegatingHandler[] handlers)
 Create a new instance of the ConnectorClient class More...
 
 ConnectorClient (Uri baseUri, MicrosoftAppCredentials credentials, bool addJwtTokenRefresher=true, params DelegatingHandler[] handlers)
 Create a new instance of the ConnectorClient class More...
 

Protected Member Functions

 ConnectorClient (params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (HttpClientHandler rootHandler, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (Uri baseUri, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (Uri baseUri, HttpClientHandler rootHandler, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (ServiceClientCredentials credentials, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (ServiceClientCredentials credentials, HttpClientHandler rootHandler, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (Uri baseUri, ServiceClientCredentials credentials, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 
 ConnectorClient (Uri baseUri, ServiceClientCredentials credentials, HttpClientHandler rootHandler, params DelegatingHandler[] handlers)
 Initializes a new instance of the ConnectorClient class. More...
 

Properties

virtual IAttachments Attachments [get]
 Gets the IAttachments. More...
 
Uri BaseUri [get, set]
 The base URI of the service. More...
 
virtual IConversations Conversations [get]
 Gets the IConversations. 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 Connector REST API allows your bot to send and receive messages to channels configured in the Bot Framework Developer Portal. The Connector service uses industry-standard REST and JSON over HTTPS.

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

Many bots will use both the Bot Connector REST API and the associated Bot State REST API. The Bot State REST API allows a bot to store and retrieve state associated with users and conversations.

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

Client Libraries for the Bot Connector REST API

© 2016 Microsoft

Definition at line 52 of file ConnectorClient.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( params DelegatingHandler[]  handlers)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 90 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( HttpClientHandler  rootHandler,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
rootHandlerOptional. The http client handler used to handle http transport.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 104 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( Uri  baseUri,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
baseUriOptional. The base URI of the service.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 118 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( Uri  baseUri,
HttpClientHandler  rootHandler,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
baseUriOptional. The base URI of the service.
rootHandlerOptional. The http client handler used to handle http transport.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 139 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( ServiceClientCredentials  credentials,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
credentialsRequired. Subscription credentials which uniquely identify client subscription.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 157 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( ServiceClientCredentials  credentials,
HttpClientHandler  rootHandler,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
credentialsRequired. Subscription credentials which uniquely identify client subscription.
rootHandlerOptional. The http client handler used to handle http transport.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 182 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( Uri  baseUri,
ServiceClientCredentials  credentials,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
baseUriOptional. The base URI of the service.
credentialsRequired. Subscription credentials which uniquely identify client subscription.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 207 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( Uri  baseUri,
ServiceClientCredentials  credentials,
HttpClientHandler  rootHandler,
params DelegatingHandler[]  handlers 
)
inlineprotected

Initializes a new instance of the ConnectorClient class.

Parameters
baseUriOptional. The base URI of the service.
credentialsRequired. Subscription credentials which uniquely identify client subscription.
rootHandlerOptional. The http client handler used to handle http transport.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 240 of file ConnectorClient.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( Uri  baseUri,
string  microsoftAppId = null,
string  microsoftAppPassword = null,
params DelegatingHandler[]  handlers 
)
inline

Create a new instance of the ConnectorClient class

Parameters
baseUriBase URI for the Connector service
microsoftAppIdOptional. Your Microsoft app id. If null, this setting is read from settings["MicrosoftAppId"]
microsoftAppPasswordOptional. Your Microsoft app password. If null, this setting is read from settings["MicrosoftAppPassword"]
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 21 of file ConnectorClientEx.cs.

Microsoft.Bot.Connector.ConnectorClient.ConnectorClient ( Uri  baseUri,
MicrosoftAppCredentials  credentials,
bool  addJwtTokenRefresher = true,
params DelegatingHandler[]  handlers 
)
inline

Create a new instance of the ConnectorClient class

Parameters
baseUriBase URI for the Connector service
credentialsCredentials for the Connector service
addJwtTokenRefresherTrue, if JwtTokenRefresher should be included; False otherwise.
handlersOptional. The delegating handlers to add to the http client pipeline.

Definition at line 33 of file ConnectorClientEx.cs.

Property Documentation

virtual IAttachments Microsoft.Bot.Connector.ConnectorClient.Attachments
get

Gets the IAttachments.

Definition at line 77 of file ConnectorClient.cs.

Uri Microsoft.Bot.Connector.ConnectorClient.BaseUri
getset

The base URI of the service.

Definition at line 57 of file ConnectorClient.cs.

virtual IConversations Microsoft.Bot.Connector.ConnectorClient.Conversations
get

Gets the IConversations.

Definition at line 82 of file ConnectorClient.cs.

ServiceClientCredentials Microsoft.Bot.Connector.ConnectorClient.Credentials
get

Subscription credentials which uniquely identify client subscription.

Definition at line 72 of file ConnectorClient.cs.

JsonSerializerSettings Microsoft.Bot.Connector.ConnectorClient.DeserializationSettings
get

Gets or sets json deserialization settings.

Definition at line 67 of file ConnectorClient.cs.

JsonSerializerSettings Microsoft.Bot.Connector.ConnectorClient.SerializationSettings
get

Gets or sets json serialization settings.

Definition at line 62 of file ConnectorClient.cs.


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