共用方式為

ParameterizedBotFrameworkAuthentication class

  • 參考
套件:
botframework-connector
Extends
BotFrameworkAuthentication

建構函式

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

方法

authenticateChannelRequest(string)
authenticateRequest(Activity, string)

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

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

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

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

建立適當的 UserTokenClient 實例。
getOriginatingAudience()

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

建構函式詳細資料

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions) 

new ParameterizedBotFrameworkAuthentication(validateAuthority: boolean, toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, toBotFromChannelTokenIssuer: string, oAuthUrl: string, toBotFromChannelOpenIdMetadataUrl: string, toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, credentialsFactory: ServiceClientCredentialsFactory, authConfiguration: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

參數

validateAuthority

boolean

要使用的驗證授權單位值。

toChannelFromBotLoginUrl

string

從 Bot 登入 URL 到通道的 。

toChannelFromBotOAuthScope

string

從 Bot oauth 範圍到通道的 。

toBotFromChannelTokenIssuer

string

從通道令牌簽發者到 Bot 的 。

oAuthUrl

string

OAuth URL。

toBotFromChannelOpenIdMetadataUrl

string

從通道開啟識別元繼資料 URL 到 Bot 的 。

toBotFromEmulatorOpenIdMetadataUrl

string

從模擬器開啟識別元資料 URL 到 Bot 的 。

callerId

string

在已驗證 活動上設定的 callerId。

credentialsFactory
ServiceClientCredentialsFactory

要用來建立認證的 ServiceClientCredentialsFactory。

authConfiguration
AuthenticationConfiguration

要使用的 AuthenticationConfiguration。

botFrameworkClientFetch

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

要用於 BotFrameworkClient 的擷取。

connectorClientOptions
ConnectorClientOptions

ConnectorClientOptions 建立 ConnectorClients 時使用。

方法詳細資料

authenticateChannelRequest(string) 

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

參數

authHeader

string

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

傳回

Promise<ClaimsIdentity>

身分識別驗證結果。

authenticateRequest(Activity, string)

驗證 Bot Framework 通訊協定要求。

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

參數

activity

Activity

輸入活動。

authHeader

string

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

傳回

Promise<AuthenticateRequestResult>

Promise with AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

驗證 Bot Framework 通訊協定要求。

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

參數

authHeader

string

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

channelIdHeader

string

通道標識碼 HTTP 標頭。

傳回

Promise<AuthenticateRequestResult>

Promise with AuthenticateRequestResult.

createBotFrameworkClient()

建立用於呼叫 Skills 的 BotFrameworkClient。

function createBotFrameworkClient(): BotFrameworkClient

傳回

BotFrameworkClient

要呼叫 Skills 的 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>

Promise 搭配 UserTokenClient 實例。

getOriginatingAudience()

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

function getOriginatingAudience(): string

傳回

string

原始物件。