Prompt<T> Klasse

Definition

Definiert das Kernverhalten von Eingabeaufforderungsdialogfeldern.

public abstract class Prompt<T> : Microsoft.Bot.Builder.Dialogs.Dialog
type Prompt<'T> = class
    inherit Dialog
Public MustInherit Class Prompt(Of T)
Inherits Dialog

Typparameter

T

Der Typ des Werts, den die Eingabeaufforderung zurückgibt.

Vererbung
Prompt<T>
Abgeleitet

Hinweise

Wenn der Prompt endet, sollte ein T Objekt zurückgegeben werden, das den Wert repräsentiert, für den aufgefordert wurde. Verwenden Sie Add(Dialog) oder AddDialog(Dialog), um einem Dialogfeld oder Komponentendialogfeld eine Eingabeaufforderung hinzuzufügen. Verwenden Sie PromptAsync(String, PromptOptions, CancellationToken) oder BeginDialogAsync(String, Object, CancellationToken), um die Eingabeaufforderung zu starten. Wenn Sie eine Eingabeaufforderung von einem WaterfallStep in einem WaterfallDialogstarten, steht das Eingabeaufforderungsergebnis im nächsten Schritt des Wasserfalls zur Verfügung.

Konstruktoren

Name Beschreibung
Prompt<T>(String, PromptValidator<T>)

Initialisiert eine neue Instanz der Prompt<T>-Klasse. Wird von Konstruktoren in abgeleiteten Klassen aufgerufen, um die Prompt<T> Klasse zu initialisieren.

Eigenschaften

Name Beschreibung
Id

Ruft die ID für das Dialogfeld ab oder legt sie fest.

(Geerbt von Dialog)
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.

(Geerbt von Dialog)

Methoden

Name Beschreibung
AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, CancellationToken)

Wenn eine abgeleitete Klasse überschrieben wird, werden auswahlmöglichkeiten an die Aktivität angefügt, wenn der Benutzer zur Eingabe aufgefordert wird.

AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, String, IList<String>, CancellationToken)

Wenn eine abgeleitete Klasse überschrieben wird, werden auswahlmöglichkeiten an die Aktivität angefügt, wenn der Benutzer zur Eingabe aufgefordert wird.

BeginDialogAsync(DialogContext, Object, CancellationToken)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld auf den Dialogstapel verschoben wird und aktiviert wird.

ContinueDialogAsync(DialogContext, CancellationToken)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld das aktive Dialogfeld ist und der Benutzer mit einer neuen Aktivität geantwortet hat.

EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

Wird aufgerufen, wenn das Dialogfeld beendet wird.

(Geerbt von Dialog)
GetVersion()

Ruft eine eindeutige Zeichenfolge ab, die die Version dieses Dialogfelds darstellt. Wenn sich die Version ändert, gibt das Dialogfeldsystem ein DialogChanged-Ereignis aus.

(Geerbt von Dialog)
OnComputeId()

Erstellt die Compute-ID für das Dialogfeld.

(Geerbt von Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

(Geerbt von Dialog)
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.

OnPromptAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, Boolean, CancellationToken)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, fordert der Benutzer zur Eingabe auf.

OnRecognizeAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, CancellationToken)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird versucht, die Eingabe des Benutzers zu erkennen.

RegisterSourceLocation(String, Int32)

Registriert ein Cref="SourceRange"/> an der angegebenen Stelle.

(Geerbt von Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld aufgefordert wurde, den Benutzer erneut zur Eingabe aufzufordern.

ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

Wird aufgerufen, wenn ein Eingabeaufforderungsdialogfeld wieder das aktive Dialogfeld im Dialogstapel ist, z. B. wenn das vorherige aktive Dialogfeld im Stapel abgeschlossen ist.

Erweiterungsmethoden

Name Beschreibung
RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

Erstellt einen Dialogstapel und startet ein Dialogfeld, indem es auf den Stapel verschoben wird.

Gilt für: