ComponentDialog Classe

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

public class ComponentDialog
extends DialogContainer

Un Dialog composto da altri dialoghi. Un dialogo componente include un DialogSet interno e DialogContext , che fornisce uno stack di dialoghi interno nascosto dal dialogo padre.

Riepilogo dei campi

Modificatore e tipo Campo e descrizione
static final java.lang.String PERSISTEDDIALOGSTATE

ID per lo stato del dialogo persistente.

Riepilogo dei costruttori

Costruttore Descrizione
ComponentDialog(String dialogId)

Inizializza una nuova istanza della classe ComponentDialog.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
ComponentDialog addDialog(Dialog dialog)

Aggiunge un nuovo Dialog alla finestra di dialogo del componente e restituisce il componente aggiornato.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext outerDc, Object options)

Viene chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi dell'elemento padre.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext outerDc)

Viene chiamato quando il dialogo è _continue_, dove è il dialogo attivo e l'utente risponde con una nuova attività.
DialogContext createChildContext(DialogContext dc)

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

Termina la finestra di dialogo del componente nel contesto del padre.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Chiamato quando termina il dialogo.
protected java.util.concurrent.CompletableFuture<java.lang.Void> ensureInitialized(DialogContext outerDc)

Assicura che il dialogo venga inizializzato.
java.lang.String getInitialDialogId()

Ottiene l'ID assegnato alla finestra di dialogo iniziale.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onBeginDialog(DialogContext innerDc, Object options)

Viene chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi dell'elemento padre.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onContinueDialog(DialogContext innerDc)

Viene chiamato quando il dialogo è _continue_, dove è il dialogo attivo e l'utente risponde con una nuova attività.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onEndDialog(TurnContext context, DialogInstance instance, DialogReason reason)

Chiamato quando termina il dialogo.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onInitialize(DialogContext dc)

Inizia a inizializzare il dialogo.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onRepromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando la finestra di dialogo deve richiedere di nuovo l'input all'utente.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando la finestra di dialogo deve richiedere di nuovo l'input all'utente.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext outerDc, DialogReason reason, Object result)

Chiamato quando un dialogo figlio nello stack di dialoghi padre ha completato questo turno, restituendo il controllo a questo componente della finestra di dialogo.
void setInitialDialogId(String withInitialDialogId)

Imposta l'ID assegnato alla finestra di dialogo iniziale.

Metodi ereditati da Dialog

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

Metodi ereditati da DialogContainer

checkForVersionChange createChildContext findDialog getDialogs getInternalVersion onDialogEvent setTelemetryClient

Metodi ereditati da 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

Dettagli del campo

PERSISTEDDIALOGSTATE

public static final String PERSISTEDDIALOGSTATE

ID per lo stato del dialogo persistente.

Dettagli costruttore

ComponentDialog

public ComponentDialog(String dialogId)

Inizializza una nuova istanza della classe ComponentDialog.

Parametri:

dialogId - D da assegnare al nuovo dialogo all'interno del set di dialoghi padre.

Dettagli metodo

addDialog

public ComponentDialog addDialog(Dialog dialog)

Aggiunge un nuovo Dialog alla finestra di dialogo del componente e restituisce il componente aggiornato.

Parametri:

dialog - Finestra di dialogo da aggiungere.

Restituisce:

Il ComponentDialog dopo il completamento dell'operazione. 
     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)

Viene chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi dell'elemento padre.

Override:

ComponentDialog.beginDialog(DialogContext outerDc, Object options)

Parametri:

outerDc - Il DialogContext padre per il turno di conversazione corrente.
options - Informazioni iniziali facoltative da passare alla finestra di dialogo.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Viene chiamato quando il dialogo è _continue_, dove è il dialogo attivo e l'utente risponde con una nuova attività.

Override:

ComponentDialog.continueDialog(DialogContext outerDc)

Parametri:

outerDc - Il DialogContext padre per il turno di conversazione corrente.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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.

Override:

ComponentDialog.createChildContext(DialogContext dc)

Parametri:

dc - Oggetto padre DialogContext .

Restituisce:

Contesto del dialogo creato.

endComponent

protected CompletableFuture endComponent(DialogContext outerDc, Object result)

Termina la finestra di dialogo del componente nel contesto del padre.

Parametri:

outerDc - Il DialogContext padre per il turno di conversazione corrente.
result - Facoltativo, valore da restituire dal componente del dialogo al contesto padre.

Restituisce:

Attività che rappresenta il lavoro in coda da eseguire. 
     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)

Chiamato quando termina il dialogo.

Override:

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

Parametri:

turnContext - Oggetto di contesto per questo turno.
instance - Informazioni sullo stato associate all'istanza di questa finestra di dialogo del componente nello stack di dialoghi padre.
reason - Motivo per cui il dialogo è terminato.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Assicura che il dialogo venga inizializzato.

Parametri:

outerDc - Oggetto esterno DialogContext .

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione hronous.

getInitialDialogId

public String getInitialDialogId()

Ottiene l'ID assegnato alla finestra di dialogo iniziale.

Restituisce:

Valore InitialDialogId come stringa.

onBeginDialog

protected CompletableFuture onBeginDialog(DialogContext innerDc, Object options)

Viene chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi dell'elemento padre.

Parametri:

innerDc - Il DialogContext interno per il turno corrente della conversazione.
options - Informazioni iniziali facoltative da passare alla finestra di dialogo.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Viene chiamato quando il dialogo è _continue_, dove è il dialogo attivo e l'utente risponde con una nuova attività.

Parametri:

innerDc - Il DialogContext interno per il turno corrente della conversazione.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Chiamato quando termina il dialogo.

Parametri:

context - Oggetto di contesto per questo turno.
instance - Informazioni sullo stato associate allo stack di dialoghi interno di questo dialogo componente.
reason - Motivo per cui il dialogo è terminato.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Inizia a inizializzare il dialogo.

Parametri:

dc - DialogContext da inizializzare.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione hronous.

onRepromptDialog

protected CompletableFuture onRepromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando la finestra di dialogo deve richiedere di nuovo l'input all'utente.

Parametri:

turnContext - Oggetto di contesto per questo turno.
instance - Informazioni sullo stato associate allo stack di dialoghi interno di questo dialogo componente.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Chiamato quando la finestra di dialogo deve richiedere di nuovo l'input all'utente.

Override:

ComponentDialog.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parametri:

turnContext - Oggetto di contesto per questo turno.
instance - Informazioni sullo stato per questa finestra di dialogo.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione hronous.

resumeDialog

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

Chiamato quando un dialogo figlio nello stack di dialoghi padre ha completato questo turno, restituendo il controllo a questo componente della finestra di dialogo.

Override:

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

Parametri:

outerDc - Il DialogContext per il turno di conversazione corrente.
reason - Motivo per cui il dialogo è stato ripreso.
result - Valore facoltativo restituito dalla finestra di dialogo chiamata. Il tipo del valore restituito dipende dal dialogo figlio.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione 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)

Imposta l'ID assegnato alla finestra di dialogo iniziale.

Parametri:

withInitialDialogId - Valore InitialDialogId.

Si applica a