Språk

Prompt<T> Klass

Definition

Definierar kärnbeteendet för dialogrutor för frågor.

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

Typparametrar

T

Den typ av värde som prompten returnerar.

Arv
Prompt<T>
Härledda

Kommentarer

När prompten avslutas bör det returnera ett T objekt som representerar värdet som efterfrågades. Använd Add(Dialog) eller AddDialog(Dialog) för att lägga till en fråga i en dialogruta eller komponentdialogruta. Använd PromptAsync(String, PromptOptions, CancellationToken) eller BeginDialogAsync(String, Object, CancellationToken) för att starta kommandotolken. Om du startar en uppmaning från en WaterfallStep i en WaterfallDialogblir promptresultatet tillgängligt i nästa steg i vattenfallet.

Konstruktorer

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

Initierar en ny instans av Prompt<T> klassen. Anropas från konstruktorer i härledda klasser för att initiera Prompt<T> klassen.

Egenskaper

Name Description
Id

Hämtar eller anger ID för dialogrutan.

(Ärvd från Dialog)
Source

Får informationen om cref="SourceRange"/>.

(Ärvd från Dialog)
TelemetryClient

Får eller ställer in att IBotTelemetryClient använda för loggning.

(Ärvd från Dialog)

Metoder

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

När den åsidosätts i en härledd klass lägger du till val i aktiviteten när användaren uppmanas att ange indata.

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

När den åsidosätts i en härledd klass lägger du till val i aktiviteten när användaren uppmanas att ange indata.

BeginDialogAsync(DialogContext, Object, CancellationToken)

Anropas när en dialogruta skickas till dialogstacken och aktiveras.

ContinueDialogAsync(DialogContext, CancellationToken)

Anropas när en promptdialogruta är den aktiva dialogrutan och användaren svarade med en ny aktivitet.

EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

Anropas när dialogrutan slutar.

(Ärvd från Dialog)
GetVersion()

Hämtar en unik sträng som representerar versionen av den här dialogrutan. Om versionen ändras mellan svängar genererar dialogsystemet en DialogChanged-händelse.

(Ärvd från Dialog)
OnComputeId()

Skapar beräknings-ID:t för dialogrutan.

(Ärvd från Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)

Anropas när en händelse har aktiverats, med , DialogContext.emitEvent()antingen av den aktuella dialogen eller en dialog som den aktuella dialogen startade.

(Ärvd från Dialog)
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

Anropades efter att en händelse bubblades till alla föräldrar och hanterades inte.

(Ärvd från Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

Anropas innan en händelse bubblas till dess överordnade.

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

När den åsidosättas i en härledd klass uppmanas användaren att ange indata.

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

När det åsidosättas i en härledd klass försöker identifiera användarens indata.

RegisterSourceLocation(String, Int32)

Registrerar en cref="SourceRange"/> på den angivna platsen.

(Ärvd från Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)

Anropas när en promptdialogruta har begärts för att uppmana användaren att ange indata igen.

ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

Anropas när en promptdialogruta fortsätter att vara den aktiva dialogrutan i dialogstacken, till exempel när den tidigare aktiva dialogrutan i stacken har slutförts.

Tilläggsmetoder

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

Skapar en dialogstack och startar en dialogruta och push-överför den till stacken.

Gäller för