OAuthPrompt Clase

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

public class OAuthPrompt
extends Dialog

Crea un mensaje que pide al usuario que inicie sesión con el servicio Bot Frameworks Single Sign On (SSO). El mensaje intentará recuperar el token actual de los usuarios y, si el usuario no ha iniciado sesión, le enviará un "OAuthCard" que contiene un botón que puede presionar para iniciar sesión. Según el canal, el usuario se enviará a través de uno de los dos posibles flujos de inicio de sesión: el flujo de inicio de sesión automático donde una vez que el usuario inicia sesión y el servicio SSO reenvía el token de acceso de los usuarios mediante una actividad "event" o "invoke". El flujo de "código mágico" donde una vez que el usuario inicie sesión, el SSOservice le pedirá que envíe al bot un código de seis dígitos que confirme su identidad. Este código se enviará como actividad "message" estándar. Ambos flujos son compatibles automáticamente con las actividades "OAuthPrompt" y lo único que debe tener cuidado es que no se bloquean las actividades "event" e "invoke" en las que el símbolo del sistema podría estar esperando. **Nota**:Debe evitar conservar el token de acceso con otros bots. El servicio Bot FrameworksSSO almacenará de forma segura el token en su nombre. Si lo almacena en el estado de los bots, podría expirar o revocarse entre turnos. Al llamar al símbolo del sistema desde un paso de cascada, debe usar el token dentro del pasofo que permite el aviso y, a continuación, dejar que el token salga del ámbito al final de la función.

Resumen del constructor

Constructor Description
OAuthPrompt(String dialogId, OAuthPromptSettings settings)

Inicializa una nueva instancia de la clase OAuthPrompt.
OAuthPrompt(String dialogId, OAuthPromptSettings settings, PromptValidator<TokenResponse> validator)

Inicializa una nueva instancia de la clase OAuthPrompt.

Resumen del método

Modificador y tipo Método y descripción
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Se llama cuando se inserta un cuadro de diálogo de solicitud en la pila de diálogos y se activa.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad.
java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext)

Intenta obtener el token del usuario.
static java.util.concurrent.CompletableFuture<PromptRecognizerResult<TokenResponse>> recognizeToken(OAuthPromptSettings settings, DialogContext dc)

Implementación compartida de la función RecognizeToken.
static java.util.concurrent.CompletableFuture<java.lang.Void> sendOAuthCard(OAuthPromptSettings settings, TurnContext turnContext, Activity prompt)

Implementación compartida de la función SendOAuthCard.
static void setCallerInfoInDialogState(Map<String,Object> state, TurnContext context)

Implementación compartida de la función SetLlamadorInfoInDialogState.
java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Cierra la sesión del usuario.

Métodos heredados de Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Métodos heredados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalles del constructor

OAuthPrompt

public OAuthPrompt(String dialogId, OAuthPromptSettings settings)

Inicializa una nueva instancia de la clase OAuthPrompt.

Parámetros:

dialogId - D que se va a asignar a este símbolo del sistema.
settings - Configuración adicional de OAuth que se usará con esta instancia del símbolo del sistema. 
              The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

OAuthPrompt

public OAuthPrompt(String dialogId, OAuthPromptSettings settings, PromptValidator validator)

Inicializa una nueva instancia de la clase OAuthPrompt.

Parámetros:

dialogId - D que se va a asignar a este símbolo del sistema.
settings - Configuración adicional de OAuth que se usará con esta instancia del símbolo del sistema.
validator - Opcional, {@link PromptValidator{FoundChoice}} que contiene validación personalizada adicional para este mensaje. 
              The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

Detalles del método

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Se llama cuando se inserta un cuadro de diálogo de solicitud en la pila de diálogos y se activa.

Invalidaciones:

OAuthPrompt.beginDialog(DialogContext dc, Object options)

Parámetros:

dc - Contexto del cuadro de diálogo para el turno actual de la conversación.
options - Opcional, información adicional para pasar al símbolo del sistema que se está iniciando.

Devoluciones:

Un CompletableFuture que representa la operación hronous. Si la tarea se realiza correctamente, el resultado indica si la solicitud sigue activa después de que el aviso haya sido procesado por el aviso.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad.

Invalidaciones:

OAuthPrompt.continueDialog(DialogContext dc)

Parámetros:

dc - Contexto del cuadro de diálogo para el turno actual de conversación.

Devoluciones:

Un CompletableFuture que representa la operación hronous. Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno. Por lo general, la solicitud sigue recibiendo las respuestas del usuario hasta que acepta la respuesta del usuario como entrada válida para el mensaje.

getUserToken

public CompletableFuture getUserToken(TurnContext turnContext)

Intenta obtener el token del usuario.

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. 
     If the task is successful and user already has a token or the user
     successfully signs in, the result contains the user's token.

recognizeToken

public static CompletableFuture> recognizeToken(OAuthPromptSettings settings, DialogContext dc)

Implementación compartida de la función RecognizeToken. Esto está pensado para uso interno, para consolidar la implementación de OAuthPrompt y OAuthInput. La lógica de la aplicación debe usar esas clases de diálogo.

Parámetros:

settings - OAuthPromptSettings.
dc - DialogContext.

Devoluciones:

PromptRecognizerResult.

sendOAuthCard

public static CompletableFuture sendOAuthCard(OAuthPromptSettings settings, TurnContext turnContext, Activity prompt)

Implementación compartida de la función SendOAuthCard. Esto está pensado para uso interno, para consolidar la implementación de OAuthPrompt y OAuthInput. La lógica de la aplicación debe usar esas clases de diálogo.

Parámetros:

settings - OAuthSettings.
turnContext - TurnContext.
prompt - MessageActivity.

Devoluciones:

Un CompletableFuture que representa el resultado de la operación hronous.

setCallerInfoInDialogState

public static void setCallerInfoInDialogState(Map state, TurnContext context)

Implementación compartida de la función SetCallerInfoInDialogState. Esto está pensado para uso interno, para consolidar la implementación de OAuthPrompt y OAuthInput. La lógica de la aplicación debe usar esas clases de diálogo.

Parámetros:

state - Estado del cuadro de diálogo.
context - TurnContext.

signOutUser

public CompletableFuture signOutUser(TurnContext turnContext)

Cierra la sesión del usuario.

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.

Se aplica a