RestConnectorClient Класс

  • Ссылка
Пакет:
com.microsoft.bot.connector.rest
Артефакт Maven:
com.microsoft.bot:bot-connector:4.14.3

Реализации

ConnectorClient

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

REST API Bot Connector позволяет боту отправлять и получать сообщения в каналы, настроенные на [портале разработчика Bot Framework](https://dev.botframework.com). Служба соединителя использует стандартный для отрасли REST и JSON по протоколу HTTPS. Доступны клиентские библиотеки для этого REST API. См. ниже список. Многие боты будут использовать REST API Bot Connector и связанный [REST API состояния бота](/en-us/restapi/state). REST API состояния бота позволяет боту хранить и извлекать состояние, связанное с пользователями и беседами. Проверка подлинности для интерфейсов REST API-интерфейсов Bot Connector и Bot State REST выполняется с помощью маркеров носителя JWT и подробно описано в документе [Проверка подлинности соединителя](/en-us/restapi/authentication).

Сводка по конструктору

Конструктор Описание
RestConnectorClient(RestClient restClient)

Инициализирует экземпляр клиента соединителяклиента.
RestConnectorClient(ServiceClientCredentials credentials)

Инициализирует экземпляр клиента соединителяклиента.
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Инициализирует экземпляр клиента соединителяклиента.

Сводка по методу

Модификатор и тип Метод и описание
java.lang.String baseUrl()

Возвращает базовый URL-адрес для этогоклиента соединителя.
void close()

Автоматическое закрытиеудалено.
ServiceClientCredentials credentials()

Возвращает используемые учетные данные.
java.lang.String getAcceptLanguage()

Возвращает предпочтительный язык ответа..
Attachments getAttachments()

Возвращает объект Attachments для доступа к его операциям.
Conversations getConversations()

Возвращает объект Conversations для доступа к его операциям.
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Это копия того, что делает клиент Azure для создания клиента Rest.
boolean getGenerateClientRequestId()

Если задано значение true, создается уникальное значение x-ms-client-request-id и включается в каждый запрос.
int getLongRunningOperationRetryTimeout()

Возвращает время ожидания повтора в секундах для длительных операций.
RestClient getRestClient()

Возвращает клиент REST.
RetryStrategy getRestRetryStrategy()

Возвращает стратегию повторных попыток Rest.
java.lang.String getUserAgent()

Возвращает заголовок User-Agent для клиента.
protected void initialize()

Инициализация объекта после построения.
void setAcceptLanguage(String withAcceptLanguage)

Задает предпочитаемый язык для ответа..
void setGenerateClientRequestId(boolean requestId)

Если задано значение true, создается уникальное значение x-ms-client-request-id и включается в каждый запрос.
void setLongRunningOperationRetryTimeout(int timeout)

Задает время ожидания повтора в секундах для длительных операций.
void setRestRetryStrategy(RetryStrategy strategy)

Задает стратегию повторных попыток Rest.
java.lang.String userAgent()

Это необходимо для переопределения версии клиента службыAzure.

Методы, унаследованные от ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Сведения о конструкторе

RestConnectorClient

public RestConnectorClient(RestClient restClient)

Инициализирует экземпляр клиента ConnectorClient.

Параметры:

restClient - Клиент REST для подключения к Azure.

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

Инициализирует экземпляр клиента ConnectorClient.

Параметры:

credentials - учетные данные управления для Azure

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Инициализирует экземпляр клиента ConnectorClient.

Параметры:

baseUrl - базовый URL-адрес узла
credentials - учетные данные управления для Azure

Сведения о методе

baseUrl

public String baseUrl()

Возвращает базовый URL-адрес для этого connectorClient.

Возвращаемое значение:

Базовый URL-адрес.

close

public void close()

Авторасположенное закрытие.

credentials

public ServiceClientCredentials credentials()

Возвращает используемые учетные данные.

Возвращаемое значение:

Используемые serviceClientCredentials.

getAcceptLanguage

public String getAcceptLanguage()

Возвращает предпочтительный язык ответа..

Возвращаемое значение:

значение acceptLanguage.

getAttachments

public Attachments getAttachments()

Возвращает объект Attachments для доступа к его операциям.

Возвращаемое значение:

Объект Attachments.

getConversations

public Conversations getConversations()

Возвращает объект Conversations для доступа к его операциям.

Возвращаемое значение:

Объект Conversations.

getDefaultRestClientBuilder

public static RestClient.Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Это копия того, что делает клиент Azure для создания RestClient. При этом возвращается RestClient.Builder, чтобы приложение может создать пользовательский RestClient и предоставить его в ConnectorClient во время строительства. Одним из вариантов использования является предоставление прокси-сервера RestClient. Хотя рекомендуется задать сведения о прокси-сервере с помощью системных свойств Java.

Параметры:

baseUrl - Конечная точка службы
credentials - учетные данные проверки подлинности.

Возвращаемое значение:

A RestClient.Builder.

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

Если задано значение true, создается уникальное значение x-ms-client-request-id и включается в каждый запрос.

Возвращаемое значение:

значение generateClientRequestId.

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

Возвращает время ожидания повтора в секундах для длительных операций. Значение по умолчанию — 30.

Возвращаемое значение:

значение времени ожидания.

getRestClient

public RestClient getRestClient()

Возвращает клиент REST.

Возвращаемое значение:

объект RestClient.

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Возвращает стратегию повторных попыток Rest.

Возвращаемое значение:

Используется RetryStrategy.

getUserAgent

public String getUserAgent()

Возвращает заголовок User-Agent для клиента.

Возвращаемое значение:

строка агента пользователя.

initialize

protected void initialize()

Инициализация объекта после построения.

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

Задает предпочитаемый язык для ответа..

Параметры:

withAcceptLanguage - значение acceptLanguage.

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

Если задано значение true, создается уникальное значение x-ms-client-request-id и включается в каждый запрос.

Параметры:

requestId - значение generateClientRequestId.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

Задает время ожидания повтора в секундах для длительных операций. Значение по умолчанию — 30.

Параметры:

timeout - значение longRunningOperationRetryTimeout.

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Задает стратегию повторных попыток Rest.

Параметры:

strategy - Используемый RetryStrategy.

userAgent

public String userAgent()

Это необходимо для переопределения версии AzureServiceClient.

Переопределения:

RestConnectorClient.userAgent()

Возвращаемое значение:

Агент пользователя. То же, что и getUserAgent()

Применяется к