Compartir a través de

ConnectorClientOptions interface

  • Referencia
Paquete:
botframework-connector

Interfaz que representa ConnectorClientOptions.

Extends

ServiceClientOptions

Propiedades

baseUri

(Opcional) baseUri se establecerá automáticamente en BotFrameworkAdapter, pero es necesario si se usa ConnectorClient fuera del adaptador.

Propiedades heredadas

agentSettings

Agentes HTTP y HTTPS que se usarán para cada solicitud HTTP (solo Node.js).
clientRequestIdHeaderName

Si se especifica, se agregará un GenerateRequestIdPolicy a la canalización HTTP que agregará un encabezado a todas las solicitudes salientes con este nombre de encabezado y un UUID aleatorio como identificador de solicitud.
deserializationContentTypes

Los tipos de contenido que se asociarán a la serialización JSON o XML.
generateClientRequestIdHeader

Indica si se va a generar o no un encabezado de identificador de solicitud de cliente para cada solicitud HTTP.
httpClient

HttpClient que se usará para enviar solicitudes HTTP.
httpPipelineLogger

HttpPipelineLogger que se puede usar para depurar RequestPolicies dentro de la canalización HTTP.
noRetryPolicy

Si se establece en true, desactive la directiva de reintento predeterminada.
proxySettings

Configuración de proxy que se usará para cada solicitud HTTP (solo Node.js).
redirectOptions

Opciones para controlar las respuestas de redireccionamiento.
requestPolicyFactories

Matriz de factorías a las que se llama para crear la canalización RequestPolicy utilizada para enviar una solicitud HTTP en la conexión, o una función que toma defaultRequestPolicyFactories y devuelve requestPolicyFactories que se usará.
rpRegistrationRetryTimeout

Obtiene o establece el tiempo de espera de reintento en segundos para AutomaticRPRegistration. El valor predeterminado es 30.
userAgent

Cadena que se va a establecer en el encabezado de telemetría al enviar la solicitud, o una función que toma la cadena de agente de usuario predeterminada y devuelve la cadena user-agent que se usará.
userAgentHeaderName

Nombre de encabezado que se va a usar para el encabezado de telemetría al enviar la solicitud. Si no se especifica, se usará "User-Agent" al ejecutarse en Node.js y se usará "x-ms-command-name" al ejecutarse en un explorador.
withCredentials

Si se deben incluir credenciales en las solicitudes de CORS en el explorador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obtener más información.

Detalles de las propiedades

baseUri

(Opcional) baseUri se establecerá automáticamente en BotFrameworkAdapter, pero es necesario si se usa ConnectorClient fuera del adaptador.

baseUri?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

agentSettings

Agentes HTTP y HTTPS que se usarán para cada solicitud HTTP (solo Node.js).

agentSettings?: AgentSettings

Valor de propiedad

AgentSettings

Heredado de ServiceClientOptions.agentSettings

clientRequestIdHeaderName

Si se especifica, se agregará un GenerateRequestIdPolicy a la canalización HTTP que agregará un encabezado a todas las solicitudes salientes con este nombre de encabezado y un UUID aleatorio como identificador de solicitud.

clientRequestIdHeaderName?: string

Valor de propiedad

string

Heredado de ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Los tipos de contenido que se asociarán a la serialización JSON o XML.

deserializationContentTypes?: DeserializationContentTypes

Valor de propiedad

DeserializationContentTypes

Heredado de ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Indica si se va a generar o no un encabezado de identificador de solicitud de cliente para cada solicitud HTTP.

generateClientRequestIdHeader?: boolean

Valor de propiedad

boolean

Heredado de ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient que se usará para enviar solicitudes HTTP.

httpClient?: HttpClient

Valor de propiedad

HttpClient

Heredado de ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger que se puede usar para depurar RequestPolicies dentro de la canalización HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valor de propiedad

HttpPipelineLogger

Heredado de ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Si se establece en true, desactive la directiva de reintento predeterminada.

noRetryPolicy?: boolean

Valor de propiedad

boolean

Heredado de ServiceClientOptions.noRetryPolicy

proxySettings

Configuración de proxy que se usará para cada solicitud HTTP (solo Node.js).

proxySettings?: ProxySettings

Valor de propiedad

ProxySettings

Heredado de ServiceClientOptions.proxySettings

redirectOptions

Opciones para controlar las respuestas de redireccionamiento.

redirectOptions?: RedirectOptions

Valor de propiedad

RedirectOptions

Heredado de ServiceClientOptions.redirectOptions

requestPolicyFactories

Matriz de factorías a las que se llama para crear la canalización RequestPolicy utilizada para enviar una solicitud HTTP en la conexión, o una función que toma defaultRequestPolicyFactories y devuelve requestPolicyFactories que se usará.

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

Valor de propiedad

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

Heredado de ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Obtiene o establece el tiempo de espera de reintento en segundos para AutomaticRPRegistration. El valor predeterminado es 30.

rpRegistrationRetryTimeout?: number

Valor de propiedad

number

Heredado de ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Cadena que se va a establecer en el encabezado de telemetría al enviar la solicitud, o una función que toma la cadena de agente de usuario predeterminada y devuelve la cadena user-agent que se usará.

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

Valor de propiedad

string | (defaultUserAgent: string) => string

Heredado de ServiceClientOptions.userAgent

userAgentHeaderName

Nombre de encabezado que se va a usar para el encabezado de telemetría al enviar la solicitud. Si no se especifica, se usará "User-Agent" al ejecutarse en Node.js y se usará "x-ms-command-name" al ejecutarse en un explorador.

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

Valor de propiedad

string | (defaultUserAgentHeaderName: string) => string

Heredado de ServiceClientOptions.userAgentHeaderName

withCredentials

Si se deben incluir credenciales en las solicitudes de CORS en el explorador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obtener más información.

withCredentials?: boolean

Valor de propiedad

boolean

Heredado de ServiceClientOptions.withCredentials