Dialog Klasse

Konstruktor

Dialog(dialog_id: str)

Parameter

Name Beschreibung
dialog_id
Erforderlich

Methoden

begin_dialog

Die Methode wird aufgerufen, wenn ein neues Dialogfeld auf den Stapel verschoben wurde und aktiviert wird. :p aram dialog_context: Der Dialogkontext für die aktuelle Unterhaltungswende. :p aram-Optionen: (Optional) zusätzliche Argumente, die an das dialogfeld übergeben werden, das gestartet wird.

continue_dialog

Die Methode wird aufgerufen, wenn eine Instanz des Dialogfelds das Dialogfeld "aktuell" ist und der Benutzer mit einer neuen Aktivität antwortet. Das Dialogfeld empfängt im Allgemeinen weiterhin die Antworten des Benutzers, bis er end_dialog() oder begin_dialog()aufruft. Wenn diese Methode NICHT implementiert ist, wird das Dialogfeld automatisch beendet, wenn der Benutzer antwortet. :p aram dialog_context: Der Dialogkontext für die aktuelle Unterhaltungswende. :Rückgabe:

end_dialog
get_version
on_dialog_event

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

reprompt_dialog
resume_dialog

Die Methode wird aufgerufen, wenn eine Instanz des Dialogfelds von einem anderen Dialogfeld zurückgegeben wird, das von der aktuellen Instanz mithilfe von begin_dialog()gestartet wurde. Wenn diese Methode NICHT implementiert ist, wird das Dialogfeld automatisch mit einem Aufruf von end_dialog()beendet. Jedes ergebnis, das aus dem aufgerufenen Dialogfeld übergeben wird, wird an das übergeordnete Dialogfeld übergeben. :p aram dialog_context: Der Dialogkontext für die aktuelle Unterhaltungswende. :p aram-Grund: Grund, warum das Dialogfeld fortgesetzt wurde. :p aram result: (Optional) value returned from the dialog that was called. Der Typ des zurückgegebenen Werts hängt vom aufgerufenen Dialogfeld ab. :Rückgabe:

begin_dialog

Die Methode wird aufgerufen, wenn ein neues Dialogfeld auf den Stapel verschoben wurde und aktiviert wird. :p aram dialog_context: Der Dialogkontext für die aktuelle Unterhaltungswende. :p aram-Optionen: (Optional) zusätzliche Argumente, die an das dialogfeld übergeben werden, das gestartet wird.

abstract async begin_dialog(dialog_context: DialogContext, options: object = None)

Parameter

Name Beschreibung
dialog_context
Erforderlich
options
Standardwert: None

continue_dialog

Die Methode wird aufgerufen, wenn eine Instanz des Dialogfelds das Dialogfeld "aktuell" ist und der Benutzer mit einer neuen Aktivität antwortet. Das Dialogfeld empfängt im Allgemeinen weiterhin die Antworten des Benutzers, bis er end_dialog() oder begin_dialog()aufruft. Wenn diese Methode NICHT implementiert ist, wird das Dialogfeld automatisch beendet, wenn der Benutzer antwortet. :p aram dialog_context: Der Dialogkontext für die aktuelle Unterhaltungswende. :Rückgabe:

async continue_dialog(dialog_context: DialogContext)

Parameter

Name Beschreibung
dialog_context
Erforderlich

end_dialog

async end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason)

Parameter

Name Beschreibung
context
Erforderlich
instance
Erforderlich
reason
Erforderlich

get_version

get_version() -> str

on_dialog_event

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

async on_dialog_event(dialog_context: DialogContext, dialog_event: DialogEvent) -> bool

Parameter

Name Beschreibung
dialog_context
Erforderlich

Der Dialogkontext für die aktuelle Unterhaltungswende.

dialog_event
Erforderlich

Das ausgelöste Ereignis.

Gibt zurück

Typ Beschreibung

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling beendet werden soll.

reprompt_dialog

async reprompt_dialog(context: TurnContext, instance: DialogInstance)

Parameter

Name Beschreibung
context
Erforderlich
instance
Erforderlich

resume_dialog

Die Methode wird aufgerufen, wenn eine Instanz des Dialogfelds von einem anderen Dialogfeld zurückgegeben wird, das von der aktuellen Instanz mithilfe von begin_dialog()gestartet wurde. Wenn diese Methode NICHT implementiert ist, wird das Dialogfeld automatisch mit einem Aufruf von end_dialog()beendet. Jedes ergebnis, das aus dem aufgerufenen Dialogfeld übergeben wird, wird an das übergeordnete Dialogfeld übergeben. :p aram dialog_context: Der Dialogkontext für die aktuelle Unterhaltungswende. :p aram-Grund: Grund, warum das Dialogfeld fortgesetzt wurde. :p aram result: (Optional) value returned from the dialog that was called. Der Typ des zurückgegebenen Werts hängt vom aufgerufenen Dialogfeld ab. :Rückgabe:

async resume_dialog(dialog_context: DialogContext, reason: DialogReason, result: object)

Parameter

Name Beschreibung
dialog_context
Erforderlich
reason
Erforderlich
result
Erforderlich

Attribute

id

telemetry_client

Ruft den Telemetrieclient für die Protokollierung von Ereignissen ab.

end_of_turn

end_of_turn = <botbuilder.dialogs.dialog_turn_result.DialogTurnResult object>