IUserTokenProvider interface
警告
现已弃用此 API。
Use UserTokenClient instead.
BotAdapters 的用户界面 OAuth API
方法
| get |
使用令牌服务器注销用户。 |
| get |
从令牌服务器获取一个登录链接，该链接可以作为 SigninCard 的一部分发送。 |
| get |
使用机器人的 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)
使用机器人的 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>