RestConnectorClient Classe

  • Referência
Pacote:
com.microsoft.bot.connector.rest
Artefato Maven:
com.microsoft.bot:bot-connector:4.14.3

Implementações

ConnectorClient

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

A API REST do Conector de Bot permite que o bot envie e receba mensagens para canais configurados no [Portal do Desenvolvedor do Bot Framework](https://dev.botframework.com). O serviço Conector usa REST e JSON padrão do setor por HTTPS. As bibliotecas de cliente para essa API REST estão disponíveis. Veja abaixo uma lista. Muitos bots usarão a API REST do Conector de Bot e a [API REST do Estado do Bot] associada(/en-us/restapi/state). A API REST do Estado do Bot permite que um bot armazene e recupere o estado associado a usuários e conversas. A autenticação para as APIs REST do Bot Connector e do Bot State é realizada com tokens de portador JWT e é descrita em detalhes no documento [Autenticação do Conector](/en-us/restapi/authentication).

Resumo do Construtor

Construtor Description
RestConnectorClient(RestClient restClient)

Inicializa uma instância do conectorcliente cliente.
RestConnectorClient(ServiceClientCredentials credentials)

Inicializa uma instância do conectorcliente cliente.
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Inicializa uma instância do conectorcliente cliente.

Resumo do método

Modificador e tipo Método e descrição
java.lang.String baseUrl()

Retorna a URL base deste ConectorClient.
void close()

Fechamento automáticoDescartável.
ServiceClientCredentials credentials()

Retorna as credenciais em uso.
java.lang.String getAcceptLanguage()

Obtém o idioma preferencial para a resposta..
Attachments getAttachments()

Obtém o objeto Attachments para acessar suas operações.
Conversations getConversations()

Obtém o objeto Conversations para acessar suas operações.
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Essa é uma cópia do que o Cliente do Azure faz para criar um cliente rest.
boolean getGenerateClientRequestId()

Quando definido como true, um valor x-ms-client-request-id exclusivo é gerado e incluído em cada solicitação.
int getLongRunningOperationRetryTimeout()

Obtém o tempo limite de repetição em segundos para operações de execução longa.
RestClient getRestClient()

Obtém o cliente REST.
RetryStrategy getRestRetryStrategy()

Obtém a estratégia de repetição Rest.
java.lang.String getUserAgent()

Obtém o cabeçalho User-Agent para o cliente.
protected void initialize()

Inicialize o objeto após a construção.
void setAcceptLanguage(String withAcceptLanguage)

Define o idioma preferencial para a resposta..
void setGenerateClientRequestId(boolean requestId)

Quando definido como true, um valor x-ms-client-request-id exclusivo é gerado e incluído em cada solicitação.
void setLongRunningOperationRetryTimeout(int timeout)

Define o tempo limite de repetição em segundos para Operações de Execução Longa.
void setRestRetryStrategy(RetryStrategy strategy)

Define a estratégia de repetição Rest.
java.lang.String userAgent()

Isso é para substituir a versão do Cliente do Serviçodo Azure.

Métodos herdados de ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

Métodos herdados de 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

Detalhes do construtor

RestConnectorClient

public RestConnectorClient(RestClient restClient)

Inicializa uma instância do cliente ConnectorClient.

Parâmetros:

restClient - o cliente REST a ser conectado ao Azure.

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

Inicializa uma instância do cliente ConnectorClient.

Parâmetros:

credentials - as credenciais de gerenciamento do Azure

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Inicializa uma instância do cliente ConnectorClient.

Parâmetros:

baseUrl - a URL base do host
credentials - as credenciais de gerenciamento do Azure

Detalhes do método

baseUrl

public String baseUrl()

Retorna a URL base deste ConnectorClient.

Retornos:

A URL base.

close

public void close()

Fechamento autoDisposível.

credentials

public ServiceClientCredentials credentials()

Retorna as credenciais em uso.

Retornos:

Os ServiceClientCredentials em uso.

getAcceptLanguage

public String getAcceptLanguage()

Obtém o idioma preferencial para a resposta..

Retornos:

o valor acceptLanguage.

getAttachments

public Attachments getAttachments()

Obtém o objeto Attachments para acessar suas operações.

Retornos:

o objeto Attachments.

getConversations

public Conversations getConversations()

Obtém o objeto Conversations para acessar suas operações.

Retornos:

o objeto Conversations.

getDefaultRestClientBuilder

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

Esta é uma cópia do que o Cliente do Azure faz para criar um RestClient. Isso retorna um RestClient.Builder para que o aplicativo possa criar um RestClient personalizado e fornecê-lo ao ConnectorClient durante a construção. Um caso de uso disso é para fornecer um Proxy para o RestClient. Embora seja recomendável definir informações de proxy por meio das propriedades do sistema Java.

Parâmetros:

baseUrl - Ponto de extremidade de serviço
credentials - credenciais de autenticação.

Retornos:

Um RestClient.Builder.

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

Quando definido como true, um valor x-ms-client-request-id exclusivo é gerado e incluído em cada solicitação.

Retornos:

o valor generateClientRequestId.

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

Obtém o tempo limite de repetição em segundos para operações de execução longa. O valor padrão é 30.

Retornos:

o valor do tempo limite.

getRestClient

public RestClient getRestClient()

Obtém o cliente REST.

Retornos:

o objeto RestClient.

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Obtém a estratégia de repetição Rest.

Retornos:

O RetryStrategy sendo usado.

getUserAgent

public String getUserAgent()

Obtém o cabeçalho User-Agent para o cliente.

Retornos:

a cadeia de caracteres do agente do usuário.

initialize

protected void initialize()

Inicialize o objeto após a construção.

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

Define o idioma preferencial para a resposta..

Parâmetros:

withAcceptLanguage - o valor acceptLanguage.

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

Quando definido como true, um valor x-ms-client-request-id exclusivo é gerado e incluído em cada solicitação.

Parâmetros:

requestId - o valor generateClientRequestId.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

Define o tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.

Parâmetros:

timeout - o valor longRunningOperationRetryTimeout.

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Define a estratégia de repetição Rest.

Parâmetros:

strategy - O RetryStrategy a ser usado.

userAgent

public String userAgent()

Isso é para substituir a versão do AzureServiceClient.

Substituições:

RestConnectorClient.userAgent()

Retornos:

O agente do usuário. O mesmo que getUserAgent()

Aplica-se a