DialogSet Klasse

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

public class DialogSet

Eine Auflistung von Dialog-Objekten, die sich gegenseitig aufrufen können.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
DialogSet()

Erstellt ein Dialogfeld"Ohne Zustand festlegen".
DialogSet(StatePropertyAccessor<DialogState> withDialogState)

Initialisiert eine neue Instanz der DialogSet-Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
DialogSet add(Dialog dialog)

Fügt dem Satz ein neues Dialogfeld hinzu und gibt den Satz zurück, um die Fluent-Verkettung zu ermöglichen.
java.util.concurrent.CompletableFuture<DialogContext> createContext(TurnContext turnContext)

Erstellt ein DialogfeldKontext, der zum Arbeiten mit den Dialogfeldern im DialogfeldFestlegen verwendet werden kann.
Dialog find(String dialogId)

Durchsucht das aktuelle DialogfeldNach einem Dialogfeld anhand seiner ID festlegen.
java.util.Collection<Dialog> getDialogs()

Gibt eine Auflistung von Dialogs in diesem DialogfeldSet zurück.
BotTelemetryClient getTelemetryClient()

Ruft den BotTelemetrieClient für die Protokollierung ab.
java.lang.String getVersion()

Ruft eine eindeutige Zeichenfolge ab, die die kombinierten Versionen aller Dialogfelder in diesem Dialogfeld darstellt.
void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

Legt den Bot-Telemetrie-Client fest, der für die Protokollierung verwendet werden soll.

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

DialogSet

public DialogSet()

Erstellt ein DialogSet ohne Zustand.

DialogSet

public DialogSet(StatePropertyAccessor withDialogState)

Initialisiert eine neue Instanz der DialogSet-Klasse.

Um die Dialogfelder in diesem Dialogfeldsatz zu starten und zu steuern, erstellen Sie einen DialogContext, und verwenden Sie dessen Methoden, um Dialogfelder zu starten, fortzusetzen oder zu beenden. Rufen Sie createContext(TurnContext) auf, um einen Dialogfeldkontext zu erstellen.

Parameter:

withDialogState - Der Zustandseigenschaftsaccessor, mit dem der Stapel für diesen Dialogfeldsatz verwaltet werden soll.

Details zur Methode

add

public DialogSet add(Dialog dialog)

Fügt dem Satz ein neues Dialogfeld hinzu und gibt den Satz zurück, um die Fluent-Verkettung zu ermöglichen. Wenn die Dialog.Id, die hinzugefügt werden, bereits in der Gruppe vorhanden ist, wird die Dialog-ID aktualisiert, um ein Suffix einzuschließen, das sie eindeutig macht. Das Hinzufügen von zwei Dialogfeldern mit dem Namen "duplizieren" zum Satz würde also dazu führen, dass die erste eine ID von "duplizieren" und das zweite Dialogfeld mit der ID "duplizieren2" aufweist.

Parameter:

dialog - Das hinzuzufügende Dialogfeld. Der Dialog Dialog.TelemetryClient des hinzugefügten Dialogfelds wird auf den BotTelemetryClient des Dialogfeldsatzes festgelegt.

Gibt zurück:

Das Dialogfeld, das nach Abschluss des Vorgangs festgelegt ist.

createContext

public CompletableFuture createContext(TurnContext turnContext)

Erstellt einen DialogContext, der zum Arbeiten mit den Dialogfeldern im DialogSet verwendet werden kann.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

find

public Dialog find(String dialogId)

Durchsucht das aktuelle DialogSet nach einem Dialogfeld anhand seiner ID.

Parameter:

dialogId - ID des dialogfelds, nach dem gesucht werden soll.

Gibt zurück:

Das Dialogfeld, falls gefunden; andernfalls NULL

getDialogs

public Collection

getDialogs()

Gibt eine Auflistung von Dialogs in diesem DialogSet zurück.

Gibt zurück:

Die Dialogfelder in diesem DialogSet.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Ruft den BotTelemetryClient ab, der für die Protokollierung verwendet werden soll.

Gibt zurück:

Der BotTelemetryClient, der für die Protokollierung verwendet werden soll.

getVersion

public String getVersion()

Ruft eine eindeutige Zeichenfolge ab, die die kombinierten Versionen aller Dialogfelder in diesem Dialogfeld darstellt.

Gibt zurück:

Die Version ändert sich, wenn sich eines der untergeordneten Dialogfelder ändert.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

Legt den Für die Protokollierung zu verwendenden BotTelemetryClient fest.

Wenn diese Eigenschaft festgelegt ist, wird der Dialog.TelemetryClient jedes Dialogfelds im Satz auf den neuen Wert festgelegt.

Parameter:

withBotTelemetryClient - Der BotTelemetryClient, der für die Protokollierung verwendet werden soll.

Gilt für: