TokenApiClientOptions interface

套件:

botframework-connector

Extends

ServiceClientOptions

屬性

baseUri

繼承的屬性

agentSettings	HTTP 和 HTTPS 代理程式，將用於每個 HTTP 要求（僅限Node.js）。
clientRequestIdHeaderName	如果指定，GenerateRequestIdPolicy 將會新增至 HTTP 管線，以將標頭新增至具有此標頭名稱的所有傳出要求，並以隨機 UUID 作為要求標識符。
deserializationContentTypes	將與 JSON 或 XML 串行化相關聯的內容類型。
generateClientRequestIdHeader	是否要為每個 HTTP 要求產生用戶端要求標識碼標頭。
httpClient	將用來傳送 HTTP 要求的 HttpClient。
httpPipelineLogger	HttpPipelineLogger，可用來偵錯 HTTP 管線內的 RequestPolicies。
noRetryPolicy	如果設定為 true，請關閉預設重試原則。
proxySettings	將用於每個 HTTP 要求的 Proxy 設定（僅限Node.js）。
redirectOptions	如何處理重新導向響應的選項。
requestPolicyFactories	呼叫以建立 RequestPolicy 管線的處理站陣列，用來在線路上傳送 HTTP 要求，或採用 defaultRequestPolicyFactories 的函式，並傳回將使用的 requestPolicyFactories。
rpRegistrationRetryTimeout	取得或設定 AutomaticRPRegistration 的重試逾時，以秒為單位。 預設值為 30。
userAgent	傳送要求時要設定為遙測標頭的字串，或接受預設使用者代理程式字串的函式，並傳回將使用的使用者代理程式字串。
userAgentHeaderName	傳送要求時，要用於遙測標頭的標頭名稱。 如果未指定此專案，則在 Node.js 上執行時，將會使用 “User-Agent”，並在瀏覽器中執行時使用 “x-ms-command-name”。
withCredentials	是否要在瀏覽器中的 CORS 要求中包含認證。 如需詳細資訊，請參閱 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials。

屬性詳細資料

baseUri

baseUri?: string

屬性值

string

繼承的屬性詳細資料

agentSettings

HTTP 和 HTTPS 代理程式，將用於每個 HTTP 要求（僅限Node.js）。

agentSettings?: AgentSettings

屬性值

AgentSettings

繼承自 ServiceClientOptions.agentSettings

clientRequestIdHeaderName

如果指定，GenerateRequestIdPolicy 將會新增至 HTTP 管線，以將標頭新增至具有此標頭名稱的所有傳出要求，並以隨機 UUID 作為要求標識符。

clientRequestIdHeaderName?: string

屬性值

string

繼承自 ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

將與 JSON 或 XML 串行化相關聯的內容類型。

deserializationContentTypes?: DeserializationContentTypes

屬性值

DeserializationContentTypes

繼承自 ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

是否要為每個 HTTP 要求產生用戶端要求標識碼標頭。

generateClientRequestIdHeader?: boolean

屬性值

boolean

繼承自 ServiceClientOptions.generateClientRequestIdHeader

httpClient

將用來傳送 HTTP 要求的 HttpClient。

httpClient?: HttpClient

屬性值

HttpClient

繼承自 ServiceClientOptions.HTTPClient

httpPipelineLogger

HttpPipelineLogger，可用來偵錯 HTTP 管線內的 RequestPolicies。

httpPipelineLogger?: HttpPipelineLogger

屬性值

HttpPipelineLogger

繼承自 ServiceClientOptions.HTTPPipelineLogger

noRetryPolicy

如果設定為 true，請關閉預設重試原則。

noRetryPolicy?: boolean

屬性值

boolean

繼承自 ServiceClientOptions.noRetryPolicy

proxySettings

將用於每個 HTTP 要求的 Proxy 設定（僅限Node.js）。

proxySettings?: ProxySettings

屬性值

ProxySettings

繼承自 ServiceClientOptions.proxySettings

redirectOptions

如何處理重新導向響應的選項。

redirectOptions?: RedirectOptions

屬性值

RedirectOptions

繼承自 ServiceClientOptions.redirectOptions

requestPolicyFactories

呼叫以建立 RequestPolicy 管線的處理站陣列，用來在線路上傳送 HTTP 要求，或採用 defaultRequestPolicyFactories 的函式，並傳回將使用的 requestPolicyFactories。

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

屬性值

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

繼承自 ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

取得或設定 AutomaticRPRegistration 的重試逾時，以秒為單位。 預設值為 30。

rpRegistrationRetryTimeout?: number

屬性值

number

繼承自 ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

傳送要求時要設定為遙測標頭的字串，或接受預設使用者代理程式字串的函式，並傳回將使用的使用者代理程式字串。

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

屬性值

string | (defaultUserAgent: string) => string

繼承自 ServiceClientOptions.userAgent

userAgentHeaderName

傳送要求時，要用於遙測標頭的標頭名稱。 如果未指定此專案，則在 Node.js 上執行時，將會使用 “User-Agent”，並在瀏覽器中執行時使用 “x-ms-command-name”。

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

屬性值

string | (defaultUserAgentHeaderName: string) => string

繼承自 ServiceClientOptions.userAgentHeaderName

withCredentials

是否要在瀏覽器中的 CORS 要求中包含認證。 如需詳細資訊，請參閱 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials。

withCredentials?: boolean

屬性值

boolean

繼承自 ServiceClientOptions.withCredentials