BotFrameworkAuthentication class

套件:

botframework-connector

代表用來在此環境中驗證 Bot Framework 通訊協定網路呼叫的雲端環境。

方法

authenticateChannelRequest(string)	驗證技能的 Bot Framework 通訊協定要求。
authenticateRequest(Activity, string)	驗證 Bot Framework 通訊協定要求。
authenticateStreamingRequest(string, string)	驗證 Bot Framework 通訊協定要求。
createBotFrameworkClient()	建立用來呼叫 Skills 的 BotFrameworkClient。
createConnectorFactory(ClaimsIdentity)	建立 ConnectorFactory，可用來建立連接器Clients，以使用來自這個特定雲端環境的認證。
createUserTokenClient(ClaimsIdentity)	建立適當的 UserTokenClient 實例。
getOriginatingAudience()	從 Bot OAuth 範圍取得原始物件。

方法詳細資料

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>

AuthenticationRequestResult。

authenticateStreamingRequest(string, string)

驗證 Bot Framework 通訊協定要求。

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

參數

authHeader

string

HTTP 驗證標頭。

channelIdHeader

string

通道識別碼 HTTP 標頭。

傳回

Promise<AuthenticateRequestResult>

AuthenticationRequestResult。

createBotFrameworkClient()

建立用來呼叫 Skills 的 BotFrameworkClient。

function createBotFrameworkClient(): BotFrameworkClient

傳回

BotFrameworkClient

BotFrameworkClient。

createConnectorFactory(ClaimsIdentity)

建立 ConnectorFactory，可用來建立連接器Clients，以使用來自這個特定雲端環境的認證。

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

原始物件。