共用方式為

ConfigurationBotFrameworkAuthentication class

  • 參考
套件:
botbuilder-core

使用驗證值或 組態 實例，從物件建立 BotFrameworkAuthentication 實例。

Extends

BotFrameworkAuthentication

建構函式

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

初始化 configurationBotFrameworkAuthentication 類別 的新實例。

方法

authenticateChannelRequest(string)

向技能驗證 Bot Framework 通訊協定要求。
authenticateRequest(Activity, string)

驗證 Bot Framework 通訊協定要求。
authenticateStreamingRequest(string, string)

驗證 Bot Framework 通訊協定要求。
createBotFrameworkClient()

建立用於呼叫 Skills 的 BotFrameworkClient。
createConnectorFactory(ClaimsIdentity)

建立 ConnectorFactory，可用來建立可從這個特定雲端環境使用認證的 ConnectorClients。
createUserTokenClient(ClaimsIdentity)

建立適當的 UserTokenClient 實例。

繼承的方法

getOriginatingAudience()

從 Bot OAuth 範圍取得原始物件。

建構函式詳細資料

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

初始化 configurationBotFrameworkAuthentication 類別 的新實例。

new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

參數

botFrameworkAuthConfig
ConfigurationBotFrameworkAuthenticationOptions

ConfigurationBotFrameworkAuthenticationOptions 物件。

credentialsFactory

ServiceClientCredentialsFactory

ServiceClientCredentialsFactory 實例。

authConfiguration

AuthenticationConfiguration

Configuration 物件。

botFrameworkClientFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

要用於 BotFrameworkClient的自定義 Fetch 實作。

connectorClientOptions

ConnectorClientOptions

ConnectorClientOptions 物件。

方法詳細資料

authenticateChannelRequest(string)

向技能驗證 Bot Framework 通訊協定要求。

function authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>

參數

authHeader

string

技能要求中收到的 HTTP 驗證標頭。

傳回

Promise<ClaimsIdentity>

ClaimsIdentity。

authenticateRequest(Activity, string)

驗證 Bot Framework 通訊協定要求。

function authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>

參數

activity

Activity

輸入活動。

authHeader

string

HTTP 驗證標頭。

傳回

Promise<AuthenticateRequestResult>

AuthenticateRequestResult。

authenticateStreamingRequest(string, string)

驗證 Bot Framework 通訊協定要求。

function authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>

參數

authHeader

string

HTTP 驗證標頭。

channelIdHeader

string

通道標識碼 HTTP 標頭。

傳回

Promise<AuthenticateRequestResult>

AuthenticateRequestResult。

createBotFrameworkClient()

建立用於呼叫 Skills 的 BotFrameworkClient。

function createBotFrameworkClient(): BotFrameworkClient

傳回

BotFrameworkClient

BotFrameworkClient。

createConnectorFactory(ClaimsIdentity)

建立 ConnectorFactory，可用來建立可從這個特定雲端環境使用認證的 ConnectorClients。

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

參數

claimsIdentity

ClaimsIdentity

輸入活動的 ClaimsIdentity。

傳回

ConnectorFactory

ConnectorFactory。

createUserTokenClient(ClaimsIdentity)

建立適當的 UserTokenClient 實例。

function createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>

參數

claimsIdentity

ClaimsIdentity

輸入活動的 ClaimsIdentity。

傳回

Promise<UserTokenClient>

UserTokenClient。

繼承的方法的詳細資料

getOriginatingAudience()

從 Bot OAuth 範圍取得原始物件。

function getOriginatingAudience(): string

傳回

string

原始物件。

繼承自 BotFrameworkAuthentication.getOriginatingAudience