ConfigurationBotFrameworkAuthentication class

パッケージ:

botbuilder-core

認証値または構成インスタンスを持つオブジェクトから BotFrameworkAuthentication インスタンスを作成します。

Extends

BotFrameworkAuthentication

コンストラクター

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

ConfigurationBotFrameworkAuthentication クラスの新しいインスタンスを初期化します。

メソッド

authenticateChannelRequest(string)	Skills に対する 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 スコープから発信元の対象ユーザーを取得します。

コンストラクターの詳細

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 で使用されるカスタムフェッチ実装。

connectorClientOptions

ConnectorClientOptions

ConnectorClientOptions オブジェクト。

メソッドの詳細

authenticateChannelRequest(string)

Skills に対する 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

発信元の対象ユーザー。

継承元 BotFrameworkAuthentication.getOriginatingAudience