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)

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

ボット ログイン URL からチャネルへの 。

toChannelFromBotOAuthScope

string

ボット oauth スコープからチャネルへの 。

toBotFromChannelTokenIssuer

string

チャネル トークン発行者からボットへの 。

oAuthUrl

string

OAuth URL。

toBotFromChannelOpenIdMetadataUrl

string

Channel Open Id Metadata URL からボットへの 。

toBotFromEmulatorOpenIdMetadataUrl

string

Emulator Open Id Metadata URL からボットへの 。

callerId

string

認証済み アクティビティに設定された callerId。

credentialsFactory
ServiceClientCredentialsFactory

資格情報の作成に使用する ServiceClientCredentialsFactory 。

authConfiguration
AuthenticationConfiguration

使用する AuthenticationConfiguration 。

botFrameworkClientFetch

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

BotFrameworkClient で使用するフェッチ。

connectorClientOptions
ConnectorClientOptions

ConnectorClients の作成時に使用する ConnectorClientOptions。

メソッドの詳細

authenticateChannelRequest(string) 

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

パラメーター

authHeader

string

スキル要求で受信した http 認証ヘッダー。

戻り値

Promise<ClaimsIdentity>

ID 検証の結果。

authenticateRequest(Activity, string)

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

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

パラメーター

activity

Activity

受信アクティビティ。

authHeader

string

スキル要求で受信した http 認証ヘッダー。

戻り値

Promise<AuthenticateRequestResult>

AuthenticateRequestResult を使用した Promise。

authenticateStreamingRequest(string, string)

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

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

パラメーター

authHeader

string

スキル要求で受信した http 認証ヘッダー。

channelIdHeader

string

チャネル ID HTTP ヘッダー。

戻り値

Promise<AuthenticateRequestResult>

AuthenticateRequestResult を使用した Promise。

createBotFrameworkClient()

Skills の呼び出しに使用される BotFrameworkClient を作成します。

function createBotFrameworkClient(): BotFrameworkClient

戻り値

BotFrameworkClient

Skills を呼び出す 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 インスタンスを使用した Promise。

getOriginatingAudience()

Bot OAuth スコープから発信元の対象ユーザーを取得します。

function getOriginatingAudience(): string

戻り値

string

発信元の対象ユーザー。