DialogContext Klasse

  • Referenz
Paket:
com.microsoft.bot.dialogs
Maven-Artefakt:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.DialogContext

public class DialogContext

Stellt kontext für den aktuellen Status des Dialogstapels bereit.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Initialisiert eine neue Instanz der Dialog-Context-Klasse aus dem Turnkontext.
DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Initialisiert eine neue Instanz der Dialog-Context-Klasse aus dem Turnkontext.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(String dialogId)

Startet ein neues Dialogfeld und verschiebt es auf den Dialogstapel.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(String dialogId, Object options)

Startet ein neues Dialogfeld und verschiebt es auf den Dialogstapel.
java.util.concurrent.CompletableFuture<DialogTurnResult> cancelAllDialogs()

Hilfsmethode für cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue), die keine übergeordneten Dialogfelder abbricht, oder übergeben und ereignis.
java.util.concurrent.CompletableFuture<DialogTurnResult> cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialogfelder im Stapel abgebrochen werden.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog()

Setzt die Ausführung des aktiven Dialogfelds fort, falls vorhanden, durch Übergeben des aktuellen DialogsKontext an die continueDialog(DialogContext dc)-Methode des aktiven Dialogfelds.
java.util.concurrent.CompletableFuture<java.lang.Boolean> emitEvent(String name)
java.util.concurrent.CompletableFuture<java.lang.Boolean> emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)
java.util.concurrent.CompletableFuture<DialogTurnResult> endDialog()

Hilfsmethode, die ein NULL-Ergebnis für endDialog(Object result)bereitstellt.
java.util.concurrent.CompletableFuture<DialogTurnResult> endDialog(Object result)

Beendet ein Dialogfeld, indem es aus dem Stapel geschaltet wird, und gibt ein optionales Ergebnis an das übergeordnete Element des Dialogfelds zurück.
Dialog findDialog(String dialogId)

Suchen Sie die Dialogfeld-ID für den angegebenen Kontext.
DialogInstance getActiveDialog()

Ruft die zwischengespeicherte Instanz des aktiven Dialogfelds oben im Stapel oder null ab, wenn der Stapel leer ist.
DialogContext getChild()

Ruft Dialogkontext für untergeordnete Elemente ab, wenn ein aktives untergeordnetes Element vorhanden ist.
TurnContext getContext()

Ruft den Kontext für die aktuelle Unterhaltungswende ab.
DialogSet getDialogs()

Ruft den Satz von Dialogfeldern ab, die für den aktuellen Dialogfeldcontainer aktiv sind.
java.lang.String getLocale()

Rufen Sie das Gebietsschema im DialogfeldKontext ab.
DialogContext getParent()

Ruft das übergeordnete DialogfeldKontext ab, falls vorhanden.
TurnContextStateCollection getServices()

Ruft die Dienstauflistung ab, die kontextbezogen mit diesem Dialogfeldkontext ist.
java.util.List<DialogInstance> getStack()

Ruft den aktuellen Dialogstapel ab.
DialogStateManager getState()

Ruft den DialogStateManager ab, der die Ansicht aller Speicherbereiche verwaltet, oder legt diesen fest.
java.util.concurrent.CompletableFuture<DialogTurnResult> prompt(String dialogId, PromptOptions options)

Hilfsfunktion zum Vereinfachen der Formatierung der Optionen zum Aufrufen eines Eingabeaufforderungsdialogfelds.
java.util.concurrent.CompletableFuture<DialogTurnResult> replaceDialog(String dialogId)

Hilfsmethode für replaceDialog(String dialogId, Object options), die NULL für Optionen übergibt.
java.util.concurrent.CompletableFuture<DialogTurnResult> replaceDialog(String dialogId, Object options)

Startet ein neues Dialogfeld und ersetzt im Stapel das derzeit aktive Dialogfeld durch das neue Dialogfeld.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog()

Ruft die repromptDialog(TurnContext turnContext, DialogInstance instance) Methode des derzeit aktiven Dialogfelds auf.
void setParent(DialogContext withDialogContext)

Legen Sie das übergeordnete DialogfeldKontext fest.

Geerbte Methoden von 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

Details zum Konstruktor

DialogContext

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

Initialisiert eine neue Instanz der DialogContext-Klasse aus dem Turnkontext.

Parameter:

withDialogs - Das Dialogfeld, für das der Dialogfeldkontext erstellt werden soll.
withTurnContext - Der aktuelle Turnkontext.
withState - Die Statuseigenschaft, aus der der Dialogkontext abgerufen werden soll.

DialogContext

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

Initialisiert eine neue Instanz der DialogContext-Klasse aus dem Turnkontext.

Parameter:

withDialogs - Das Dialogfeld, für das der Dialogfeldkontext erstellt werden soll.
withParentDialogContext - Kontext des übergeordneten Dialogfelds.
withState - Aktueller Dialogfeldstatus.

Details zur Methode

beginDialog

public CompletableFuture beginDialog(String dialogId)

Startet ein neues Dialogfeld und verschiebt es auf den Dialogstapel.

Parameter:

dialogId - ID des zu startenden Dialogfelds.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

beginDialog

public CompletableFuture beginDialog(String dialogId, Object options)

Startet ein neues Dialogfeld und verschiebt es auf den Dialogstapel.

Parameter:

dialogId - ID des zu startenden Dialogfelds.
options - Optional, Informationen, die an das Dialogfeld übergeben werden, das gestartet wird.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

cancelAllDialogs

public CompletableFuture cancelAllDialogs()

Hilfsmethode für cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue), die keine übergeordneten Dialogfelder abbricht, oder übergeben und ereignis.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, dass Dialogfelder abgebrochen wurden, nachdem die Drehung vom Dialogfeld verarbeitet wurde oder dass der Stapel bereits leer war.

cancelAllDialogs

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

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialogfelder im Stapel abgebrochen werden.

Im Allgemeinen ist der übergeordnete Kontext das Dialogfeld oder der Bot-Turnhandler, der das Dialogfeld gestartet hat. Wenn das übergeordnete Element ein Dialogfeld ist, ruft der Stapel die resumeDialog(DialogContext dc, DialogReason reason, Object result) Methode des übergeordneten Elements auf, um ein Ergebnis an das übergeordnete Dialogfeld zurückzugeben. Wenn das übergeordnete Dialogfeld nicht Dialog#resumeDialogimplementiert, wird auch das übergeordnete Element beendet, und das Ergebnis wird an den nächsten übergeordneten Kontext übergeben.

Parameter:

cancelParents - Wenn true, wird auch der Abbruch durch alle übergeordneten Dialogfelder angezeigt.
eventName - Das Ereignis. Wenn null, wird CANCEL_DIALOG verwendet.
eventValue - Der Ereigniswert. Kann null sein.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, dass Dialogfelder abgebrochen wurden, nachdem die Drehung vom Dialogfeld verarbeitet wurde oder dass der Stapel bereits leer war.

continueDialog

public CompletableFuture continueDialog()

Setzt die Ausführung des aktiven Dialogfelds fort, falls vorhanden, indem der aktuelle DialogContext an die continueDialog(DialogContext dc)-Methode des aktiven Dialogfelds übergeben wird.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

emitEvent

public CompletableFuture emitEvent(String name)

Parameter:

name - Der Name des ereignisses, das ausgelöst werden soll.

Gibt zurück:

emitEvent

emitEvent

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

Parameter:

name - Der Name des ereignisses, das ausgelöst werden soll.
value - Wert, der zusammen mit dem Ereignis gesendet werden soll.
bubble - Kennzeichnen Sie, um zu steuern, ob das Ereignis an das übergeordnete Element übergeben werden soll, wenn es nicht lokal behandelt wird. Der Standardwert ist ein Wert von true.
fromLeaf - Gibt an, ob das Ereignis von einem Blattknoten ausgegeben wird.

Gibt zurück:

completedFuture

endDialog

public CompletableFuture endDialog()

Hilfsmethode, die ein NULL-Ergebnis für endDialog(Object result)bereitstellt.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, dass das Dialogfeld beendet wurde, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

endDialog

public CompletableFuture endDialog(Object result)

Beendet ein Dialogfeld, indem es aus dem Stapel geschaltet wird, und gibt ein optionales Ergebnis an das übergeordnete Element des Dialogfelds zurück. Das übergeordnete Dialogfeld ist das Dialogfeld, das über einen Aufruf von beginDialog(String dialogId, Object options) oder prompt(String dialogId, PromptOptions options)gestartet wurde. Das übergeordnete Dialogfeld enthält die resumeDialog(DialogContext dc, DialogReason reason, Object result) Methode, die mit jedem zurückgegebenen Ergebnis aufgerufen wird. Wenn das übergeordnete Dialogfeld keine resumeDialog(DialogContext dc, DialogReason reason) Methode implementiert hat, wird es automatisch beendet und das Ergebnis an das übergeordnete Element übergeben. Wenn im Stapel keine übergeordneten Dialogfelder vorhanden sind, wird die Verarbeitung der Drehung beendet.

Parameter:

result - Optional, Ergebnis, das an den übergeordneten Kontext übergeben werden soll.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, dass das Dialogfeld beendet wurde, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

findDialog

public Dialog findDialog(String dialogId)

Suchen Sie die Dialogfeld-ID für den angegebenen Kontext.

Parameter:

dialogId - dialog id to find.

Gibt zurück:

dialog with that id, or null.

getActiveDialog

public DialogInstance getActiveDialog()

Ruft die zwischengespeicherte Instanz des aktiven Dialogfelds oben im Stapel oder null ab, wenn der Stapel leer ist.

Gibt zurück:

Die zwischengespeicherte Instanz des aktiven Dialogfelds oben im Stapel oder null, wenn der Stapel leer ist.

getChild

public DialogContext getChild()

Ruft Dialogkontext für untergeordnete Elemente ab, wenn ein aktives untergeordnetes Element vorhanden ist.

Gibt zurück:

Dialogfeldkontext für untergeordnete Elemente, wenn ein aktives untergeordnetes Element vorhanden ist.

getContext

public TurnContext getContext()

Ruft den Kontext für die aktuelle Unterhaltungswende ab.

Gibt zurück:

Der Kontext für die aktuelle Unterhaltungswende.

getDialogs

public DialogSet getDialogs()

Ruft den Satz von Dialogfeldern ab, die für den aktuellen Dialogfeldcontainer aktiv sind.

Gibt zurück:

Die Gruppe von Dialogfeldern, die für den aktuellen Dialogfeldcontainer aktiv sind.

getLocale

public String getLocale()

Rufen Sie das Gebietsschema in DialogContext ab.

Gibt zurück:

Eine Zeichenfolge, die das aktuelle Gebietsschema darstellt.

getParent

public DialogContext getParent()

Ruft den übergeordneten DialogContext ab, falls vorhanden. Wird beim Suchen nach der ID eines Dialogfelds zum Starten verwendet.

Gibt zurück:

Das übergeordnete Element "DialogContext, falls vorhanden. Wird beim Suchen nach der ID eines Dialogfelds zum Starten verwendet.

getServices

public TurnContextStateCollection getServices()

Ruft die Dienstauflistung ab, die kontextbezogen mit diesem Dialogfeldkontext ist.

Gibt zurück:

Dienstsammlung.

getStack

public List getStack()

Ruft den aktuellen Dialogstapel ab.

Gibt zurück:

Der aktuelle Dialogstapel.

getState

public DialogStateManager getState()

Ruft den DialogStateManager ab, der die Ansicht aller Speicherbereiche verwaltet, oder legt diesen fest.

Gibt zurück:

DialogStateManager mit einheitlicher Speicheransicht aller Speicherbereiche.

prompt

public CompletableFuture prompt(String dialogId, PromptOptions options)

Hilfsfunktion zum Vereinfachen der Formatierung der Optionen zum Aufrufen eines Eingabeaufforderungsdialogfelds. Dieses Hilfsprogramm übernimmt ein PromptOptions-Argument und ruft dann beginDialog(String dialogId, Object options)

Parameter:

dialogId - ID des zu startenden Eingabeaufforderungsdialogfelds.
options - Informationen, die an das Eingabeaufforderungsdialogfeld übergeben werden, das gestartet wird.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

replaceDialog

public CompletableFuture replaceDialog(String dialogId)

Hilfsmethode für replaceDialog(String dialogId, Object options), die NULL für Optionen übergibt.

Parameter:

dialogId - ID des zu startenden neuen Dialogfelds.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

replaceDialog

public CompletableFuture replaceDialog(String dialogId, Object options)

Startet ein neues Dialogfeld und ersetzt im Stapel das derzeit aktive Dialogfeld durch das neue Dialogfeld. Dies ist besonders nützlich für das Erstellen von Schleifen oder das Umleiten zu einem anderen Dialogfeld.

Parameter:

dialogId - ID des zu startenden neuen Dialogfelds.
options - Optional, Informationen, die an das Dialogfeld übergeben werden, das gestartet wird.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

repromptDialog

public CompletableFuture repromptDialog()

Ruft die repromptDialog(TurnContext turnContext, DialogInstance instance) Methode des derzeit aktiven Dialogfelds auf. Wird mit Dialogfeldern verwendet, die ein erneutes Eingabeaufforderungsverhalten implementieren.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

setParent

public void setParent(DialogContext withDialogContext)

Legen Sie den übergeordneten DialogContext fest.

Parameter:

withDialogContext - Der DialogContext, auf den das übergeordnete Element festgelegt werden soll.

Gilt für: