RestConnectorClient Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.connector.rest
Artefatto Maven:
com.microsoft.bot:bot-connector:4.14.3

Implementazioni

ConnectorClient

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

L'API REST bot Connector consente al bot di inviare e ricevere messaggi ai canali configurati nel [portale per sviluppatori di Bot Framework](https://dev.botframework.com). Il servizio Connector usa REST e JSON standard del settore su HTTPS. Sono disponibili librerie client per questa API REST. Per un elenco, vedere di seguito. Molti bot useranno sia l'API REST bot Connector che l'API REST [Bot State API](/en-us/restapi/state). L'API REST Bot State consente a un bot di archiviare e recuperare lo stato associato a utenti e conversazioni. L'autenticazione per bot Connector e le API REST bot state viene eseguita con i token di connessione JWT ed è descritta in dettaglio nel documento [Connector Authentication](/en-us/restapi/authentication).

Riepilogo dei costruttori

Costruttore Descrizione
RestConnectorClient(RestClient restClient)

Inizializza un'istanza di Connectorclient.
RestConnectorClient(ServiceClientCredentials credentials)

Inizializza un'istanza di Connectorclient.
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Inizializza un'istanza di Connectorclient.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
java.lang.String baseUrl()

Restituisce l'URL di base per questo connettoreclient.
void close()

Chiusura automaticaelimina.
ServiceClientCredentials credentials()

Restituisce le credenziali in uso.
java.lang.String getAcceptLanguage()

Ottiene la lingua preferita per la risposta.
Attachments getAttachments()

Ottiene l'oggetto Attachments per accedere alle relative operazioni.
Conversations getConversations()

Ottiene l'oggetto Conversations per accedere alle relative operazioni.
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Si tratta di una copia delle operazioni che il client di Azure esegue per creare un client rest.
boolean getGenerateClientRequestId()

Se impostato su true, viene generato un valore x-ms-client-request-id univoco e incluso in ogni richiesta.
int getLongRunningOperationRetryTimeout()

Ottiene il timeout di ripetizione dei tentativi in secondi per le operazioni a esecuzione prolungata.
RestClient getRestClient()

Ottiene il client REST.
RetryStrategy getRestRetryStrategy()

Ottiene la strategia di ripetizione dei tentativi rest.
java.lang.String getUserAgent()

Ottiene l'intestazione User-Agent per il client.
protected void initialize()

Inizializzare l'oggetto dopo la costruzione.
void setAcceptLanguage(String withAcceptLanguage)

Imposta la lingua preferita per la risposta.
void setGenerateClientRequestId(boolean requestId)

Se impostato su true, viene generato un valore x-ms-client-request-id univoco e incluso in ogni richiesta.
void setLongRunningOperationRetryTimeout(int timeout)

Imposta il timeout di ripetizione dei tentativi in secondi per le operazioni con esecuzione prolungata.
void setRestRetryStrategy(RetryStrategy strategy)

Imposta la strategia di ripetizione dei tentativi rest.
java.lang.String userAgent()

Questa operazione consiste nell'eseguire l'override della versione del serviziodi AzureClient.

Metodi ereditati da ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

Metodi ereditati da 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

Dettagli costruttore

RestConnectorClient

public RestConnectorClient(RestClient restClient)

Inizializza un'istanza del client ConnectorClient.

Parametri:

restClient - client REST per connettersi ad Azure.

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

Inizializza un'istanza del client ConnectorClient.

Parametri:

credentials - credenziali di gestione per Azure

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Inizializza un'istanza del client ConnectorClient.

Parametri:

baseUrl - URL di base dell'host
credentials - credenziali di gestione per Azure

Dettagli metodo

baseUrl

public String baseUrl()

Restituisce l'URL di base per questo ConnectorClient.

Restituisce:

URL di base.

close

public void close()

Chiusura automaticadisposibile.

credentials

public ServiceClientCredentials credentials()

Restituisce le credenziali in uso.

Restituisce:

ServiceClientCredentials in uso.

getAcceptLanguage

public String getAcceptLanguage()

Ottiene la lingua preferita per la risposta.

Restituisce:

valore acceptLanguage.

getAttachments

public Attachments getAttachments()

Ottiene l'oggetto Attachments per accedere alle relative operazioni.

Restituisce:

oggetto Attachments.

getConversations

public Conversations getConversations()

Ottiene l'oggetto Conversations per accedere alle relative operazioni.

Restituisce:

oggetto Conversations.

getDefaultRestClientBuilder

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

Si tratta di una copia delle operazioni che il client di Azure esegue per creare un client Rest. Verrà restituito un RestClient.Builder in modo che l'app possa creare un RestClient personalizzato e fornirlo a ConnectorClient durante la costruzione. Un caso d'uso è quello di fornire un proxy a RestClient. Anche se è consigliabile impostare le informazioni sul proxy tramite le proprietà di sistema Java.

Parametri:

baseUrl - Endpoint servizio
credentials - credenziali di autenticazione.

Restituisce:

A RestClient.Builder.

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

Se impostato su true, viene generato un valore x-ms-client-request-id univoco e incluso in ogni richiesta.

Restituisce:

valore generateClientRequestId.

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

Ottiene il timeout di ripetizione dei tentativi in secondi per le operazioni a esecuzione prolungata. Il valore predefinito è 30.

Restituisce:

valore di timeout.

getRestClient

public RestClient getRestClient()

Ottiene il client REST.

Restituisce:

oggetto RestClient.

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Ottiene la strategia di ripetizione dei tentativi rest.

Restituisce:

getUserAgent

public String getUserAgent()

Ottiene l'intestazione User-Agent per il client.

Restituisce:

stringa dell'agente utente.

initialize

protected void initialize()

Inizializzare l'oggetto dopo la costruzione.

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

Imposta la lingua preferita per la risposta.

Parametri:

withAcceptLanguage - valore acceptLanguage.

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

Se impostato su true, viene generato un valore x-ms-client-request-id univoco e incluso in ogni richiesta.

Parametri:

requestId - valore generateClientRequestId.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

Imposta il timeout di ripetizione dei tentativi in secondi per le operazioni con esecuzione prolungata. Il valore predefinito è 30.

Parametri:

timeout - valore longRunningOperationRetryTimeout.

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Imposta la strategia di ripetizione dei tentativi rest.

Parametri:

strategy - RetryStrategy da usare.

userAgent

public String userAgent()

Si tratta di eseguire l'override della versione di AzureServiceClient.

Override:

RestConnectorClient.userAgent()

Restituisce:

Agente utente. Uguale a getUserAgent()

Si applica a