UserTokenProvider Interfaccia

  • Riferimento
Pacchetto:
com.microsoft.bot.builder
Artefatto Maven:
com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

Provider OAuth.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata, usando credenzialiapp personalizzate.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando le credenziali personalizzate dell'app.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando le credenziali personalizzate dell'app.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando credenzialiapp personalizzate.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Tenta di recuperare il token per un utente che si trova in un flusso di accesso, usando le credenziali personalizzate dell'app.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, String connectionName, String magicCode)

Tenta di recuperare il token per un utente che si trova in un flusso di accesso.
default java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Disconnette l'utente con il server token.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Disconnette l'utente con il server token, usando credenzialiapp personalizzate.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, String connectionName, String userId)

Disconnette l'utente con il server token.

Dettagli metodo

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente associato al token..
exchangeRequest - Dettagli della richiesta di scambio, un token da scambiare o un URI da scambiare.

Restituisce:

Se CompletableFuture viene completato, viene restituito il token scambiato.

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente associato al token..
exchangeRequest - Dettagli della richiesta di scambio, un token da scambiare o un URI da scambiare.

Restituisce:

Se CompletableFuture viene completato, viene restituito il token scambiato.

getAadTokens

public abstract CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

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

Parametri:

context - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
connectionName - Nome della connessione di Azure Active Directory configurata con questo bot.
resourceUrls - Elenco di URL di risorse per cui recuperare i token.
userId - ID utente per il quale vengono recuperati i token. Se il passaggio di null userId viene tratto dall'attività in TurnContext.

Restituisce:

Dizionario di resourceUrl nell'oggetto TokenResponse corrispondente.

getAadTokens

public default CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di Azure Active Directory configurata con questo bot.
resourceUrls - Elenco di URL di risorse per cui recuperare i token.

Restituisce:

Dizionario di resourceUrl nell'oggetto TokenResponse corrispondente.

getAadTokens

public abstract CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di Azure Active Directory configurata con questo bot.
resourceUrls - Elenco di URL di risorse per cui recuperare i token.
userId - ID utente per il quale vengono recuperati i token. Se il passaggio di null userId viene tratto dall'attività in ITurnContext.

Restituisce:

Dizionario di resourceUrl nell'oggetto TokenResponse corrispondente.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando AppCredentials personalizzato.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
connectionName - Nome della connessione di autenticazione da usare.

Restituisce:

CompletableFuture che rappresenta il lavoro in coda da eseguire. Se CompletableFuture viene completato correttamente, il risultato contiene il collegamento di accesso non elaborato.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando AppCredentials personalizzato.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente che verrà associato al token.
finalRedirect - URL finale a cui verrà reindirizzato il flusso OAuth.

Restituisce:

CompletableFuture che rappresenta il lavoro in coda da eseguire. Se CompletableFuture viene completato correttamente, il risultato contiene il collegamento di accesso non elaborato.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Se l'attività viene completata correttamente, il risultato contiene il collegamento di accesso non elaborato.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente che verrà associato al token.
finalRedirect - URL finale a cui verrà reindirizzato il flusso OAuth.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. Se l'attività viene completata correttamente, il risultato contiene il collegamento di accesso non elaborato.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - Credenziali per OAuth.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente che verrà associato al token.
finalRedirect - URL finale a cui verrà reindirizzato il flusso OAuth.

Restituisce:

CompletableFuture che rappresenta il lavoro in coda da eseguire. Se CompletableFuture viene completato correttamente, il risultato contiene il collegamento di accesso non elaborato.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.

Restituisce:

CompletableFuture che rappresenta il lavoro in coda da eseguire. Se CompletableFuture viene completato correttamente, il risultato contiene il collegamento di accesso non elaborato.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente che verrà associato al token.
finalRedirect - URL finale a cui verrà reindirizzato il flusso OAuth.

Restituisce:

CompletableFuture che rappresenta il lavoro in coda da eseguire. Se CompletableFuture viene completato correttamente, il risultato contiene il collegamento di accesso non elaborato.

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando AppCredentials personalizzato.

Parametri:

context - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
userId - ID utente per il quale viene recuperato lo stato del token.
includeFilter - Elenco delimitato da virgole facoltativo della connessione da includere. Blank restituirà lo stato del token per tutte le connessioni configurate.

Restituisce:

Matrice di TokenStatus.

getTokenStatus

public default CompletableFuture> getTokenStatus(TurnContext turnContext, String userId)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
userId - ID utente per il quale viene recuperato lo stato del token.

Restituisce:

Matrice di TokenStatus.

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
userId - ID utente per il quale viene recuperato lo stato del token.
includeFilter - Elenco delimitato da virgole della connessione da includere. Blank restituirà lo stato del token per tutte le connessioni configurate.

Restituisce:

Matrice di TokenStatus.

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
connectionName - Nome della connessione di autenticazione da usare.
magicCode - (Facoltativo) Codice immesso dall'utente facoltativo da convalidare.

Restituisce:

Risposta del token.

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, String connectionName, String magicCode)

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.
magicCode - (Facoltativo) Codice immesso dall'utente facoltativo da convalidare.

Restituisce:

Risposta del token.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

Disconnette l'utente con il server token.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Disconnette l'utente con il server token usando AppCredentials personalizzato.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
oAuthAppCredentials - AppCredentials per OAuth.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente dell'utente da disconnettere.

Restituisce:

CompletableFuture che rappresenta il lavoro in coda da eseguire.

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, String connectionName, String userId)

Disconnette l'utente con il server token.

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
connectionName - Nome della connessione di autenticazione da usare.
userId - ID utente dell'utente da disconnettere.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire.

Si applica a