Session class

Paket:

botbuilder

Verwaltet die Bots-Unterhaltung mit einem Benutzer.

Konstruktoren

Session(ISessionOptions)

Erstellt eine Instanz der Sitzung.

Eigenschaften

connector	Der Connector, der für diese Sitzung verwendet wird.
conversationData	Freigegebene Unterhaltungsdaten, die für alle Mitglieder der Unterhaltung sichtbar sind.
dialogData	Daten, die nur für das aktuelle Dialogfeld sichtbar sind.
library	Die Bots-Stammbibliothek von Dialogfeldern.
localizer	Der Lokalisierer für die aktuelle Sitzung.
message	Die vom Benutzer empfangene Nachricht. Für Bot-ursprungsnachrichten darf dies nur die "to"-& "von"-Feldern enthalten.
privateConversationData	Private Unterhaltungsdaten, die nur für den Benutzer sichtbar sind.
sessionState	Aktuelle Statusinformationen für Sitzungen.
userData	Daten für den Benutzer, der über alle Unterhaltungen mit dem Bot hinweg beibehalten wird.

Methoden

activeDialogStackEntry(IDialogState[])	Gibt ein aktives Dialogfeld oder null vom Stapel zurück.
beginDialog<T>(string, T)	Übergibt die Steuerung der Unterhaltung an ein neues Dialogfeld. Das aktuelle Dialogfeld wird angehalten, bis das untergeordnete Dialogfeld abgeschlossen ist. Sobald das untergeordnete Element das aktuelle Dialogfeld beendet hat, wird ein Aufruf von dialogResumed() empfangen, in dem alle vom untergeordneten Element zurückgegebenen Ergebnisse überprüft werden können.
cancelDialog(string | number, string, any)	Bricht ein vorhandenes Dialogfeld ab und startet optional ein neues Dialogfeld, an dem es sich befindet. Im Gegensatz zu endDialog() und replaceDialog(), die sich auf das aktuelle Dialogfeld auswirken, können Sie mit dieser Methode ein übergeordnetes Dialogfeld an einer beliebigen Stelle im Stapel beenden. Das übergeordnete Element des abgebrochenen Dialogfelds wird fortgesetzt, als ob das Dialogfeld "endDialog() aufgerufen wurde". Ein spezielles ResumeReason.canceled wird zurückgegeben, um anzugeben, dass das Dialogfeld abgebrochen wurde.
clearDialogStack()	Löscht den aktuellen Dialogstapel.
delay(number)	Fügt eine Verzögerung zwischen ausgehenden Nachrichten ein.
dialogStack(IDialogState[])	Ruft ab/legt den aktuellen Dialogstapel fest. Eine Kopie des aktuellen Dialogfelds wird zurückgegeben. Wenn änderungen an dem zurückgegebenen Stapel vorgenommen werden, müssen sie über einen zweiten Aufruf von session.dialogStack()wieder in die Sitzung kopiert werden.
dispatch(ISessionState, IMessage, Function)	Beendet die Initialisierung des Sitzungsobjekts und leitet die Sitzung dann über alle installierten Middleware weiter. Die übergebene next()-Funktion wird als letzter Schritt der Middlewarekette aufgerufen.
endConversation(TextOrMessageType, any[])	Beendet die aktuelle Unterhaltung und sendet optional eine Nachricht an den Benutzer.
endDialog(TextOrMessageType, any[])	Beendet das aktuelle Dialogfeld und sendet optional eine Nachricht an den Benutzer. Das übergeordnete Element wird mit einem IDialogResult.resumed Grund für abgeschlossenenfortgesetzt.
endDialogWithResult(IDialogResult<any>)	Beendet das aktuelle Dialogfeld und gibt optional ein Ergebnis an das übergeordnete Dialogfeld zurück.
error(Error)	Signal, dass ein Fehler aufgetreten ist. Der Bot signalisiert den Fehler über ein on('error', err)-Ereignis.
findDialogStackEntry(IDialogState[], string, boolean)	Durchsucht einen Dialogfeldstapel nach einem bestimmten Dialogfeld, entweder in vorwärts oder umgekehrter Richtung, und gibt seinen Index zurück.
forEachDialogStackEntry(IDialogState[], boolean, (entry: IDialogState, index: number) => void)	Listet alle Einträge eines Stacks-Dialogfelds in vorwärts oder umgekehrt auf.
gettext(string, any[])	Lädt eine lokalisierte Zeichenfolge für die Nachrichtensprache. Wenn Argumente übergeben werden, wird die lokalisierte Zeichenfolge als Vorlage behandelt und mithilfe sprintf-js- formatiert (details hierzu finden Sie in den Dokumenten).)
isReset()	Gibt true zurück, wenn die Sitzung zurückgesetzt wurde.
messageSent()	Gibt true zurück, wenn eine Nachricht für diese Sitzung gesendet wurde.
ngettext(string, string, number)	Lädt die Pluralform einer lokalisierten Zeichenfolge für die Nachrichtensprache. Die Ausgabezeichenfolge wird so formatiert, dass sie die Anzahl enthält, indem %d in der Zeichenfolge durch die Anzahl ersetzt wird.
on(string, (data: any) => void)	Registriert einen Ereignislistener.
popDialogStackEntry(IDialogState[])	Pops the active dialog off a stack and returns the new one if the stack isn't empty.
preferredLocale(string, (err: Error) => void)	Gibt das bevorzugte Gebietsschema zurück, wenn keine Parameter angegeben werden, andernfalls wird das bevorzugte Gebietsschema festgelegt.
pruneDialogStack(IDialogState[], number)	Löscht alle Dialogstapeleinträge beginnend mit dem angegebenen Index und gibt das neue aktive Dialogfeld zurück.
pushDialogStackEntry(IDialogState[], IDialogState)	Verschiebt ein neues Dialogfeld auf einen Stapel und gibt es als aktives Dialogfeld zurück.
replaceDialog<T>(string, T)	Beendet das aktuelle Dialogfeld und startet einen neuen Ort. Das übergeordnete Dialogfeld wird erst fortgesetzt, wenn das neue Dialogfeld abgeschlossen ist.
reset(string, any)	Löscht den Aufrufstack der Sitzungen und startet die Unterhaltung mit der konfigurierten dialogId neu.
routeToActiveDialog(IRecognizeResult)	Verteilt die Sitzung entweder an das aktive Dialogfeld oder das Standarddialogfeld für die Verarbeitung.
save()	Löst das Speichern von Änderungen aus, die an dialogData-, userData-, unterhaltungsdatenoder [privateConversationData'(#privateconversationdata) vorgenommen wurden.
say(TextType, IMessageOptions)
say(TextType, TextType, IMessageOptions)	Sendet eine Nachricht an den Benutzer, und optional SSML.
sayLocalized(string, TextType, TextType, IMessageOptions)	Sendet eine Nachricht mit einem bestimmten Lokalisierungsnamespace und optionalen SSML-Nachrichten an den Benutzer.
send(TextOrMessageType, any[])	Sendet eine Nachricht an den Benutzer.
sendBatch((err: Error, addresses?: IAddress[]) => void)	Beendet sofort den aktuellen Batch und liefert alle in die Warteschlange eingereihten Nachrichten.
sendLocalized(string, TextOrMessageType, any[])	Sendet eine Nachricht an einen Benutzer mithilfe eines bestimmten Lokalisierungsnamespaces.
sendTyping()	Sendet dem Benutzer einen Hinweis darauf, dass der Bot eingabet. Bei Vorgängen mit langer Ausführung sollte dies alle paar Sekunden aufgerufen werden.
toRecognizeContext()	Gibt das Sitzungsobjekt als schreibgeschütztes Kontextobjekt zurück.
validateDialogStack(IDialogState[], Library)	Stellt sicher, dass alle Einträge in einem Dialogstapel auf gültige Dialogfelder innerhalb einer Bibliothekshierarchie verweisen.
watch(string, boolean)	Aktiviert/deaktiviert eine Überwachung für die aktuelle Sitzung.
watchable(string, IWatchableHandler)	Fügt eine Variable hinzu oder ruft sie ab, die überwacht werden kann.
watchableList()	Gibt eine Liste der überwachten Variablen zurück.
watchList()	Gibt die aktuelle Liste der überwachten Variablen für die Sitzung zurück.

Details zum Konstruktor

Session(ISessionOptions)

Erstellt eine Instanz der Sitzung.

new Session(options: ISessionOptions)

Parameter

options

ISessionOptions

Konfigurationsoptionen für Sitzungen.

Details zur Eigenschaft

connector

Der Connector, der für diese Sitzung verwendet wird.

connector: IConnector

Eigenschaftswert

IConnector

conversationData

Freigegebene Unterhaltungsdaten, die für alle Mitglieder der Unterhaltung sichtbar sind.

conversationData: any

Eigenschaftswert

any

dialogData

Daten, die nur für das aktuelle Dialogfeld sichtbar sind.

dialogData: any

Eigenschaftswert

any

library

Die Bots-Stammbibliothek von Dialogfeldern.

library: Library

Eigenschaftswert

Library

localizer

Der Lokalisierer für die aktuelle Sitzung.

localizer: ILocalizer

Eigenschaftswert

ILocalizer

message

Die vom Benutzer empfangene Nachricht. Für Bot-ursprungsnachrichten darf dies nur die "to"-& "von"-Feldern enthalten.

message: IMessage

Eigenschaftswert

IMessage

privateConversationData

Private Unterhaltungsdaten, die nur für den Benutzer sichtbar sind.

privateConversationData: any

Eigenschaftswert

any

sessionState

Aktuelle Statusinformationen für Sitzungen.

sessionState: ISessionState

Eigenschaftswert

ISessionState

userData

Daten für den Benutzer, der über alle Unterhaltungen mit dem Bot hinweg beibehalten wird.

userData: any

Eigenschaftswert

any

Details zur Methode

activeDialogStackEntry(IDialogState[])

Gibt ein aktives Dialogfeld oder null vom Stapel zurück.

static function activeDialogStackEntry(stack: IDialogState[])

Parameter

stack

IDialogState[]

Der Dialogstapel, für den der Eintrag zurückgegeben werden soll.

Gibt zurück

IDialogState

beginDialog<T>(string, T)

Übergibt die Steuerung der Unterhaltung an ein neues Dialogfeld. Das aktuelle Dialogfeld wird angehalten, bis das untergeordnete Dialogfeld abgeschlossen ist. Sobald das untergeordnete Element das aktuelle Dialogfeld beendet hat, wird ein Aufruf von dialogResumed() empfangen, in dem alle vom untergeordneten Element zurückgegebenen Ergebnisse überprüft werden können.

function beginDialog<T>(id: string, args?: T)

Parameter

id

string

Eindeutige ID des zu startenden Dialogfelds.

args

T

(Optional) Argumente, die an die Dialoge begin() Methode übergeben werden sollen.

Gibt zurück

Session

cancelDialog(string | number, string, any)

Bricht ein vorhandenes Dialogfeld ab und startet optional ein neues Dialogfeld, an dem es sich befindet. Im Gegensatz zu endDialog() und replaceDialog(), die sich auf das aktuelle Dialogfeld auswirken, können Sie mit dieser Methode ein übergeordnetes Dialogfeld an einer beliebigen Stelle im Stapel beenden. Das übergeordnete Element des abgebrochenen Dialogfelds wird fortgesetzt, als ob das Dialogfeld "endDialog() aufgerufen wurde". Ein spezielles ResumeReason.canceled wird zurückgegeben, um anzugeben, dass das Dialogfeld abgebrochen wurde.

function cancelDialog(dialogId: string | number, replaceWithId?: string, replaceWithArgs?: any)

Parameter

dialogId

string | number

• dialogId:{string}- – ID des zu beendenden Dialogfelds. Wenn mehrere Vorkommen des Dialogfelds im Dialogstapel vorhanden sind, wird der letzte Auftreten abgebrochen.
• dialogId:{number}- - Index des Dialogfelds im Stapel, um abzubrechen. Dies ist die bevorzugte Möglichkeit, ein Dialogfeld aus einem Aktionshandler abzubrechen, da sichergestellt wird, dass die richtige Instanz abgebrochen wird.

replaceWithId

string

(Optional) gibt eine ID an, die in den abgebrochenen Dialogfeldern gestartet werden soll. Dadurch wird verhindert, dass die übergeordneten Dialogfelder fortgesetzt werden.

replaceWithArgs

any

(Optional) Argumente, die an das neue Dialogfeld übergeben werden sollen.

Gibt zurück

Session

clearDialogStack()

Löscht den aktuellen Dialogstapel.

function clearDialogStack()

Gibt zurück

Session

delay(number)

Fügt eine Verzögerung zwischen ausgehenden Nachrichten ein.

function delay(delay: number)

Parameter

delay

number

Anzahl der Millisekunden, für die angehalten werden soll.

Gibt zurück

Session

dialogStack(IDialogState[])

Ruft ab/legt den aktuellen Dialogstapel fest. Eine Kopie des aktuellen Dialogfelds wird zurückgegeben. Wenn änderungen an dem zurückgegebenen Stapel vorgenommen werden, müssen sie über einen zweiten Aufruf von session.dialogStack()wieder in die Sitzung kopiert werden.

function dialogStack(newStack?: IDialogState[])

Parameter

newStack

IDialogState[]

(Optional) Dialogstapel, der der Sitzung zugewiesen werden soll. Die Sitzungen dialogData- werden aktualisiert, um den Status des neuen aktiven Dialogfelds widerzuspiegeln.

Gibt zurück

IDialogState[]

dispatch(ISessionState, IMessage, Function)

Beendet die Initialisierung des Sitzungsobjekts und leitet die Sitzung dann über alle installierten Middleware weiter. Die übergebene next()-Funktion wird als letzter Schritt der Middlewarekette aufgerufen.

function dispatch(sessionState: ISessionState, message: IMessage, next: Function)

Parameter

sessionState

ISessionState

Der aktuelle Sitzungsstatus. Wenn null eine neue Unterhaltung gestartet wird, beginnt mit der konfigurierten dialogId.

message

IMessage

Die Nachricht, die durch Middleware geleitet werden soll.

next

Function

Die Funktion, die als letzter Schritt der Middlewarekette aufgerufen werden soll.

Gibt zurück

Session

endConversation(TextOrMessageType, any[])

Beendet die aktuelle Unterhaltung und sendet optional eine Nachricht an den Benutzer.

function endConversation(message?: TextOrMessageType, args: any[])

Parameter

message

TextOrMessageType

(Optional) Text/Nachricht, um den Benutzer zu senden, bevor die Unterhaltung beendet wird.

args

any[]

(Optional) Argumente, die zum Formatieren des endgültigen Ausgabetexts verwendet werden, wenn Nachricht eine {string|string[]}ist.

Gibt zurück

Session

endDialog(TextOrMessageType, any[])

Beendet das aktuelle Dialogfeld und sendet optional eine Nachricht an den Benutzer. Das übergeordnete Element wird mit einem IDialogResult.resumed Grund für abgeschlossenenfortgesetzt.

function endDialog(message?: TextOrMessageType, args: any[])

Parameter

message

TextOrMessageType

(Optional) Text/Nachricht, um den Benutzer zu senden, bevor das Dialogfeld beendet wird.

args

any[]

(Optional) Argumente, die zum Formatieren des endgültigen Ausgabetexts verwendet werden, wenn Nachricht eine {string|string[]}ist.

Gibt zurück

Session

endDialogWithResult(IDialogResult<any>)

Beendet das aktuelle Dialogfeld und gibt optional ein Ergebnis an das übergeordnete Dialogfeld zurück.

function endDialogWithResult(result?: IDialogResult<any>)

Parameter

result

IDialogResult<any>

(Optional) Ergebnis, das dem Benutzer gesendet werden soll. Der Wert, den Sie zurückgeben möchten, sollte sich im feld Antwort befinden.

Gibt zurück

Session

error(Error)

Signal, dass ein Fehler aufgetreten ist. Der Bot signalisiert den Fehler über ein on('error', err)-Ereignis.

function error(err: Error)

Parameter

err

Error

Fehler, der aufgetreten ist.

Gibt zurück

Session

findDialogStackEntry(IDialogState[], string, boolean)

Durchsucht einen Dialogfeldstapel nach einem bestimmten Dialogfeld, entweder in vorwärts oder umgekehrter Richtung, und gibt seinen Index zurück.

static function findDialogStackEntry(stack: IDialogState[], dialogId: string, reverse?: boolean)

Parameter

stack

IDialogState[]

Der zu durchsuchende Dialogstapel.

dialogId

string

Die eindeutige ID des Dialogfelds im <namespace>:<dialog> Format, nach dem gesucht werden soll.

reverse

boolean

(Optional) Wenn true, wird der Stapel beginnend mit dem aktiven Dialogfeld durchsucht und funktioniert bis zum Stamm.

Gibt zurück

number

forEachDialogStackEntry(IDialogState[], boolean, (entry: IDialogState, index: number) => void)

Listet alle Einträge eines Stacks-Dialogfelds in vorwärts oder umgekehrt auf.

static function forEachDialogStackEntry(stack: IDialogState[], reverse: boolean, fn: (entry: IDialogState, index: number) => void)

Parameter

stack

IDialogState[]

Der Dialogfeldstapel, der aufgezählt werden soll.

reverse

boolean

Wenn true die Einträge beginnend mit dem aktiven Dialogfeld aufgezählt und bis zum Stammdialogfeld bearbeitet werden.

fn

(entry: IDialogState, index: number) => void

Funktion, die mit jedem Eintrag im Stapel aufgerufen werden soll.

gettext(string, any[])

Lädt eine lokalisierte Zeichenfolge für die Nachrichtensprache. Wenn Argumente übergeben werden, wird die lokalisierte Zeichenfolge als Vorlage behandelt und mithilfe sprintf-js- formatiert (details hierzu finden Sie in den Dokumenten).)

function gettext(msgid: string, args: any[])

Parameter

msgid

string

Zeichenfolge, die als Schlüssel in der lokalisierten Zeichenfolgentabelle verwendet werden soll. In der Regel ist dies nur die englische Version der Zeichenfolge.

args

any[]

(Optional) Argumente, die zum Formatieren der endgültigen Ausgabezeichenfolge verwendet werden.

Gibt zurück

string

isReset()

Gibt true zurück, wenn die Sitzung zurückgesetzt wurde.

function isReset()

Gibt zurück

boolean

messageSent()

Gibt true zurück, wenn eine Nachricht für diese Sitzung gesendet wurde.

function messageSent()

Gibt zurück

boolean

ngettext(string, string, number)

Lädt die Pluralform einer lokalisierten Zeichenfolge für die Nachrichtensprache. Die Ausgabezeichenfolge wird so formatiert, dass sie die Anzahl enthält, indem %d in der Zeichenfolge durch die Anzahl ersetzt wird.

function ngettext(msgid: string, msgid_plural: string, count: number)

Parameter

msgid

string

Singularform der Zeichenfolge, die als Schlüssel in der lokalisierten Zeichenfolgentabelle verwendet werden soll. Verwenden Sie %d, um anzugeben, wo die Anzahl liegen soll.

msgid_plural

string

Pluralform der Zeichenfolge, die als Schlüssel in der lokalisierten Zeichenfolgentabelle verwendet werden soll. Verwenden Sie %d, um anzugeben, wo die Anzahl liegen soll.

count

number

Anzahl, die verwendet werden soll, wenn bestimmt wird, ob die Singular- oder Pluralform der Zeichenfolge verwendet werden soll.

Gibt zurück

string

on(string, (data: any) => void)

Registriert einen Ereignislistener.

function on(event: string, listener: (data: any) => void)

Parameter

event

string

Name des Ereignisses. Ereignistypen:

• Fehler: Ein Fehler ist aufgetreten. Übergibt ein JavaScript-Error-Objekt.

listener

(data: any) => void

Funktion, die aufgerufen werden soll.

popDialogStackEntry(IDialogState[])

Pops the active dialog off a stack and returns the new one if the stack isn't empty.

static function popDialogStackEntry(stack: IDialogState[])

Parameter

stack

IDialogState[]

Der zu aktualisierende Dialogstapel.

Gibt zurück

IDialogState

preferredLocale(string, (err: Error) => void)

Gibt das bevorzugte Gebietsschema zurück, wenn keine Parameter angegeben werden, andernfalls wird das bevorzugte Gebietsschema festgelegt.

function preferredLocale(locale?: string, callback?: (err: Error) => void)

Parameter

locale

string

(Optional) das Gebietsschema, das zum Lokalisieren von Nachrichten verwendet werden soll.

callback

(err: Error) => void

(Optional) Funktion, die aufgerufen wird, wenn die Lokalisierungstabelle für das angegebene Gebietsschema geladen wurde.

Gibt zurück

string

pruneDialogStack(IDialogState[], number)

Löscht alle Dialogstapeleinträge beginnend mit dem angegebenen Index und gibt das neue aktive Dialogfeld zurück.

static function pruneDialogStack(stack: IDialogState[], start: number)

Parameter

stack

IDialogState[]

Der zu aktualisierende Dialogstapel.

start

number

Index des ersten zu entfernenden Elements.

Gibt zurück

IDialogState

pushDialogStackEntry(IDialogState[], IDialogState)

Verschiebt ein neues Dialogfeld auf einen Stapel und gibt es als aktives Dialogfeld zurück.

static function pushDialogStackEntry(stack: IDialogState[], entry: IDialogState)

Parameter

stack

IDialogState[]

Der zu aktualisierende Dialogstapel.

entry

IDialogState

Dialogeintrag, der auf den Stapel übertragen werden soll.

Gibt zurück

IDialogState

replaceDialog<T>(string, T)

Beendet das aktuelle Dialogfeld und startet einen neuen Ort. Das übergeordnete Dialogfeld wird erst fortgesetzt, wenn das neue Dialogfeld abgeschlossen ist.

function replaceDialog<T>(id: string, args?: T)

Parameter

id

string

Eindeutige ID des zu startenden Dialogfelds.

args

T

(Optional) Argumente, die an die Dialoge begin() Methode übergeben werden sollen.

Gibt zurück

Session

reset(string, any)

Löscht den Aufrufstack der Sitzungen und startet die Unterhaltung mit der konfigurierten dialogId neu.

function reset(dialogId?: string, dialogArgs?: any)

Parameter

dialogId

string

(Optional) ID des zu startenden Dialogfelds.

dialogArgs

any

(Optional) Argumente, die an die Dialoge begin() Methode übergeben werden sollen.

Gibt zurück

Session

routeToActiveDialog(IRecognizeResult)

Verteilt die Sitzung entweder an das aktive Dialogfeld oder das Standarddialogfeld für die Verarbeitung.

function routeToActiveDialog(recognizeResult?: IRecognizeResult)

Parameter

recognizeResult

IRecognizeResult

(Optional) Ergebnisse, die vom Aufrufen Library.findRoutes(), Library.findActiveDialogRoutes(), * oder Dialog.recognize()zurückgegeben werden.

save()

Löst das Speichern von Änderungen aus, die an dialogData-, userData-, unterhaltungsdatenoder [privateConversationData'(#privateconversationdata) vorgenommen wurden.

function save()

Gibt zurück

Session

say(TextType, IMessageOptions)

function say(text: TextType, options?: IMessageOptions)

Parameter

text

TextType

options

IMessageOptions

Gibt zurück

Session

say(TextType, TextType, IMessageOptions)

Sendet eine Nachricht an den Benutzer, und optional SSML.

function say(text: TextType, speak?: TextType, options?: IMessageOptions)

Parameter

text

TextType

Text, der an den Benutzer gesendet werden soll. Dies kann null sein, um nur SSML oder Anlagen zu senden.

speak

TextType

(Optional) Nachricht, die für den Benutzer gesprochen werden soll. Die Nachricht sollte alsSpeech Synthesis Markup Language (SSML) formatiert werden. Wenn ein Array übergeben wird, wird eine Antwort zufällig ausgewählt.

options

IMessageOptions

(Optional) Eigenschaften, die in die ausgehende Nachricht einbezogen werden sollen.

Gibt zurück

Session

sayLocalized(string, TextType, TextType, IMessageOptions)

Sendet eine Nachricht mit einem bestimmten Lokalisierungsnamespace und optionalen SSML-Nachrichten an den Benutzer.

function sayLocalized(libraryNamespace: string, text: TextType, speak?: TextType, options?: IMessageOptions)

Parameter

libraryNamespace

string

Namespace zum Lokalisieren der Nachricht verwenden.

text

TextType

Text, der an den Benutzer gesendet werden soll. Dies kann null sein, um nur SSML oder Anlagen zu senden.

speak

TextType

(Optional) Nachricht, die für den Benutzer gesprochen werden soll. Die Nachricht sollte alsSpeech Synthesis Markup Language (SSML) formatiert werden. Wenn ein Array übergeben wird, wird eine Antwort zufällig ausgewählt.

options

IMessageOptions

(Optional) Eigenschaften, die in die ausgehende Nachricht einbezogen werden sollen.

Gibt zurück

Session

send(TextOrMessageType, any[])

Sendet eine Nachricht an den Benutzer.

function send(message: TextOrMessageType, args: any[])

Parameter

message

TextOrMessageType

Text/Nachricht, die an den Benutzer gesendet werden soll. Wenn ein Array übergeben wird, wird eine Antwort zufällig ausgewählt.

args

any[]

(Optional) Argumente, die zum Formatieren des endgültigen Ausgabetexts verwendet werden, wenn Nachricht eine {string|string[]}ist.

Gibt zurück

Session

sendBatch((err: Error, addresses?: IAddress[]) => void)

Beendet sofort den aktuellen Batch und liefert alle in die Warteschlange eingereihten Nachrichten.

function sendBatch(done?: (err: Error, addresses?: IAddress[]) => void)

Parameter

done

(err: Error, addresses?: IAddress[]) => void

(Optional) Funktion, die aufgerufen wird, wenn der Batch aus irgendeinem Grund erfolgreich entliehen wurde oder fehlgeschlagen ist.

sendLocalized(string, TextOrMessageType, any[])

Sendet eine Nachricht an einen Benutzer mithilfe eines bestimmten Lokalisierungsnamespaces.

function sendLocalized(libraryNamespace: string, message: TextOrMessageType, args: any[])

Parameter

libraryNamespace

string

Namespace zum Lokalisieren der Nachricht verwenden.

message

TextOrMessageType

Text/Nachricht, die an den Benutzer gesendet werden soll.

args

any[]

(Optional) Argumente, die zum Formatieren des endgültigen Ausgabetexts verwendet werden, wenn Nachricht eine {string|string[]}ist.

Gibt zurück

Session

sendTyping()

Sendet dem Benutzer einen Hinweis darauf, dass der Bot eingabet. Bei Vorgängen mit langer Ausführung sollte dies alle paar Sekunden aufgerufen werden.

function sendTyping()

Gibt zurück

Session

toRecognizeContext()

Gibt das Sitzungsobjekt als schreibgeschütztes Kontextobjekt zurück.

function toRecognizeContext()

Gibt zurück

IRecognizeContext

validateDialogStack(IDialogState[], Library)

Stellt sicher, dass alle Einträge in einem Dialogstapel auf gültige Dialogfelder innerhalb einer Bibliothekshierarchie verweisen.

static function validateDialogStack(stack: IDialogState[], root: Library)

Parameter

stack

IDialogState[]

Der zu überprüfende Dialogstapel.

root

Library

Der Stamm der Bibliothekshierarchie, in der Regel der Bot.

Gibt zurück

boolean

watch(string, boolean)

Aktiviert/deaktiviert eine Überwachung für die aktuelle Sitzung.

function watch(variable: string, enable?: boolean)

Parameter

variable

string

Name der Variablen, die überwacht/unwatch verwendet werden soll.

enable

boolean

(Optional) Wenn true, wird die Variable überwacht, andernfalls wird sie nicht überwacht. Der Standardwert ist true.

Gibt zurück

Session

watchable(string, IWatchableHandler)

Fügt eine Variable hinzu oder ruft sie ab, die überwacht werden kann.

static function watchable(variable: string, handler?: IWatchableHandler)

Parameter

variable

string

Name der Variablen, die überwacht werden kann. Die Groß-/Kleinschreibung wird nur für die Anzeige verwendet.

handler

IWatchableHandler

(Optional) Funktion, die zum Abrufen der variablen aktuellen Wert verwendet wird. Wenn ein neuer Handler angegeben wird, wird ein neuer Handler registriert, andernfalls wird der vorhandene Handler abgerufen.

Gibt zurück

IWatchableHandler

watchableList()

Gibt eine Liste der überwachten Variablen zurück.

static function watchableList()

Gibt zurück

string[]

watchList()

Gibt die aktuelle Liste der überwachten Variablen für die Sitzung zurück.

function watchList()

Gibt zurück

string[]