ComponentDialog Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Eine Dialog, die aus anderen Dialogfeldern besteht.
public class ComponentDialog : Microsoft.Bot.Builder.Dialogs.DialogContainer
type ComponentDialog = class
inherit DialogContainer
Public Class ComponentDialog
Inherits DialogContainer
- Vererbung
Hinweise
Ein Komponentendialog besitzt ein inneres DialogSet und DialogContext, das einen inneren Dialogstapel liefert, der vor dem übergeordneten Dialog verborgen ist.
Konstruktoren
| Name | Beschreibung |
|---|---|
| ComponentDialog(String) |
Initialisiert eine neue Instanz der ComponentDialog-Klasse. |
Felder
| Name | Beschreibung |
|---|---|
| PersistedDialogState |
Die ID für den permanenten Dialogfeldstatus. |
Eigenschaften
| Name | Beschreibung |
|---|---|
| Dialogs |
Bekommt oder setzt die Behälter DialogSet. (Geerbt von DialogContainer) |
| Id |
Erhält oder setzt eine ID für den Dialog. (Geerbt von Dialog) |
| IgnoreMemoryScopeBinding |
Erhält oder setzt einen Wert, der angibt, ob dies DialogContainer mit Memory Scopes interagieren soll oder nicht. (Geerbt von DialogContainer) |
| InitialDialogId |
Erhält oder setzt die ID des Anfangsdialogs. |
| Source |
Erhält die Information des Cref="SourceRange"/>. (Geerbt von Dialog) |
| TelemetryClient |
Es bekommt oder setzt die Nutzung IBotTelemetryClient , um sie für das Protokollieren zu verwenden. Beim Setzen dieser Eigenschaft werden auch die Eigenschaften aller enthaltenen Dialoge TelemetryClient gesetzt. (Geerbt von DialogContainer) |
Methoden
| Name | Beschreibung |
|---|---|
| AddDialog(Dialog) |
Fügt dem Komponentendialogfeld eine neue Dialog hinzu und gibt die aktualisierte Komponente zurück. |
| BeginDialogAsync(DialogContext, Object, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld gestartet und auf den Dialogstapel des übergeordneten Elements verschoben wird. |
| CheckForVersionChangeAsync(DialogContext, CancellationToken) |
CheckForVersionChangeAsync. (Geerbt von DialogContainer) |
| ContinueDialogAsync(DialogContext, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld fortgesetzt, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet. |
| CreateChildContext(DialogContext) |
Schafft ein inneres DialogContext. |
| EndComponentAsync(DialogContext, Object, CancellationToken) |
Beendet das Komponentendialogfeld im Kontext des übergeordneten Elements. |
| EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld beendet wird. |
| EnsureInitializedAsync(DialogContext) |
Stellt sicher, dass das Dialogfeld initialisiert wird. |
| FindDialog(String, DialogContext) |
Sucht ein untergeordnetes Dialogfeld, das zuvor dem Container hinzugefügt wurde. Verwendet DialogContext als Rückfall, um den Dialog zu sammeln. (Geerbt von DialogContainer) |
| FindDialog(String) |
Sucht ein untergeordnetes Dialogfeld, das zuvor dem Container hinzugefügt wurde. (Geerbt von DialogContainer) |
| GetInternalVersion() |
GetInternalVersion : Gibt den internen Versionsbezeichner für diesen Container zurück. (Geerbt von DialogContainer) |
| GetVersion() |
Erhält eine eindeutige Zeichenkette, die die Version dieses Dialogs darstellt. Wenn sich die Version ändert, gibt das Dialogfeldsystem ein DialogChanged-Ereignis aus. (Geerbt von Dialog) |
| OnBeginDialogAsync(DialogContext, Object, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld gestartet und auf den Dialogstapel des übergeordneten Elements verschoben wird. |
| OnComputeId() |
Erstellt die Compute-ID für den Dialog. (Geerbt von Dialog) |
| OnContinueDialogAsync(DialogContext, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld fortgesetzt, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet. |
| OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken) |
Wird aufgerufen, wenn ein Ereignis mit |
| OnEndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld beendet wird. |
| OnInitializeAsync(DialogContext) |
Initiliziert das Dialogfeld. |
| OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken) |
Wird aufgerufen, nachdem ein Ereignis für alle übergeordneten Eltern eingeblasen wurde und nicht behandelt wurde. (Geerbt von Dialog) |
| OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken) |
Wird aufgerufen, bevor ein Ereignis in das übergeordnete Element eingeblasen wird. (Geerbt von Dialog) |
| OnRepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld den Benutzer zur Eingabe erneut auffordert. |
| RegisterSourceLocation(String, Int32) |
Registriert ein Cref="SourceRange"/> an der angegebenen Stelle. (Geerbt von Dialog) |
| RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken) |
Wird aufgerufen, wenn das Dialogfeld den Benutzer zur Eingabe erneut auffordert. |
| ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) |
Wird aufgerufen, wenn ein untergeordnetes Dialogfeld im Dialogstapel des übergeordneten Elements diese Drehung abgeschlossen hat und dieses Steuerelement an diese Dialogfeldkomponente zurückgibt. |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken) |
Erstellt einen Dialogstapel und startet ein Dialogfeld, indem es auf den Stapel verschoben wird. |