ComponentDialog Clase

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

public class ComponentDialog
extends DialogContainer

Un Dialog que se compone de otros diálogos. Un cuadro de diálogo de componente tiene una DialogSet interna y DialogContext , que proporciona una pila de diálogos interna que está oculta del diálogo primario.

Resumen del campo

Modificador y tipo Campo y descripción
static final java.lang.String PERSISTEDDIALOGSTATE

Identificador del estado de diálogo persistente.

Resumen del constructor

Constructor Description
ComponentDialog(String dialogId)

Inicializa una nueva instancia de la clase ComponentDialog.

Resumen del método

Modificador y tipo Método y descripción
ComponentDialog addDialog(Dialog dialog)

Agrega un nuevo Dialog al cuadro de diálogo del componente y devuelve el componente actualizado.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext outerDc, Object options)

Se llama cuando se inicia el cuadro de diálogo e inserta en la pila de diálogos del elemento primario.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext outerDc)

Se llama cuando el cuadro de diálogo es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.
DialogContext createChildContext(DialogContext dc)

Crea un DialogContext interno .
protected java.util.concurrent.CompletableFuture<DialogTurnResult> endComponent(DialogContext outerDc, Object result)

Finaliza el cuadro de diálogo del componente en el contexto de su elemento primario.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo.
protected java.util.concurrent.CompletableFuture<java.lang.Void> ensureInitialized(DialogContext outerDc)

Garantiza que el cuadro de diálogo se inicializa.
java.lang.String getInitialDialogId()

Obtiene el identificador asignado al cuadro de diálogo inicial.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onBeginDialog(DialogContext innerDc, Object options)

Se llama cuando se inicia el cuadro de diálogo e inserta en la pila de diálogos del elemento primario.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onContinueDialog(DialogContext innerDc)

Se llama cuando el cuadro de diálogo es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onEndDialog(TurnContext context, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onInitialize(DialogContext dc)

Initiliza el cuadro de diálogo.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onRepromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext outerDc, DialogReason reason, Object result)

Se llama cuando un cuadro de diálogo secundario de la pila de diálogos del elemento primario completó este turno, devolviendo el control a este componente de diálogo.
void setInitialDialogId(String withInitialDialogId)

Establece el identificador asignado al cuadro de diálogo inicial.

Métodos heredados de Dialog

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

Métodos heredados de DialogContainer

checkForVersionChange createChildContext findDialog getDialogs getInternalVersion onDialogEvent 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 campo

PERSISTEDDIALOGSTATE

public static final String PERSISTEDDIALOGSTATE

Identificador del estado de diálogo persistente.

Detalles del constructor

ComponentDialog

public ComponentDialog(String dialogId)

Inicializa una nueva instancia de la clase ComponentDialog.

Parámetros:

dialogId - D que se va a asignar al nuevo cuadro de diálogo dentro del conjunto de diálogos primario.

Detalles del método

addDialog

public ComponentDialog addDialog(Dialog dialog)

Agrega un nuevo Dialog al cuadro de diálogo del componente y devuelve el componente actualizado.

Parámetros:

dialog - Cuadro de diálogo que se va a agregar.

Devoluciones:

El ComponentDialog una vez completada la operación. 
     The added dialog's <xref uid="com.microsoft.bot.dialogs.Dialog.telemetryClient" data-throw-if-not-resolved="false" data-raw-source="Dialog#telemetryClient"></xref> is set to the
     <xref uid="com.microsoft.bot.dialogs.DialogContainer.telemetryClient" data-throw-if-not-resolved="false" data-raw-source="DialogContainer#telemetryClient"></xref> of the component dialog.

beginDialog

public CompletableFuture beginDialog(DialogContext outerDc, Object options)

Se llama cuando se inicia el cuadro de diálogo e inserta en la pila de diálogos del elemento primario.

Invalidaciones:

ComponentDialog.beginDialog(DialogContext outerDc, Object options)

Parámetros:

outerDc - El DialogContext primario del turno de conversación actual.
options - Opcional, información inicial que se va a pasar al cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext outerDc)

Se llama cuando el cuadro de diálogo es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.

Invalidaciones:

ComponentDialog.continueDialog(DialogContext outerDc)

Parámetros:

outerDc - El DialogContext primario del turno de conversación actual.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value. If this method is *not*
     overridden, the component dialog calls the
     <xref uid="com.microsoft.bot.dialogs.DialogContext.continueDialog*" data-throw-if-not-resolved="false" data-raw-source="DialogContext#continueDialog(CancellationToken)"></xref> method on its
     inner dialog context. If the inner dialog stack is empty, the
     component dialog ends, and if a <xref uid="com.microsoft.bot.dialogs.DialogTurnResult.result" data-throw-if-not-resolved="false" data-raw-source="DialogTurnResult#result"></xref> is
     available, the component dialog uses that as its return value.

createChildContext

public DialogContext createChildContext(DialogContext dc)

Crea un DialogContext interno .

Invalidaciones:

ComponentDialog.createChildContext(DialogContext dc)

Parámetros:

dc - El DialogContext primario .

Devoluciones:

Contexto de diálogo creado.

endComponent

protected CompletableFuture endComponent(DialogContext outerDc, Object result)

Finaliza el cuadro de diálogo del componente en el contexto de su elemento primario.

Parámetros:

outerDc - El DialogContext primario del turno de conversación actual.
result - Opcional, valor que se va a devolver del componente de diálogo al contexto primario.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar. 
     If the task is successful, the result indicates that the dialog ended
     after the turn was processed by the dialog. In general, the parent
     context is the dialog or bot turn handler that started the dialog. If
     the parent is a dialog, the stack calls the parent's
     <xref uid="com.microsoft.bot.dialogs.Dialog.resumeDialog(com.microsoft.bot.dialogs.DialogContext,com.microsoft.bot.dialogs.DialogReason,java.lang.Object)" data-throw-if-not-resolved="false" data-raw-source="Dialog#resumeDialog(DialogContext, DialogReason, Object)"></xref>
     method to return a result to the parent dialog. If the parent dialog
     does not implement `ResumeDialog`, then the parent will end, too, and
     the result is passed to the next parent context, if one exists. The
     returned <xref uid="com.microsoft.bot.dialogs.DialogTurnResult" data-throw-if-not-resolved="false" data-raw-source="DialogTurnResult"></xref> contains the return value in its
     <xref uid="com.microsoft.bot.dialogs.DialogTurnResult.result" data-throw-if-not-resolved="false" data-raw-source="DialogTurnResult#result"></xref> property.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo.

Invalidaciones:

ComponentDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado asociada a la instancia de este cuadro de diálogo de componente en la pila de diálogos de su elemento primario.
reason - Motivo por el que finalizó el cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     When this method is called from the parent dialog's context, the
     component dialog cancels all of the dialogs on its inner dialog stack
     before ending.

ensureInitialized

protected CompletableFuture ensureInitialized(DialogContext outerDc)

Garantiza que el cuadro de diálogo se inicializa.

Parámetros:

outerDc - El DialogContext exterior .

Devoluciones:

Un CompletableFuture que representa la operación hronous.

getInitialDialogId

public String getInitialDialogId()

Obtiene el identificador asignado al cuadro de diálogo inicial.

Devoluciones:

el valor InitialDialogId como una cadena.

onBeginDialog

protected CompletableFuture onBeginDialog(DialogContext innerDc, Object options)

Se llama cuando se inicia el cuadro de diálogo e inserta en la pila de diálogos del elemento primario.

Parámetros:

innerDc - El DialogContext interno del turno actual de conversación.
options - Opcional, información inicial que se va a pasar al cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. By
     default, this calls the
     <xref uid="com.microsoft.bot.dialogs.Dialog.beginDialog(com.microsoft.bot.dialogs.DialogContext,java.lang.Object)" data-throw-if-not-resolved="false" data-raw-source="Dialog#beginDialog(DialogContext, Object)"></xref> method of the
     component dialog's initial dialog, as defined by
     InitialDialogId . Override this method in a derived class to
     implement interrupt logic.

onContinueDialog

protected CompletableFuture onContinueDialog(DialogContext innerDc)

Se llama cuando el cuadro de diálogo es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.

Parámetros:

innerDc - El DialogContext interno del turno actual de conversación.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value. By default, this calls the
     currently active inner dialog's
     <xref uid="com.microsoft.bot.dialogs.Dialog.continueDialog(com.microsoft.bot.dialogs.DialogContext)" data-throw-if-not-resolved="false" data-raw-source="Dialog#continueDialog(DialogContext)"></xref> method. Override this
     method in a derived class to implement interrupt logic.

onEndDialog

protected CompletableFuture onEndDialog(TurnContext context, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo.

Parámetros:

context - Objeto de contexto para este turno.
instance - Información de estado asociada a la pila de diálogos interno de este cuadro de diálogo de componente.
reason - Motivo por el que finalizó el cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     Override this method in a derived class to implement any additional
     logic that should happen at the component level, after all inner
     dialogs have been canceled.

onInitialize

protected CompletableFuture onInitialize(DialogContext dc)

Initiliza el cuadro de diálogo.

Parámetros:

dc - El DialogContext que se va a inicializar.

Devoluciones:

Un CompletableFuture que representa la operación hronous.

onRepromptDialog

protected CompletableFuture onRepromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada.

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado asociada a la pila de diálogos interno de este cuadro de diálogo de componente.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     Override this method in a derived class to implement any additional
     logic that should happen at the component level, after the re-prompt
     operation completes for the inner dialog.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada.

Invalidaciones:

ComponentDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado de este cuadro de diálogo.

Devoluciones:

Un CompletableFuture que representa la operación hronous.

resumeDialog

public CompletableFuture resumeDialog(DialogContext outerDc, DialogReason reason, Object result)

Se llama cuando un cuadro de diálogo secundario de la pila de diálogos del elemento primario completó este turno, devolviendo el control a este componente de diálogo.

Invalidaciones:

ComponentDialog.resumeDialog(DialogContext outerDc, DialogReason reason, Object result)

Parámetros:

outerDc - El DialogContext para el turno actual de conversación.
reason - Motivo por el que se reanudó el cuadro de diálogo.
result - Opcional, el valor devuelto desde el cuadro de diálogo al que se llamó. El tipo del valor devuelto depende del cuadro de diálogo secundario.

Devoluciones:

Un CompletableFuture que representa la operación hronous. 
     If the task is successful, the result indicates whether this dialog
     is still active after this dialog turn has been processed. Generally,
     the child dialog was started with a call to
     BeginDialog(DialogContext, Object) in the parent's context.
     However, if the <xref uid="com.microsoft.bot.dialogs.DialogContext.replaceDialog(java.lang.String,java.lang.Object)" data-throw-if-not-resolved="false" data-raw-source="DialogContext#replaceDialog(String, Object)"></xref>
     method is called, the logical child dialog may be different than the
     original. If this method is *not* overridden, the dialog
     automatically calls its RepromptDialog(TurnContext,
     DialogInstance) when the user replies.

setInitialDialogId

public void setInitialDialogId(String withInitialDialogId)

Establece el identificador asignado al cuadro de diálogo inicial.

Parámetros:

withInitialDialogId - Valor InitialDialogId.

Se aplica a