DialogContainer Classe

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

public abstract class DialogContainer
extends Dialog

Contenitore per un set di dialoghi.

Riepilogo dei costruttori

Costruttore Descrizione
DialogContainer()

Crea una nuova istanza con l'ID finestra di dialogo predefinito.
DialogContainer(String dialogId)

Crea una nuova istanza con l'ID finestra di dialogo predefinito.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
protected java.util.concurrent.CompletableFuture<java.lang.Void> checkForVersionChange(DialogContext dc)

Verifica se i dialoghi figlio di un contenitore sono stati modificati dopo l'avvio dell'istanza corrente della finestra di dialogo.
abstract DialogContext createChildContext(DialogContext dc)

Crea un contesto di dialogo interno per i contenitori figlio attivi.
Dialog findDialog(String dialogId)

Cerca nella finestra di dialogo correnteImposta una finestra di dialogo in base al relativo ID.
DialogSet getDialogs()

Restituisce i dialoghi come finestra di dialogoset.
protected java.lang.String getInternalVersion()

Restituisce l'identificatore della versione interna per questo contenitore.
java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

Chiamato quando è stato generato un evento, usando 'DialogContext.generareEvent()' dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Imposta botTelemetryClient da usare per la registrazione.

Metodi ereditati da Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId 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 costruttore

DialogContainer

public DialogContainer()

Crea una nuova istanza con l'ID finestra di dialogo predefinito.

DialogContainer

public DialogContainer(String dialogId)

Crea una nuova istanza con l'ID finestra di dialogo predefinito.

Parametri:

dialogId - ID della finestra di dialogo.

Dettagli metodo

checkForVersionChange

protected CompletableFuture checkForVersionChange(DialogContext dc)

Verifica se i dialoghi figlio di un contenitore sono stati modificati dopo l'avvio dell'istanza corrente della finestra di dialogo. Deve essere chiamato all'inizio di 'beginDialog()', 'continueDialog()' e 'resumeDialog()'.

Parametri:

dc - contesto del dialogo

Restituisce:

CompletableFuture

createChildContext

public abstract DialogContext createChildContext(DialogContext dc)

Crea un contesto di dialogo interno per i contenitori figlio attivi.

Parametri:

dc - Contesto del dialogo Padre.

Restituisce:

Nuovo contesto del dialogo per l'elemento figlio attivo.

findDialog

public Dialog findDialog(String dialogId)

Cerca nella finestra di dialogo corrente un dialogo in base al relativo ID.

Parametri:

dialogId - ID della finestra di dialogo da cercare.

Restituisce:

Finestra di dialogo se trovata; in caso contrario Null

getDialogs

public DialogSet getDialogs()

Restituisce i dialoghi come dialogSet.

Restituisce:

Set di dialoghi.

getInternalVersion

protected String getInternalVersion()

Restituisce l'identificatore della versione interna per questo contenitore.

DialogContainers rileva le modifiche di tutti i componenti secondari nel contenitore e ne esegue il mapping a un evento DialogChanged. Poiché lo fanno, DialogContainers "nasconde" le modifiche interne e hanno solo l'ID. In questo modo vengono isolate le modifiche apportate al livello del contenitore, a meno che non venga gestito da un contenitore. Per supportare questo DialogContainers, definire un metodo virtuale protetto getInternalVersion() che calcola se questa finestra di dialogo o i dialoghi figlio sono stati modificati, che vengono quindi esaminati tramite chiamate a checkForVersionChange().

Restituisce:

versione che rappresenta la modifica degli elementi interni di questo contenitore.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

Chiamato quando è stato generato un evento, utilizzando 'DialogContext.emitEvent()', dalla finestra di dialogo corrente o da una finestra di dialogo avviata dalla finestra di dialogo corrente.

L'override traccia le modifiche della versione.

Override:

DialogContainer.onDialogEvent(DialogContext dc, DialogEvent e)

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
e - Evento generato.

Restituisce:

True se l'evento viene gestito dalla finestra di dialogo corrente e il bubbling deve essere arrestato.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Imposta BotTelemetryClient da usare per la registrazione. Quando si imposta questa proprietà, vengono impostate anche tutte le proprietà BotTelemetryClient dei dialoghi contenuti.

Override:

DialogContainer.setTelemetryClient(BotTelemetryClient withTelemetryClient)

Parametri:

withTelemetryClient - BotTelemetryClient da usare per la registrazione.

Si applica a