ActionScope class
ActionScope verwaltet die Ausführung eines Aktionsblocks und unterstützt goto-, Continue- und Break-Semantik.
- Extends
-
Dialog<O>
Konstruktoren
| Action |
Erstellt eine neue |
Eigenschaften
| actions | Die auszuführenden Aktionen. |
Geerbte Eigenschaften
| End |
Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab. |
| id | |
| telemetry |
Methoden
| begin |
Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird. |
| continue |
Wird aufgerufen, wenn das Dialog-fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet. |
| get |
|
| get |
Ruft das untergeordnete Dialog Abhängigkeiten ab, damit sie den Containern Dialog festgelegt werden können. |
| get |
Ruft eine eindeutige |
| resume |
Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück. |
Geerbte Methoden
| configure(Record<string, unknown>) | Fluent-Methode zum Konfigurieren des Objekts. |
| end |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt. |
| on |
Wird aufgerufen, wenn ein Ereignis mit |
| reprompt |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert. |
Details zum Konstruktor
ActionScope(Dialog[])
Erstellt eine neue ActionScope Instanz.
new ActionScope(actions?: Dialog[])
Parameter
- actions
-
Dialog[]
Die Aktionen für den Bereich.
Details zur Eigenschaft
actions
Die auszuführenden Aktionen.
actions: Dialog[]
Eigenschaftswert
Dialog[]
Geerbte Eigenschaftsdetails
EndOfTurn
Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.
static EndOfTurn: DialogTurnResult
Eigenschaftswert
DialogTurnResult
Hinweise
Dieses Ergebnis gibt an, dass ein Dialogfeld (oder ein logischer Schritt innerhalb eines Dialogfelds) die Verarbeitung für die aktuelle Drehung abgeschlossen hat, noch aktiv ist und auf weitere Eingaben wartet.
von Dialog.EndOfTurn geerbt
id
id: string
Eigenschaftswert
string
geerbt von Dialog.id
telemetryClient
telemetryClient: BotTelemetryClient
Eigenschaftswert
BotTelemetryClient
Geerbt von Dialog.telemetryClient
Details zur Methode
beginDialog(DialogContext, O)
Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.
function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>
Parameter
- dc
-
DialogContext
Die DialogContext- für die aktuelle Unterhaltungswende.
- _options
-
O
Wahlfrei. Anfängliche Informationen, die an das Dialogfeld übergeben werden sollen.
Gibt zurück
Promise<DialogTurnResult>
Eine Promise, die den asynchronen Vorgang darstellt.
continueDialog(DialogContext)
Wird aufgerufen, wenn das Dialog-fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>
Parameter
- dc
-
DialogContext
Die DialogContext- für die aktuelle Unterhaltungswende.
Gibt zurück
Promise<DialogTurnResult>
Eine Promise, die den asynchronen Vorgang darstellt.
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactory
Parameter
- property
-
Object
Der Schlüssel der Konfiguration der bedingten Auswahl.
Gibt zurück
Converter | ConverterFactory
Der Konverter für die Selektorkonfiguration.
getDependencies()
Ruft das untergeordnete Dialog Abhängigkeiten ab, damit sie den Containern Dialog festgelegt werden können.
function getDependencies(): Dialog[]
Gibt zurück
Dialog[]
Das untergeordnete Dialog Abhängigkeiten.
getVersion()
Ruft eine eindeutige string, die die Version dieses Dialogfelds darstellt. Wenn sich die Version ändert, gibt das Dialogfeldsystem ein DialogChanged-Ereignis aus.
function getVersion(): string
Gibt zurück
string
Eindeutige string, die sich nur ändern sollte, wenn sich das Dialogfeld auf eine Weise geändert hat, die das Dialogfeld neu starten sollte.
resumeDialog(DialogContext, DialogReason, any)
Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.
function resumeDialog(dc: DialogContext, _reason: DialogReason, result?: any): Promise<DialogTurnResult>
Parameter
- dc
-
DialogContext
Die DialogContext- für die aktuelle Unterhaltungswende.
- _reason
-
DialogReason
(xref:botbuilder-dialogs. DialogReason), Grund, warum das Dialogfeld fortgesetzt wurde.
- result
-
any
Wahlfrei. Der wert, der aus dem aufgerufenen Dialogfeld zurückgegeben wurde. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.
Gibt zurück
Promise<DialogTurnResult>
Eine Promise, die den asynchronen Vorgang darstellt.
Details zur geerbten Methode
configure(Record<string, unknown>)
Fluent-Methode zum Konfigurieren des Objekts.
function configure(config: Record<string, unknown>): this
Parameter
- config
-
Record<string, unknown>
Anzuwendende Konfigurationseinstellungen.
Gibt zurück
this
Die konfigurierbaren nach Abschluss des Vorgangs.
Geerbt von Konfigurierbar.configure
endDialog(TurnContext, DialogInstance, DialogReason)
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird das Dialogfeld vor dem Beenden bereinigt.
function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>
Parameter
- _context
-
TurnContext
Das Kontextobjekt für die Drehung.
- _instance
-
DialogInstance
Aktuelle Statusinformationen für dieses Dialogfeld.
- _reason
-
DialogReason
Der Grund, warum das Dialogfeld beendet wird.
Gibt zurück
Promise<void>
Hinweise
Abgeleitete Dialogfelder, die vor dem Beenden Protokollierung oder Bereinigung durchführen müssen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkung.
Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld beendet wird.
Siehe auch
von Dialog.endDialog geerbt
onDialogEvent(DialogContext, DialogEvent)
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.
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>
Parameter
- dc
-
DialogContext
Der Dialogkontext für die aktuelle Unterhaltungswende.
- e
-
DialogEvent
Das ausgelöste Ereignis.
Gibt zurück
Promise<boolean>
True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling beendet werden soll.
geerbt von Dialog.onDialogEvent
repromptDialog(TurnContext, DialogInstance)
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.
function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>
Parameter
- _context
-
TurnContext
Das Kontextobjekt für die Drehung.
- _instance
-
DialogInstance
Aktuelle Statusinformationen für dieses Dialogfeld.
Gibt zurück
Promise<void>
Hinweise
Abgeleitete Dialogfelder, die validierungs- und erneute Aufforderungslogik unterstützen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkung.
Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld eingaben vom Benutzer erneut anfordern soll. Diese Methode wird für Eingabeaufforderungsdialoge implementiert.
Siehe auch
geerbt von Dialog.repromptDialog