Dialog Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.dialogs
Artefatto Maven:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.Dialog

public abstract class Dialog

Classe di base per tutti i dialoghi.

Riepilogo dei campi

Modificatore e tipo Campo e descrizione
static final DialogTurnResult END_OF_TURN

Un DialogTurnResult che indica che la finestra di dialogo corrente è ancora attiva e in attesa dell'input dal turno successivo dell'utente.

Riepilogo dei costruttori

Costruttore Descrizione
Dialog(String dialogId)

Inizializza una nuova istanza della classe Dialog.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc)

Chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi.
abstract java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

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

Chiamato quando termina il dialogo.
java.lang.String getId()

Ottiene l'ID per la finestra di dialogo.
BotTelemetryClient getTelemetryClient()

Ottiene il BotTelemetryClient da utilizzare per la registrazione.
java.lang.String getVersion()

Ottiene un valore String univoco che rappresenta la versione di questa finestra di dialogo.
protected static java.util.concurrent.CompletableFuture<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementazione condivisa dell'esecuzione con Dialog e DialogManager.
protected java.lang.String onComputeId()

Calcola un ID per il dialogo.
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.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPostBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato dopo che un evento è stato indirizzato a tutti i genitori e non è stato gestito.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato prima che un evento venga visualizzato nell'elemento padre.
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 dc, DialogReason reason)

Chiamato quando un dialogo figlio ha completato questo turno, restituendo il controllo a questa finestra di dialogo.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Chiamato quando un dialogo figlio ha completato questo turno, restituendo il controllo a questa finestra di dialogo.
static java.util.concurrent.CompletableFuture<java.lang.Void> run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)

Crea uno stack di dialoghi e avvia un dialogo, che lo inserisce nello stack.
void setId(String withId)

Imposta l'ID per la finestra di dialogo.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Imposta il BotTelemetryClient da utilizzare per la registrazione.

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

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

Un DialogTurnResult che indica che la finestra di dialogo corrente è ancora attiva e in attesa dell'input dal turno successivo dell'utente.

Dettagli costruttore

Dialog

public Dialog(String dialogId)

Inizializza una nuova istanza della classe Dialog.

Parametri:

dialogId - ID da assegnare a questa finestra di dialogo.

Dettagli metodo

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

Chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi.

Parametri:

dc - Il DialogContext per il turno di conversazione corrente.

Restituisce:

Se l'attività ha esito positivo, il risultato indica se il dialogo è ancora attivo dopo che il turno è stato elaborato dalla finestra di dialogo.

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

Chiamato quando il dialogo viene avviato e inserito nello stack di dialoghi.

Parametri:

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

Restituisce:

Se l'attività ha esito positivo, il risultato indica se il dialogo è ancora attivo dopo che il turno è stato elaborato dalla finestra di dialogo.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Se questo metodo è *not* sottoposto a override, la finestra di dialogo termina automaticamente quando l'utente risponde.

Parametri:

dc - Il DialogContext per il turno di conversazione corrente.

Restituisce:

Se l'attività ha esito positivo, il risultato indica se il dialogo è ancora attivo dopo che il turno è stato elaborato dalla finestra di dialogo. Il risultato può contenere anche un valore restituito.

endDialog

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

Chiamato quando termina il dialogo.

Parametri:

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

Restituisce:

CompletableFuture che rappresenta l'operazione asincrona.

getId

public String getId()

Ottiene l'ID per la finestra di dialogo.

Restituisce:

ID per la finestra di dialogo.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Ottiene il BotTelemetryClient da utilizzare per la registrazione.

Restituisce:

BotTelemetryClient da usare per la registrazione.

getVersion

public String getVersion()

Ottiene un valore String univoco che rappresenta la versione di questa finestra di dialogo. Se la versione cambia tra turni il sistema del dialogo genererà un evento DialogChanged.

Restituisce:

Stringa univoca che deve cambiare solo quando la finestra di dialogo è stata modificata in modo da riavviare la finestra di dialogo.

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementazione condivisa dell'esecuzione con Dialog e DialogManager.

Parametri:

turnContext - TurnContext.
dialogId - ID del dialogo.
dialogContext - The DialogContext.
stateConfiguration - The DialogStateManagerConfiguration.

Restituisce:

Finestra di dialogoTurnResult.

onComputeId

protected String onComputeId()

Calcola un ID per il dialogo.

Restituisce:

ID.

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.

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.

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato dopo che un evento è stato indirizzato a tutti i genitori e non è stato gestito.

Questo è un buon posto per eseguire la logica di elaborazione predefinita per un evento. La restituzione di "true" impedirà l'elaborazione dell'evento da parte dei dialoghi figlio.

Parametri:

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

Restituisce:

Indica se l'evento viene gestito dal dialogo corrente e l'ulteriore elaborazione deve essere arrestata.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato prima che un evento venga visualizzato nell'elemento padre.

Questo è un buon posto per eseguire l'intercettazione di un evento in quanto la restituzione di "true" impedirà qualsiasi ulteriore bubbling dell'evento agli elementi padre dei dialoghi e impedirà anche a qualsiasi dialogo figlio di eseguire l'elaborazione predefinita.

Parametri:

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

Restituisce:

Indica se l'evento viene gestito dal dialogo corrente e l'ulteriore elaborazione deve essere arrestata.

repromptDialog

public CompletableFuture repromptDialog(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 per questa finestra di dialogo.

Restituisce:

CompletableFuture che rappresenta l'operazione asincrona.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

Chiamato quando un dialogo figlio ha completato questo turno, restituendo il controllo a questa finestra di dialogo.

In genere, il dialogo figlio è stato avviato con una chiamata a beginDialog(DialogContext dc, Object options), tuttavia, se viene chiamato il metodo replaceDialog(String dialogId), il dialogo figlio logico può essere diverso dall'originale.

Se questo metodo è *not* sottoposto a override, la finestra di dialogo termina automaticamente quando l'utente risponde.

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
reason - Motivo per cui il dialogo è stato ripreso.

Restituisce:

Se l'attività ha esito positivo, il risultato indica se questa finestra di dialogo è ancora attiva dopo l'elaborazione di questo turno di dialogo.

resumeDialog

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

Chiamato quando un dialogo figlio ha completato questo turno, restituendo il controllo a questa finestra di dialogo.

In genere, il dialogo figlio è stato avviato con una chiamata a beginDialog(DialogContext dc, Object options), tuttavia, se viene chiamato il metodo replaceDialog(String dialogId, Object options), il dialogo figlio logico può essere diverso dall'originale.

Se questo metodo è *not* sottoposto a override, la finestra di dialogo termina automaticamente quando l'utente risponde.

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
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:

Se l'attività ha esito positivo, il risultato indica se questa finestra di dialogo è ancora attiva dopo l'elaborazione di questo turno di dialogo.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Crea uno stack di dialoghi e avvia un dialogo, che lo inserisce nello stack.

Parametri:

dialog - Finestra di dialogo da avviare.
turnContext - Contesto per il turno corrente della conversazione.
accessor - Funzione di accesso StatePropertyAccessor con cui gestire lo stato dello stack di dialoghi.

Restituisce:

Oggetto Task che rappresenta l'operazione asincrona.

setId

public void setId(String withId)

Imposta l'ID per la finestra di dialogo.

Parametri:

withId - ID per la finestra di dialogo.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Imposta il BotTelemetryClient da utilizzare per la registrazione.

Parametri:

withTelemetryClient - BotTelemetryClient da usare per la registrazione.

Si applica a