ConnectorClient Class

Reference

Definition

Namespace:: Microsoft.Bot.Connector

Assembly:: Microsoft.Bot.Connector.dll

Package:: Microsoft.Bot.Connector v3.30.0

Package:: Microsoft.Bot.Connector v4.22.7

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Bot Builder for C#
Bot Builder for Node.js
Generate your own from the Connector API Swagger file

public class ConnectorClient : Microsoft.Rest.ServiceClient<Microsoft.Bot.Connector.ConnectorClient>, IDisposable, Microsoft.Bot.Connector.IConnectorClient

type ConnectorClient = class
    inherit ServiceClient<ConnectorClient>
    interface IConnectorClient
    interface IDisposable

Public Class ConnectorClient
Inherits ServiceClient(Of ConnectorClient)
Implements IConnectorClient, IDisposable

Inheritance: Microsoft.Rest.ServiceClient<ConnectorClient>
ConnectorClient

Implements: IConnectorClient IDisposable

Constructors

ConnectorClient(DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(HttpClient, Boolean)	Initializes a new instance of the ConnectorClient class.
ConnectorClient(HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(ServiceClientCredentials, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(ServiceClientCredentials, HttpClient, Boolean)	Initializes a new instance of the ConnectorClient class.
ConnectorClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, MicrosoftAppCredentials, Boolean, DelegatingHandler[])
ConnectorClient(Uri, MicrosoftAppCredentials, Boolean, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, MicrosoftAppCredentials, HttpClient, Boolean, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, MicrosoftAppCredentials, HttpClientHandler, Boolean, DelegatingHandler[])
ConnectorClient(Uri, MicrosoftAppCredentials, HttpClientHandler, Boolean, HttpClient, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, ServiceClientCredentials, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, ServiceClientCredentials, HttpClient, Boolean, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, ServiceClientCredentials, HttpClient, Boolean)	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.
ConnectorClient(Uri, String, String, DelegatingHandler[])	Initializes a new instance of the ConnectorClient class.

Properties

Attachments	Gets the IAttachments.
BaseUri	Gets or sets the base URI of the service.
Conversations	Gets the IConversations.
Credentials	Gets the subscription credentials which uniquely identify client subscription.
DeserializationSettings	Gets the JSON deserialization settings.
SerializationSettings	Gets the JSON serialization settings.

Methods

AddDefaultRequestHeaders(HttpClient)	Configures an HTTP client to include default headers for the Bot Framework.
GetArchitecture()	Gets the platform architecture of the Azure Bot Service.
GetASPNetVersion()	Gets the name of the .NET Framework version of the Azure Bot Service..
GetClientVersion<T>(T)	Gets the assembly version for the Azure Bot Service.
GetOsVersion()	Gets a description of the operating system of the Azure Bot Service.

Applies to

Jaa