UserTokenProvider Interfaz

  • Referencia
Paquete:
com.microsoft.bot.builder
Artefacto Maven:
com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

Proveedor de OAuth.

Resumen del método

Modificador y tipo Método y descripción
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Realiza una operación de intercambio de tokens como para el inicio de sesión único.
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Realiza una operación de intercambio de tokens como para el inicio de sesión único.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada mediante credenciales personalizadas de App.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

Obtenga el vínculo de inicio de sesión sin procesar que se va a enviar al usuario para iniciar sesión para un nombre de conexión, mediante credenciales personalizadas de App.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Obtenga el vínculo de inicio de sesión sin procesar que se va a enviar al usuario para iniciar sesión para un nombre de conexión, mediante credenciales personalizadas de App.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante las credenciales personalizadas de App.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId)

Recupera el estado del token para cada conexión configurada para el usuario especificado.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

Recupera el estado del token para cada conexión configurada para el usuario especificado.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión con credenciales de Apppersonalizadas.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, String connectionName, String magicCode)

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión.
default java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Cierra la sesión del usuario con el servidor de tokens.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Cierra la sesión del usuario con el servidor de tokens mediante las credenciales personalizadas de App.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, String connectionName, String userId)

Cierra la sesión del usuario con el servidor de tokens.

Detalles del método

exchangeToken

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

Realiza una operación de intercambio de tokens como para el inicio de sesión único.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario asociado al token.
exchangeRequest - Los detalles de la solicitud de intercambio, ya sea un token para intercambiar o un URI para intercambiar.

Devoluciones:

Si completa CompletableFuture, se devuelve el token intercambiado.

exchangeToken

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

Realiza una operación de intercambio de tokens como para el inicio de sesión único.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario asociado al token.
exchangeRequest - Los detalles de la solicitud de intercambio, ya sea un token para intercambiar o un URI para intercambiar.

Devoluciones:

Si completa CompletableFuture, se devuelve el token intercambiado.

getAadTokens

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

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada mediante AppCredentials personalizados.

Parámetros:

context - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nombre de la conexión de Azure Active Directory configurada con este bot.
resourceUrls - Lista de direcciones URL de recursos para las que se van a recuperar tokens.
userId - Identificador de usuario para el que se recuperan los tokens. Si se pasa null, el userId se toma de la actividad en TurnContext.

Devoluciones:

Diccionario de resourceUrl al tokenResponse correspondiente.

getAadTokens

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

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de Azure Active Directory configurada con este bot.
resourceUrls - Lista de direcciones URL de recursos para las que se van a recuperar tokens.

Devoluciones:

Diccionario de resourceUrl al tokenResponse correspondiente.

getAadTokens

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

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de Azure Active Directory configurada con este bot.
resourceUrls - Lista de direcciones URL de recursos para las que se van a recuperar tokens.
userId - Identificador de usuario para el que se recuperan los tokens. Si se pasa null, el userId se toma de la actividad en ITurnContext.

Devoluciones:

Diccionario de resourceUrl al tokenResponse correspondiente.

getOAuthSignInLink

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

Obtenga el vínculo de inicio de sesión sin formato que se va a enviar al usuario para iniciar sesión para un nombre de conexión mediante AppCredentials personalizado.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nombre de la conexión de autenticación que se va a usar.

Devoluciones:

CompletableFuture que representa el trabajo en cola que se va a ejecutar. Si CompletableFuture se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getOAuthSignInLink

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

Obtenga el vínculo de inicio de sesión sin formato que se va a enviar al usuario para iniciar sesión para un nombre de conexión mediante AppCredentials personalizado.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario que se asociará al token.
finalRedirect - Dirección URL final a la que se redirigirá el flujo de OAuth.

Devoluciones:

CompletableFuture que representa el trabajo en cola que se va a ejecutar. Si CompletableFuture se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Si la tarea se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getOAuthSignInLink

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

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario que se asociará al token.
finalRedirect - Dirección URL final a la que se redirigirá el flujo de OAuth.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. Si la tarea se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getSignInResource

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

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - Credenciales para OAuth.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario que se asociará al token.
finalRedirect - Dirección URL final a la que se redirigirá el flujo de OAuth.

Devoluciones:

CompletableFuture que representa el trabajo en cola que se va a ejecutar. Si CompletableFuture se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.

Devoluciones:

CompletableFuture que representa el trabajo en cola que se va a ejecutar. Si CompletableFuture se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getSignInResource

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

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario que se asociará al token.
finalRedirect - Dirección URL final a la que se redirigirá el flujo de OAuth.

Devoluciones:

CompletableFuture que representa el trabajo en cola que se va a ejecutar. Si CompletableFuture se completa correctamente, el resultado contiene el vínculo de inicio de sesión sin procesar.

getTokenStatus

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

Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante AppCredentials personalizado.

Parámetros:

context - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
userId - Identificador de usuario para el que se recupera el estado del token.
includeFilter - Lista opcional separada por comas de las conexiones que se van a incluir. En blanco se devolverá el estado del token para todas las conexiones configuradas.

Devoluciones:

Matriz de TokenStatus.

getTokenStatus

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

Recupera el estado del token para cada conexión configurada para el usuario especificado.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
userId - Identificador de usuario para el que se recupera el estado del token.

Devoluciones:

Matriz de TokenStatus.

getTokenStatus

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

Recupera el estado del token para cada conexión configurada para el usuario especificado.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
userId - Identificador de usuario para el que se recupera el estado del token.
includeFilter - 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.

Devoluciones:

Matriz de TokenStatus.

getUserToken

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

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión mediante AppCredentials personalizado.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nombre de la conexión de autenticación que se va a usar.
magicCode - (Opcional) El usuario opcional especificó el código para validarlo.

Devoluciones:

Respuesta del token.

getUserToken

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

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.
magicCode - (Opcional) El usuario opcional especificó el código para validarlo.

Devoluciones:

Respuesta del token.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

Cierra la sesión del usuario con el servidor de tokens.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar.

signOutUser

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

Cierra la sesión del usuario con el servidor de tokens mediante AppCredentials personalizado.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario del usuario para cerrar la sesión.

Devoluciones:

CompletableFuture que representa el trabajo en cola que se va a ejecutar.

signOutUser

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

Cierra la sesión del usuario con el servidor de tokens.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
connectionName - Nombre de la conexión de autenticación que se va a usar.
userId - Identificador de usuario del usuario para cerrar la sesión.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar.

Se aplica a