ConnectorClientOptions interface

Paket:

botframework-connector

Eine Schnittstelle, die ConnectorClientOptions darstellt.

Extends

ServiceClientOptions

Eigenschaften

baseUri

(Optional) baseUri wird in BotFrameworkAdapter automatisch festgelegt, ist jedoch erforderlich, wenn ConnectorClient außerhalb des Adapters verwendet wird.

Geerbte Eigenschaften

agentSettings	HTTP- und HTTPS-Agents, die für jede HTTP-Anforderung verwendet werden (nur Node.js).
clientRequestIdHeaderName	Wenn angegeben, wird der HTTP-Pipeline eine GenerateRequestIdPolicy hinzugefügt, die allen ausgehenden Anforderungen einen Header mit diesem Headernamen und einer zufälligen UUID als Anforderungs-ID hinzufügt.
deserializationContentTypes	Die Inhaltstypen, die der JSON- oder XML-Serialisierung zugeordnet werden.
generateClientRequestIdHeader	Gibt an, ob für jede HTTP-Anforderung ein Clientanforderungs-ID-Header generiert werden soll.
httpClient	Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.
httpPipelineLogger	Der HttpPipelineLogger, der zum Debuggen von RequestPolicies innerhalb der HTTP-Pipeline verwendet werden kann.
noRetryPolicy	Wenn dieser Wert auf TRUE festgelegt ist, deaktivieren Sie die Standardwiebelrichtlinie.
proxySettings	Proxyeinstellungen, die für jede HTTP-Anforderung verwendet werden (nur Node.js).
redirectOptions	Optionen für die Behandlung von Umleitungsantworten.
requestPolicyFactories	Ein Array von Fabriken, die aufgerufen werden, um die RequestPolicy-Pipeline zu erstellen, die zum Senden einer HTTP-Anforderung über die Verbindung verwendet wird, oder eine Funktion, die die defaultRequestPolicyFactories akzeptiert und die verwendeten requestPolicyFactories zurückgibt.
rpRegistrationRetryTimeout	Ruft das Wiederholungstimeout in Sekunden für AutomaticRPRegistration ab oder legt es fest. Standardwert: 30.
userAgent	Die Zeichenfolge, die während des Sendens der Anforderung auf den Telemetrieheader festgelegt werden soll, oder eine Funktion, die die Standardmäßige Benutzer-Agent-Zeichenfolge akzeptiert und die benutzer-agent-Zeichenfolge zurückgibt, die verwendet wird.
userAgentHeaderName	Der Headername, der beim Senden der Anforderung für den Telemetrieheader verwendet werden soll. Wenn dies nicht angegeben ist, wird "User-Agent" verwendet, wenn auf Node.js ausgeführt wird, und "x-ms-command-name" wird verwendet, wenn in einem Browser ausgeführt wird.
withCredentials	Gibt an, ob Anmeldeinformationen in CORS-Anforderungen im Browser eingeschlossen werden sollen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Details zur Eigenschaft

baseUri

(Optional) baseUri wird in BotFrameworkAdapter automatisch festgelegt, ist jedoch erforderlich, wenn ConnectorClient außerhalb des Adapters verwendet wird.

baseUri?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

agentSettings

HTTP- und HTTPS-Agents, die für jede HTTP-Anforderung verwendet werden (nur Node.js).

agentSettings?: AgentSettings

Eigenschaftswert

AgentSettings

Geerbt von ServiceClientOptions.agentSettings

clientRequestIdHeaderName

Wenn angegeben, wird der HTTP-Pipeline eine GenerateRequestIdPolicy hinzugefügt, die allen ausgehenden Anforderungen einen Header mit diesem Headernamen und einer zufälligen UUID als Anforderungs-ID hinzufügt.

clientRequestIdHeaderName?: string

Eigenschaftswert

string

Geerbt von ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Die Inhaltstypen, die der JSON- oder XML-Serialisierung zugeordnet werden.

deserializationContentTypes?: DeserializationContentTypes

Eigenschaftswert

DeserializationContentTypes

Geerbt von ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Gibt an, ob für jede HTTP-Anforderung ein Clientanforderungs-ID-Header generiert werden soll.

generateClientRequestIdHeader?: boolean

Eigenschaftswert

boolean

Geerbt von ServiceClientOptions.generateClientRequestIdHeader

httpClient

Der HttpClient, der zum Senden von HTTP-Anforderungen verwendet wird.

httpClient?: HttpClient

Eigenschaftswert

HttpClient

Geerbt von ServiceClientOptions.httpClient

httpPipelineLogger

Der HttpPipelineLogger, der zum Debuggen von RequestPolicies innerhalb der HTTP-Pipeline verwendet werden kann.

httpPipelineLogger?: HttpPipelineLogger

Eigenschaftswert

HttpPipelineLogger

Geerbt von ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Wenn dieser Wert auf TRUE festgelegt ist, deaktivieren Sie die Standardwiebelrichtlinie.

noRetryPolicy?: boolean

Eigenschaftswert

boolean

Geerbt von ServiceClientOptions.noRetryPolicy

proxySettings

Proxyeinstellungen, die für jede HTTP-Anforderung verwendet werden (nur Node.js).

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

Geerbt von ServiceClientOptions.proxySettings

redirectOptions

Optionen für die Behandlung von Umleitungsantworten.

redirectOptions?: RedirectOptions

Eigenschaftswert

RedirectOptions

Geerbt von ServiceClientOptions.redirectOptions

requestPolicyFactories

Ein Array von Fabriken, die aufgerufen werden, um die RequestPolicy-Pipeline zu erstellen, die zum Senden einer HTTP-Anforderung über die Verbindung verwendet wird, oder eine Funktion, die die defaultRequestPolicyFactories akzeptiert und die verwendeten requestPolicyFactories zurückgibt.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Eigenschaftswert

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Geerbt von ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Ruft das Wiederholungstimeout in Sekunden für AutomaticRPRegistration ab oder legt es fest. Standardwert: 30.

rpRegistrationRetryTimeout?: number

Eigenschaftswert

number

Geerbt von ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Die Zeichenfolge, die während des Sendens der Anforderung auf den Telemetrieheader festgelegt werden soll, oder eine Funktion, die die Standardmäßige Benutzer-Agent-Zeichenfolge akzeptiert und die benutzer-agent-Zeichenfolge zurückgibt, die verwendet wird.

userAgent?: string | (defaultUserAgent: string) => string

Eigenschaftswert

string | (defaultUserAgent: string) => string

Geerbt von ServiceClientOptions.userAgent

userAgentHeaderName

Der Headername, der beim Senden der Anforderung für den Telemetrieheader verwendet werden soll. Wenn dies nicht angegeben ist, wird "User-Agent" verwendet, wenn auf Node.js ausgeführt wird, und "x-ms-command-name" wird verwendet, wenn in einem Browser ausgeführt wird.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

Eigenschaftswert

string | (defaultUserAgentHeaderName: string) => string

Geerbt von ServiceClientOptions.userAgentHeaderName

withCredentials

Gibt an, ob Anmeldeinformationen in CORS-Anforderungen im Browser eingeschlossen werden sollen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Eigenschaftswert

boolean

Geerbt von ServiceClientOptions.withCredentials