IUserTokenProvider interface
Avertissement
Cette API est à présent déconseillée.
Use UserTokenClient instead.
Interface pour les API OAuth de jeton utilisateur pour BotAdapters
Méthodes
| get |
Déconnecte l’utilisateur avec le serveur de jetons. |
| get |
Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard. |
| get |
Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide des AppCredentials du bot. |
| get |
Récupère le jeton OAuth pour un utilisateur qui se trouve dans un flux de connexion. |
| sign |
Déconnecte l’utilisateur avec le serveur de jetons. |
Détails de la méthode
getAadTokens(TurnContext, string, string[])
Déconnecte l’utilisateur avec le serveur de jetons.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<[key: string]: TokenResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- resourceUrls
-
string[]
Retours
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string)
Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard.
function getSignInLink(context: TurnContext, connectionName: string): Promise<string>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
Retours
Promise<string>
getTokenStatus(TurnContext, string, string, any)
Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide des AppCredentials du bot.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- userId
-
string
ID d’utilisateur pour lequel l’état du jeton est récupéré.
- includeFilter
-
string
Liste séparée par des virgules des connexions à inclure. Vide retourne l’état du jeton pour toutes les connexions configurées.
- oAuthAppCredentials
-
any
Informations d’identification de l’application pour OAuth.
Retours
Promise<any[]>
getUserToken(TurnContext, string, string)
Récupère le jeton OAuth pour un utilisateur qui se trouve dans un flux de connexion.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- magicCode
-
string
(Facultatif) Un utilisateur facultatif a entré du code pour valider.
Retours
Promise<TokenResponse>
signOutUser(TurnContext, string, string)
Déconnecte l’utilisateur avec le serveur de jetons.
function signOutUser(context: TurnContext, connectionName: string, userId?: string): Promise<void>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- userId
-
string
ID utilisateur de l’utilisateur à déconnecter.
Retours
Promise<void>