IUserTokenProvider interface

パッケージ:

botbuilder-core

警告

この API は非推奨になりました。

Use UserTokenClient instead.

BotAdapters のユーザー トークン OAuth API のインターフェイス

メソッド

getAadTokens(TurnContext, string, string[])	トークン サーバーを使用してユーザーをサインアウトします。
getSignInLink(TurnContext, string)	SigninCard の一部として送信できるトークン サーバーからサインイン リンクを取得します。
getTokenStatus(TurnContext, string, string, any)	ボットの AppCredentials を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。
getUserToken(TurnContext, string, string)	サインイン フロー内のユーザーの OAuth トークンを取得します。
signOutUser(TurnContext, string, string)	トークン サーバーを使用してユーザーをサインアウトします。

メソッドの詳細

getAadTokens(TurnContext, string, string[])

トークン サーバーを使用してユーザーをサインアウトします。

function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<[key: string]: TokenResponse>

パラメーター

context

TurnContext

ユーザーとの会話の現在のターンのコンテキスト。

connectionName

string

使用する認証接続の名前。

resourceUrls

string[]

戻り値

Promise<[key: string]: TokenResponse>

getSignInLink(TurnContext, string)

SigninCard の一部として送信できるトークン サーバーからサインイン リンクを取得します。

function getSignInLink(context: TurnContext, connectionName: string): Promise<string>

パラメーター

context

TurnContext

ユーザーとの会話の現在のターンのコンテキスト。

connectionName

string

使用する認証接続の名前。

戻り値

Promise<string>

getTokenStatus(TurnContext, string, string, any)

ボットの AppCredentials を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。

function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>

パラメーター

context

TurnContext

ユーザーとの会話の現在のターンのコンテキスト。

userId

string

トークンの状態が取得されるユーザー ID。

includeFilter

string

含める接続のコンマ区切りリスト。 空白にすると、構成されているすべての接続のトークンの状態が返されます。

oAuthAppCredentials

any

OAuth のアプリ資格情報。

戻り値

Promise<any[]>

getUserToken(TurnContext, string, string)

サインイン フロー内のユーザーの OAuth トークンを取得します。

function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>

パラメーター

context

TurnContext

ユーザーとの会話の現在のターンのコンテキスト。

connectionName

string

使用する認証接続の名前。

magicCode

string

(省略可能)検証する省略可能なユーザー入力コード。

戻り値

Promise<TokenResponse>

signOutUser(TurnContext, string, string)

トークン サーバーを使用してユーザーをサインアウトします。

function signOutUser(context: TurnContext, connectionName: string, userId?: string): Promise<void>

パラメーター

context

TurnContext

ユーザーとの会話の現在のターンのコンテキスト。

connectionName

string

使用する認証接続の名前。

userId

string

サインアウトするユーザーのユーザー ID。

戻り値

Promise<void>