DialogContext Classe

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Inizializza una nuova istanza della classe DialogContext dal contesto di turno.

Parametri:

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Inizializza una nuova istanza della classe DialogContext dal contesto di turno.

Parametri:

public CompletableFuture beginDialog(String dialogId)

Avvia un nuovo dialogo e lo inserisce nello stack di dialoghi.

Parametri:

Restituisce:

public CompletableFuture beginDialog(String dialogId, Object options)

Avvia un nuovo dialogo e lo inserisce nello stack di dialoghi.

Parametri:

Restituisce:

public CompletableFuture cancelAllDialogs()

Metodo helper per cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) che non annulla i dialoghi padre o passa e l'evento.

Restituisce:

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Elimina qualsiasi stack di dialoghi esistente annullando così tutti i dialoghi nello stack.

In generale, il contesto padre è il gestore dei turni del bot o del dialogo che ha avviato la finestra di dialogo. Se l'elemento padre è un dialogo, lo stack chiama il metodo resumeDialog(DialogContext dc, DialogReason reason, Object result) padre per restituire un risultato al dialogo padre. Se la finestra di dialogo padre non implementa Dialog#resumeDialog, anche l'elemento padre terminerà e il risultato verrà passato al contesto padre successivo.

Parametri:

Restituisce:

public CompletableFuture continueDialog()

Continua l'esecuzione del dialogo attivo, se presente, passando il dialogContext corrente al metodo continueDialog(DialogContext dc) del dialogo attivo.

Restituisce:

public CompletableFuture emitEvent(String name)

Parametri:

Restituisce:

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

Parametri:

Restituisce:

public CompletableFuture endDialog()

Metodo helper che fornisce un risultato Null per endDialog(Object result).

Restituisce:

public CompletableFuture endDialog(Object result)

Termina un dialogo estraendolo dallo stack e restituisce un risultato facoltativo all'elemento padre del dialogo. La finestra di dialogo padre è la finestra di dialogo in cui è stato avviato l'oggetto terminato tramite una chiamata a beginDialog(String dialogId, Object options) o prompt(String dialogId, PromptOptions options). Il dialogo padre avrà il relativo metodo resumeDialog(DialogContext dc, DialogReason reason, Object result) richiamato con qualsiasi risultato restituito. Se il dialogo padre non ha implementato un metodo resumeDialog(DialogContext dc, DialogReason reason), verrà terminato automaticamente e il risultato passato al relativo elemento padre. Se non sono presenti più dialoghi padre nello stack, l'elaborazione del turno terminerà.

Parametri:

Restituisce:

public Dialog findDialog(String dialogId)

Trovare l'ID finestra di dialogo per il contesto specificato.

Parametri:

Restituisce:

public DialogInstance getActiveDialog()

Ottiene l'istanza memorizzata nella cache della finestra di dialogo attiva nella parte superiore dello stack o null se lo stack è vuoto.

Restituisce:

public DialogContext getChild()

Ottiene il contesto del dialogo per figlio se è presente un elemento figlio attivo.

Restituisce:

public TurnContext getContext()

Ottiene il contesto per il turno corrente della conversazione.

Restituisce:

public DialogSet getDialogs()

Ottiene il set di dialoghi attivi per il contenitore della finestra di dialogo corrente.

Restituisce:

public String getLocale()

Ottenere le impostazioni locali in DialogContext.

Restituisce:

public DialogContext getParent()

Ottiene l'oggetto DialogContext padre, se presente. Utilizzato durante la ricerca dell'ID di una finestra di dialogo da avviare.

Restituisce:

public TurnContextStateCollection getServices()

Ottiene la raccolta di servizi contestuale a questo contesto di dialogo.

Restituisce:

public List getStack()

Ottiene lo stack di dialoghi corrente.

Restituisce:

public DialogStateManager getState()

Ottiene o imposta DialogStateManager che gestisce la visualizzazione di tutti gli ambiti di memoria.

Restituisce:

public CompletableFuture prompt(String dialogId, PromptOptions options)

Funzione helper per semplificare la formattazione delle opzioni per chiamare una finestra di dialogo di richiesta. Questo helper accetta un argomento PromptOptions e quindi chiama beginDialog(String dialogId, Object options)

Parametri:

Restituisce:

public CompletableFuture replaceDialog(String dialogId)

Metodo helper per replaceDialog(String dialogId, Object options) che passa Null per le opzioni.

Parametri:

Restituisce:

public CompletableFuture replaceDialog(String dialogId, Object options)

Avvia un nuovo dialogo e sostituisce nello stack il dialogo attualmente attivo con quello nuovo. Ciò è particolarmente utile per la creazione di cicli o il reindirizzamento a un'altra finestra di dialogo.

Parametri:

Restituisce:

public CompletableFuture repromptDialog()

Chiama il metodo repromptDialog(TurnContext turnContext, DialogInstance instance) del dialogo attualmente attivo. Usato con i dialoghi che implementano un comportamento di ripetizione della richiesta.

Restituisce:

public void setParent(DialogContext withDialogContext)

Impostare l'elemento dialogContext padre.

Parametri: