IUserTokenProvider interface
Advertencia
Esta API ya está en desuso.
Use UserTokenClient instead.
Interfaz para las API de OAuth de token de usuario para BotAdapters
Métodos
| get |
Cierra la sesión del usuario con el servidor de tokens. |
| get |
Obtiene un vínculo de inicio de sesión del servidor de tokens que se puede enviar como parte de un SigninCard. |
| get |
Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante appCredentials del bot. |
| get |
Recupera el token de OAuth para un usuario que está en un flujo de inicio de sesión. |
| sign |
Cierra la sesión del usuario con el servidor de tokens. |
Detalles del método
getAadTokens(TurnContext, string, string[])
Cierra la sesión del usuario con el servidor de tokens.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<[key: string]: TokenResponse>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- connectionName
-
string
Nombre de la conexión de autenticación que se va a usar.
- resourceUrls
-
string[]
Devoluciones
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string)
Obtiene un vínculo de inicio de sesión del servidor de tokens que se puede enviar como parte de un SigninCard.
function getSignInLink(context: TurnContext, connectionName: string): Promise<string>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- connectionName
-
string
Nombre de la conexión de autenticación que se va a usar.
Devoluciones
Promise<string>
getTokenStatus(TurnContext, string, string, any)
Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante appCredentials del bot.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- userId
-
string
Identificador de usuario para el que se recupera el estado del token.
- includeFilter
-
string
Lista separada por comas de las conexiones que se van a incluir. En blanco se devolverá el estado del token para todas las conexiones configuradas.
- oAuthAppCredentials
-
any
Credenciales de aplicación para OAuth.
Devoluciones
Promise<any[]>
getUserToken(TurnContext, string, string)
Recupera el token de OAuth para un usuario que está en un flujo de inicio de sesión.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- connectionName
-
string
Nombre de la conexión de autenticación que se va a usar.
- magicCode
-
string
(Opcional) El usuario opcional especificó el código para validarlo.
Devoluciones
Promise<TokenResponse>
signOutUser(TurnContext, string, string)
Cierra la sesión del usuario con el servidor de tokens.
function signOutUser(context: TurnContext, connectionName: string, userId?: string): Promise<void>Parámetros
- context
- TurnContext
Contexto para el turno actual de conversación con el usuario.
- connectionName
-
string
Nombre de la conexión de autenticación que se va a usar.
- userId
-
string
Identificador de usuario del usuario para cerrar la sesión.
Devoluciones
Promise<void>