RestConnectorClient Klasse

  • Referenz
Paket:
com.microsoft.bot.connector.rest
Maven-Artefakt:
com.microsoft.bot:bot-connector:4.14.3

Implementiert

ConnectorClient-

public class RestConnectorClient
extends ServiceClient
implements ConnectorClient

Die Bot Connector-REST-API ermöglicht Es Ihrem Bot, Nachrichten an Kanäle zu senden und zu empfangen, die im [Bot Framework Developer Portal](https://dev.botframework.com) konfiguriert sind. Der Connectordienst verwendet BRANCHENstandard-REST und JSON über HTTPS. Clientbibliotheken für diese REST-API sind verfügbar. Eine Liste finden Sie unten. Viele Bots verwenden sowohl die Bot Connector-REST-API als auch die zugeordnete [Bot State REST API](/en-us/restapi/state). Die REST-API des Botstatus ermöglicht es einem Bot, den Status zu speichern und abzurufen, der Benutzern und Unterhaltungen zugeordnet ist. Die Authentifizierung für die Rest-APIs des Bot-Connectors und des Bot-Zustands erfolgt mit JWT Bearer-Token und wird im Dokument [Connector Authentication](/en-us/restapi/authentication) ausführlich beschrieben.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
RestConnectorClient(RestClient restClient)

Initialisiert eine Instanz von ConnectorClientclients.
RestConnectorClient(ServiceClientCredentials credentials)

Initialisiert eine Instanz von ConnectorClientclients.
RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Initialisiert eine Instanz von ConnectorClientclients.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.lang.String baseUrl()

Gibt die Basis-URL für diesen ConnectorClient zurück.
void close()

AutoEinweg schließen.
ServiceClientCredentials credentials()

Gibt die verwendeten Anmeldeinformationen zurück.
java.lang.String getAcceptLanguage()

Ruft die bevorzugte Sprache für die Antwort ab.
Attachments getAttachments()

Ruft das Attachments -Objekt ab, um auf seine Vorgänge zuzugreifen.
Conversations getConversations()

Ruft das Conversations -Objekt ab, um auf seine Vorgänge zuzugreifen.
static Builder getDefaultRestClientBuilder(String baseUrl, ServiceClientCredentials credentials)

Dies ist eine Kopie der Funktion des Azure-Clients zum Erstellen eines Rest--Clients.
boolean getGenerateClientRequestId()

Bei Festlegung auf "true" wird ein eindeutiger x-ms-client-request-id-Wert generiert und in jede Anforderung eingeschlossen.
int getLongRunningOperationRetryTimeout()

Ruft das Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung ab.
RestClient getRestClient()

Ruft den REST-Client ab.
RetryStrategy getRestRetryStrategy()

Ruft die Wiederholungsstrategie "Rest" ab.
java.lang.String getUserAgent()

Ruft den User-Agent Header für den Client ab.
protected void initialize()

Initialisieren Sie das Objekt nach der Konstruktion.
void setAcceptLanguage(String withAcceptLanguage)

Legt die bevorzugte Sprache für die Antwort fest.
void setGenerateClientRequestId(boolean requestId)

Bei Festlegung auf "true" wird ein eindeutiger x-ms-client-request-id-Wert generiert und in jede Anforderung eingeschlossen.
void setLongRunningOperationRetryTimeout(int timeout)

Legt den Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung fest.
void setRestRetryStrategy(RetryStrategy strategy)

Legt die Wiederholungsstrategie "Rest" fest.
java.lang.String userAgent()

Dies ist das Außerkraftsetzen der AzureServiceClientversion.

Geerbte Methoden von ServiceClient

httpClient restClient retrofit serializerAdapter userAgent

Geerbte Methoden von 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

Details zum Konstruktor

RestConnectorClient

public RestConnectorClient(RestClient restClient)

Initialisiert eine Instanz des ConnectorClient-Clients.

Parameter:

restClient - der REST-Client, um eine Verbindung mit Azure herzustellen.

RestConnectorClient

public RestConnectorClient(ServiceClientCredentials credentials)

Initialisiert eine Instanz des ConnectorClient-Clients.

Parameter:

credentials - die Verwaltungsanmeldeinformationen für Azure

RestConnectorClient

public RestConnectorClient(String baseUrl, ServiceClientCredentials credentials)

Initialisiert eine Instanz des ConnectorClient-Clients.

Parameter:

baseUrl - die Basis-URL des Hosts
credentials - die Verwaltungsanmeldeinformationen für Azure

Details zur Methode

baseUrl

public String baseUrl()

Gibt die Basis-URL für diesen ConnectorClient zurück.

Gibt zurück:

Die Basis-URL.

close

public void close()

AutoDisposable close.

credentials

public ServiceClientCredentials credentials()

Gibt die verwendeten Anmeldeinformationen zurück.

Gibt zurück:

Die verwendeten ServiceClientCredentials.

getAcceptLanguage

public String getAcceptLanguage()

Ruft die bevorzugte Sprache für die Antwort ab.

Gibt zurück:

der acceptLanguage-Wert.

getAttachments

public Attachments getAttachments()

Ruft das Attachments -Objekt ab, um auf seine Vorgänge zuzugreifen.

Gibt zurück:

das Attachments-Objekt.

getConversations

public Conversations getConversations()

Ruft das Conversations -Objekt ab, um auf seine Vorgänge zuzugreifen.

Gibt zurück:

das Conversations-Objekt.

getDefaultRestClientBuilder

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

Dies ist eine Kopie der Funktion des Azure-Clients zum Erstellen eines RestClient. Dadurch wird ein RestClient.Builder zurückgegeben, sodass die App während der Konstruktion einen benutzerdefinierten RestClient erstellen und an ConnectorClient bereitstellen kann. Ein Anwendungsfall hierfür ist die Bereitstellung eines Proxys für den RestClient. Es wird jedoch empfohlen, Proxyinformationen über die Java-Systemeigenschaften festzulegen.

Parameter:

baseUrl - Dienstendpunkt
credentials - Authentifizierungsanmeldeinformationen.

Gibt zurück:

Ein RestClient.Builder.

getGenerateClientRequestId

public boolean getGenerateClientRequestId()

Bei Festlegung auf "true" wird ein eindeutiger x-ms-client-request-id-Wert generiert und in jede Anforderung eingeschlossen.

Gibt zurück:

der generateClientRequestId-Wert.

getLongRunningOperationRetryTimeout

public int getLongRunningOperationRetryTimeout()

Ruft das Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung ab. Der Standardwert ist 30.

Gibt zurück:

der Timeoutwert.

getRestClient

public RestClient getRestClient()

Ruft den REST-Client ab.

Gibt zurück:

das RestClient-Objekt.

getRestRetryStrategy

public RetryStrategy getRestRetryStrategy()

Ruft die Wiederholungsstrategie "Rest" ab.

Gibt zurück:

Das verwendete RetryStrategy.

getUserAgent

public String getUserAgent()

Ruft den User-Agent Header für den Client ab.

Gibt zurück:

die Benutzer-Agent-Zeichenfolge.

initialize

protected void initialize()

Initialisieren Sie das Objekt nach der Konstruktion.

setAcceptLanguage

public void setAcceptLanguage(String withAcceptLanguage)

Legt die bevorzugte Sprache für die Antwort fest.

Parameter:

withAcceptLanguage - der acceptLanguage-Wert.

setGenerateClientRequestId

public void setGenerateClientRequestId(boolean requestId)

Bei Festlegung auf "true" wird ein eindeutiger x-ms-client-request-id-Wert generiert und in jede Anforderung eingeschlossen.

Parameter:

requestId - der generateClientRequestId-Wert.

setLongRunningOperationRetryTimeout

public void setLongRunningOperationRetryTimeout(int timeout)

Legt den Wiederholungstimeout in Sekunden für Vorgänge mit langer Ausführung fest. Der Standardwert ist 30.

Parameter:

timeout - der longRunningOperationRetryTimeout-Wert.

setRestRetryStrategy

public void setRestRetryStrategy(RetryStrategy strategy)

Legt die Wiederholungsstrategie "Rest" fest.

Parameter:

strategy - Die zu verwendende RetryStrategy.

userAgent

public String userAgent()

Dies ist das Überschreiben der AzureServiceClient-Version.

Überschreibt:

RestConnectorClient.userAgent()

Gibt zurück:

Der Benutzer-Agent. Identisch mit getUserAgent()

Gilt für: