RestConnectorClient Classe

  • Référence
Paquet:
com.microsoft.bot.connector.rest
Artefact Maven:
com.microsoft.bot:bot-connector:4.14.3

Implémente

ConnectorClient

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

L’API REST Bot Connector permet à votre bot d’envoyer et de recevoir des messages aux canaux configurés dans le [Portail des développeurs Bot Framework](https://dev.botframework.com). Le service Connecteur utilise rest et JSON standard sur HTTPS. Les bibliothèques clientes pour cette API REST sont disponibles. Voir ci-dessous pour obtenir une liste. De nombreux bots utilisent à la fois l’API REST Bot Connector et l’API REST d’état bot associée(/en-us/restapi/state). L’API REST Bot State permet à un bot de stocker et de récupérer l’état associé aux utilisateurs et aux conversations. L’authentification pour les API REST Bot Connector et Bot State est effectuée avec des jetons du porteur JWT et est décrite en détail dans le document [Authentification du connecteur](/en-us/restapi/authentication).

Récapitulatif du constructeur

Constructeur Description
RestConnectorClient(RestClient restClient)

Initialise une instance de Connectorclient.
RestConnectorClient(ServiceClientCredentials credentials)

Initialise une instance de Connectorclient.
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Initialise une instance de Connectorclient.

Résumé de la méthode

Modificateur et type Méthode et description
java.lang.String baseUrl()

Retourne l’URL de base de ce connecteurclient.
void close()

Fermeture automatiquejetable.
ServiceClientCredentials credentials()

Retourne les informations d’identification en cours d’utilisation.
java.lang.String getAcceptLanguage()

Obtient la langue préférée de la réponse..
Attachments getAttachments()

Obtient l’objet Attachments pour accéder à ses opérations.
Conversations getConversations()

Obtient l’objet Conversations pour accéder à ses opérations.
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Il s’agit d’une copie de ce que fait le client Azure pour créer un client Rest.
boolean getGenerateClientRequestId()

Quand la valeur est true, une valeur x-ms-client-request-id unique est générée et incluse dans chaque requête.
int getLongRunningOperationRetryTimeout()

Obtient le délai d’expiration des nouvelles tentatives en secondes pour les opérations longues.
RestClient getRestClient()

Obtient le client REST.
RetryStrategy getRestRetryStrategy()

Obtient la stratégie de nouvelle tentative Rest.
java.lang.String getUserAgent()

Obtient l’en-tête User-Agent pour le client.
protected void initialize()

Initialisez l’objet après la construction.
void setAcceptLanguage(String withAcceptLanguage)

Définit la langue préférée pour la réponse..
void setGenerateClientRequestId(boolean requestId)

Quand la valeur est true, une valeur x-ms-client-request-id unique est générée et incluse dans chaque requête.
void setLongRunningOperationRetryTimeout(int timeout)

Définit le délai d’expiration des nouvelles tentatives en secondes pour les opérations de longue durée.
void setRestRetryStrategy(RetryStrategy strategy)

Définit la stratégie de nouvelle tentative Rest.
java.lang.String userAgent()

Il s’agit de remplacer la version du service AzureServiceClient.

Méthodes héritées de ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

Méthodes héritées 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

Détails du constructeur

RestConnectorClient

public RestConnectorClient(RestClient restClient)

Initialise une instance du client ConnectorClient.

Paramètres:

restClient - le client REST à connecter à Azure.

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

Initialise une instance du client ConnectorClient.

Paramètres:

credentials - informations d’identification de gestion pour Azure

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Initialise une instance du client ConnectorClient.

Paramètres:

baseUrl - URL de base de l’hôte
credentials - informations d’identification de gestion pour Azure

Détails de la méthode

baseUrl

public String baseUrl()

Retourne l’URL de base de ce ConnectorClient.

Retours:

URL de base.

close

public void close()

Fermeture autodisposable.

credentials

public ServiceClientCredentials credentials()

Retourne les informations d’identification en cours d’utilisation.

Retours:

ServiceClientCredentials en cours d’utilisation.

getAcceptLanguage

public String getAcceptLanguage()

Obtient la langue préférée de la réponse..

Retours:

valeur acceptLanguage.

getAttachments

public Attachments getAttachments()

Obtient l’objet Attachments pour accéder à ses opérations.

Retours:

objet Attachments.

getConversations

public Conversations getConversations()

Obtient l’objet Conversations pour accéder à ses opérations.

Retours:

objet Conversations.

getDefaultRestClientBuilder

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

Il s’agit d’une copie de ce que fait le client Azure pour créer un RestClient. Cela retourne un RestClient.Builder afin que l’application puisse créer un RestClient personnalisé et le fournir à ConnectorClient pendant la construction. L’un des cas d’usage est de fournir un proxy au RestClient. Bien qu’il soit recommandé de définir des informations de proxy via les propriétés système Java.

Paramètres:

baseUrl - Point de terminaison de service
credentials - informations d’identification d’authentification.

Retours:

A RestClient.Builder.

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

Quand la valeur est true, une valeur x-ms-client-request-id unique est générée et incluse dans chaque requête.

Retours:

valeur generateClientRequestId.

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

Obtient le délai d’expiration des nouvelles tentatives en secondes pour les opérations longues. La valeur par défaut est 30.

Retours:

valeur du délai d’expiration.

getRestClient

public RestClient getRestClient()

Obtient le client REST.

Retours:

objet RestClient.

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Obtient la stratégie de nouvelle tentative Rest.

Retours:

La RetryStrategy utilisée.

getUserAgent

public String getUserAgent()

Obtient l’en-tête User-Agent pour le client.

Retours:

chaîne de l’agent utilisateur.

initialize

protected void initialize()

Initialisez l’objet après la construction.

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

Définit la langue préférée pour la réponse..

Paramètres:

withAcceptLanguage - valeur acceptLanguage.

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

Quand la valeur est true, une valeur x-ms-client-request-id unique est générée et incluse dans chaque requête.

Paramètres:

requestId - valeur generateClientRequestId.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

Définit le délai d’expiration des nouvelles tentatives en secondes pour les opérations de longue durée. La valeur par défaut est 30.

Paramètres:

timeout - valeur longRunningOperationRetryTimeout.

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Définit la stratégie de nouvelle tentative Rest.

Paramètres:

strategy - RetryStrategy à utiliser.

userAgent

public String userAgent()

Il s’agit de remplacer la version d’AzureServiceClient.

Remplacements:

RestConnectorClient.userAgent()

Retours:

Agent utilisateur. Identique à getUserAgent()

S’applique à