UserTokenClientImpl class

  • Riferimento
Pacchetto:
botframework-connector
Extends
UserTokenClient

Costruttori

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

Metodi

exchangeToken(string, string, string, TokenExchangeRequest)

Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
getAadTokens(string, string, string[], string)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata.
getSignInResource(string, Activity, string)

Ottenere in modo asincrono la risorsa di accesso non elaborata da inviare all'utente per l'accesso.
getTokenStatus(string, string, string)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato.
getUserToken(string, string, string, string)

Tenta di recuperare il token per un utente che si trova in un flusso di accesso.
signOutUser(string, string, string)

Disconnette l'utente con il server token.

Dettagli costruttore

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions) 

new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)

Parametri

appId

string

AppId.

credentials

ServiceClientCredentials

AppCredentials per OAuth.

oauthEndpoint

string

Endpoint dell'API OAuth.

connectorClientOptions
ConnectorClientOptions

Oggetto ConnectorClientOptions.

Dettagli metodo

exchangeToken(string, string, string, TokenExchangeRequest)

Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.

function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Parametri

userId

string

ID utente che verrà associato al token.

connectionName

string

Nome della connessione di autenticazione da usare.

channelId

string

ID canale che verrà associato al token.

exchangeRequest

TokenExchangeRequest

Dettagli della richiesta di scambio, un token da scambiare o un URI da scambiare.

Restituisce

Promise<TokenResponse>

Promessa che rappresenta il risultato dell'operazione.

getAadTokens(string, string, string[], string)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata.

function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>

Parametri

userId

string

ID utente che verrà associato al token.

connectionName

string

Nome della connessione di autenticazione da usare.

resourceUrls

string[]

Elenco di URL di risorse per cui recuperare i token.

channelId

string

ID canale che verrà associato al token.

Restituisce

Promise<Record<string, TokenResponse>>

Promessa del dizionario di resourceUrl per il TokenResponse corrispondente.

getSignInResource(string, Activity, string)

Ottenere in modo asincrono la risorsa di accesso non elaborata da inviare all'utente per l'accesso.

function getSignInResource(connectionName: string, activity: Activity, finalRedirect: string): Promise<SignInUrlResponse>

Parametri

connectionName

string

Nome della connessione di autenticazione da usare.

activity

Activity

Attività da cui derivare lo stato di scambio di token.

finalRedirect

string

URL finale a cui verrà reindirizzato il flusso OAuth.

Restituisce

Promise<SignInUrlResponse>

Risorsa signInUrlResponse .

getTokenStatus(string, string, string)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato.

function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>

Parametri

userId

string

ID utente che verrà associato al token.

channelId

string

ID canale che verrà associato al token.

includeFilter

string

IncludeFilter.

Restituisce

Promise<TokenStatus[]>

Promessa con una matrice dello stato del token.

getUserToken(string, string, string, string)

Tenta di recuperare il token per un utente che si trova in un flusso di accesso.

function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>

Parametri

userId

string

ID utente che verrà associato al token.

connectionName

string

Nome della connessione di autenticazione da usare.

channelId

string

ID canale che verrà associato al token.

magicCode

string

(Facoltativo) Codice immesso dall'utente facoltativo da convalidare.

Restituisce

Promise<TokenResponse>

Risposta del token.

signOutUser(string, string, string)

Disconnette l'utente con il server token.

function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>

Parametri

userId

string

ID utente che verrà associato al token.

connectionName

string

Nome della connessione di autenticazione da usare.

channelId

string

ID canale che verrà associato al token.

Restituisce

Promise<void>