IUserTokenProvider interface
Avviso
Questa API è ora deprecata.
Use UserTokenClient
instead.
Interfaccia per le API OAuth dei token utente per BotAdapter
Metodi
get |
Disconnette l'utente con il server token. |
get |
Ottiene un collegamento di accesso dal server token che può essere inviato come parte di signinCard. |
get |
Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando le credenziali app del bot. |
get |
Recupera il token OAuth per un utente che si trova in un flusso di accesso. |
sign |
Disconnette l'utente con il server token. |
Dettagli metodo
getAadTokens(TurnContext, string, string[])
Disconnette l'utente con il server token.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<[key: string]: TokenResponse>
Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- resourceUrls
-
string[]
Restituisce
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string)
Ottiene un collegamento di accesso dal server token che può essere inviato come parte di signinCard.
function getSignInLink(context: TurnContext, connectionName: string): Promise<string>
Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
Restituisce
Promise<string>
getTokenStatus(TurnContext, string, string, any)
Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando le credenziali app del bot.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>
Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- userId
-
string
ID utente per il quale viene recuperato lo stato del token.
- includeFilter
-
string
Elenco delimitato da virgole della connessione da includere. Blank restituirà lo stato del token per tutte le connessioni configurate.
- oAuthAppCredentials
-
any
Credenziali dell'app per OAuth.
Restituisce
Promise<any[]>
getUserToken(TurnContext, string, string)
Recupera il token OAuth per un utente che si trova in un flusso di accesso.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>
Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- magicCode
-
string
(Facoltativo) Codice immesso dall'utente facoltativo da convalidare.
Restituisce
Promise<TokenResponse>
signOutUser(TurnContext, string, string)
Disconnette l'utente con il server token.
function signOutUser(context: TurnContext, connectionName: string, userId?: string): Promise<void>
Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- userId
-
string
ID utente dell'utente da disconnettere.
Restituisce
Promise<void>