RestConnectorClient Clase

  • Referencia
Paquete:
com.microsoft.bot.connector.rest
Artefacto Maven:
com.microsoft.bot:bot-connector:4.14.3

Implementaciones

ConnectorClient de

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

La API REST de Bot Connector permite al bot enviar y recibir mensajes a canales configurados en el [Portal para desarrolladores de Bot Framework](https://dev.botframework.com). El servicio Connector usa REST estándar del sector y JSON a través de HTTPS. Las bibliotecas cliente de esta API REST están disponibles. Consulte a continuación para obtener una lista. Muchos bots usarán la API rest del conector de bots y la API REST de estado de bot asociada(/en-us/restapi/state). La API REST de estado de bot permite a un bot almacenar y recuperar el estado asociado a usuarios y conversaciones. La autenticación de las API REST bot Connector y Bot State se realiza con tokens de portador JWT y se describe en detalle en el documento [Autenticación del conector](/en-us/restapi/authentication).

Resumen del constructor

Constructor Description
RestConnectorClient(RestClient restClient)

Inicializa una instancia de Connectorcliente.
RestConnectorClient(ServiceClientCredentials credentials)

Inicializa una instancia de Connectorcliente.
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Inicializa una instancia de Connectorcliente.

Resumen del método

Modificador y tipo Método y descripción
java.lang.String baseUrl()

Devuelve la dirección URL base de este conectorClient.
void close()

Cierre automáticodescartable.
ServiceClientCredentials credentials()

Devuelve las credenciales en uso.
java.lang.String getAcceptLanguage()

Obtiene el idioma preferido para la respuesta.
Attachments getAttachments()

Obtiene el objeto Attachments para acceder a sus operaciones.
Conversations getConversations()

Obtiene el objeto Conversations para acceder a sus operaciones.
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Se trata de una copia de lo que hace el cliente de Azure para crear un cliente rest.
boolean getGenerateClientRequestId()

Cuando se establece en true, se genera un valor único x-ms-client-request-id y se incluye en cada solicitud.
int getLongRunningOperationRetryTimeout()

Obtiene el tiempo de espera de reintento en segundos para las operaciones de larga duración.
RestClient getRestClient()

Obtiene el cliente REST.
RetryStrategy getRestRetryStrategy()

Obtiene la estrategia de reintento rest.
java.lang.String getUserAgent()

Obtiene el encabezado User-Agent para el cliente.
protected void initialize()

Inicialice el objeto después de la construcción.
void setAcceptLanguage(String withAcceptLanguage)

Establece el idioma preferido para la respuesta.
void setGenerateClientRequestId(boolean requestId)

Cuando se establece en true, se genera un valor único x-ms-client-request-id y se incluye en cada solicitud.
void setLongRunningOperationRetryTimeout(int timeout)

Establece el tiempo de espera de reintento en segundos para las operaciones de larga duración.
void setRestRetryStrategy(RetryStrategy strategy)

Establece la estrategia de reintento rest.
java.lang.String userAgent()

Esto es para invalidar la versión del cliente de AzureService.

Métodos heredados de ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

Métodos heredados 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

Detalles del constructor

RestConnectorClient

public RestConnectorClient(RestClient restClient)

Inicializa una instancia del cliente ConnectorClient.

Parámetros:

restClient - el cliente REST para conectarse a Azure.

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

Inicializa una instancia del cliente ConnectorClient.

Parámetros:

credentials - las credenciales de administración de Azure

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Inicializa una instancia del cliente ConnectorClient.

Parámetros:

baseUrl - la dirección URL base del host
credentials - las credenciales de administración de Azure

Detalles del método

baseUrl

public String baseUrl()

Devuelve la dirección URL base de este ConnectorClient.

Devoluciones:

Dirección URL base.

close

public void close()

Cierre AutoDisposable.

credentials

public ServiceClientCredentials credentials()

Devuelve las credenciales en uso.

Devoluciones:

ServiceClientCredentials en uso.

getAcceptLanguage

public String getAcceptLanguage()

Obtiene el idioma preferido para la respuesta.

Devoluciones:

el valor acceptLanguage.

getAttachments

public Attachments getAttachments()

Obtiene el objeto Attachments para acceder a sus operaciones.

Devoluciones:

el objeto Attachments.

getConversations

public Conversations getConversations()

Obtiene el objeto Conversations para acceder a sus operaciones.

Devoluciones:

objeto Conversations.

getDefaultRestClientBuilder

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

Se trata de una copia de lo que hace el cliente de Azure para crear un restClient. Esto devuelve un restClient.Builder para que la aplicación pueda crear un RestClient personalizado y proporcionarlo a ConnectorClient durante la construcción. Un caso de uso de esto es para proporcionar un proxy a RestClient. Aunque se recomienda establecer información de proxy a través de las propiedades del sistema Java.

Parámetros:

baseUrl - Punto de conexión de servicio
credentials - credenciales de autenticación.

Devoluciones:

A RestClient.Builder.

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

Cuando se establece en true, se genera un valor único x-ms-client-request-id y se incluye en cada solicitud.

Devoluciones:

el valor generateClientRequestId.

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

Obtiene el tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.

Devoluciones:

el valor de tiempo de espera.

getRestClient

public RestClient getRestClient()

Obtiene el cliente REST.

Devoluciones:

objeto RestClient.

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Obtiene la estrategia de reintento rest.

Devoluciones:

El RetryStrategy que se usa.

getUserAgent

public String getUserAgent()

Obtiene el encabezado User-Agent para el cliente.

Devoluciones:

la cadena del agente de usuario.

initialize

protected void initialize()

Inicialice el objeto después de la construcción.

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

Establece el idioma preferido para la respuesta.

Parámetros:

withAcceptLanguage - el valor acceptLanguage.

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

Cuando se establece en true, se genera un valor único x-ms-client-request-id y se incluye en cada solicitud.

Parámetros:

requestId - el valor generateClientRequestId.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

Establece el tiempo de espera de reintento en segundos para las operaciones de larga duración. El valor predeterminado es 30.

Parámetros:

timeout - el valor longRunningOperationRetryTimeout.

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Establece la estrategia de reintento rest.

Parámetros:

strategy - El RetryStrategy que se va a usar.

userAgent

public String userAgent()

Esto es para invalidar la versión de AzureServiceClient.

Invalidaciones:

RestConnectorClient.userAgent()

Devoluciones:

Agente de usuario. Igual que getUserAgent()

Se aplica a