IUserTokenProvider interface
警告
此 API 現已淘汰。
Use UserTokenClient instead.
適用於 BotAdapters 的使用者令牌 OAuth API 介面
方法
| get |
使用令牌伺服器將用戶註銷。 |
| get |
從令牌伺服器取得可傳送為 SigninCard 一部分的登入連結。 |
| get |
使用 Bot 的 AppCredentials，擷取指定使用者每個已設定連線的令牌狀態。 |
| get |
擷取登入流程中之使用者的 OAuth 令牌。 |
| sign |
使用令牌伺服器將用戶註銷。 |
方法詳細資料
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)
使用 Bot 的 AppCredentials，擷取指定使用者每個已設定連線的令牌狀態。
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>參數
- context
- TurnContext
目前與使用者交談回合的內容。
- userId
-
string
擷取令牌狀態的使用者標識碼。
- 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
要註銷的使用者標識碼。
傳回
Promise<void>