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)	この特定のクラウド環境の資格情報を使用できる ConnectorClient を作成するために使用できる ConnectorFactory を作成します。
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>

AuthenticateRequestResult。

authenticateStreamingRequest(string, string)

Bot Framework プロトコル要求を検証します。

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

パラメーター

authHeader

string

HTTP 認証ヘッダー。

channelIdHeader

string

チャネル ID HTTP ヘッダー。

戻り値

Promise<AuthenticateRequestResult>

AuthenticateRequestResult。

createBotFrameworkClient()

Skills を呼び出すための BotFrameworkClient を作成します。

function createBotFrameworkClient(): BotFrameworkClient

戻り値

BotFrameworkClient

BotFrameworkClient。

createConnectorFactory(ClaimsIdentity)

この特定のクラウド環境の資格情報を使用できる ConnectorClient を作成するために使用できる ConnectorFactory を作成します。

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

発信元の対象ユーザー。