Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BotInterface

Bot Schnittstelle

Hierarchy

Index

Methods

Methods

addContextElement

  • addContextElement(aElementName: string, aContextName: string): number

  • Eintragen eines Elementes in den Kontext.

    Parameters

    • aElementName: string

      Name des Elementes, fuer das der Kontext eingetragen wird

    • aContextName: string

      Name des Kontextes

    Returns number

    Fehlercode 0 oder -1

addDialogActionEvent

  • Traegt eine Ereignisfunktion in das DialogAction Ereignis ein. DialogAction wird ausgeloest, wenn eine Aktion ausgefuhert werden soll. Die Aktionsdaten werden der Ereignisfunktion uebergeben.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogActionFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogActionStopEvent

  • Traegt eine Ereignisfunktion in das DialogActionStop Ereignis ein. DialogActionStop wird ausgeloest, wenn eine Aktion beendert werden soll.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogActionStopFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogJsonEvent

  • Traegt eine Ereignisfunktion in das DialogJson Ereignis ein. DialogJson wird ausgeloest, wenn Json-Daten umgewandelt worden sind.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogJsonFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogParseEvent

  • Traegt eine Ereignisfunktion in das DialogParse Ereignis ein. DialogParse wird ausgeloest, wenn ein Dialogskript geparst worden ist.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogParseFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogSetEvent

  • addDialogSetEvent(aPluginName: string, aEventFunc: OnDialogSetFunc): number

  • Traegt eine Ereignisfunktion in das DialogSet Ereignis ein. DialogSet wird ausgeloest, wenn ein neuer Dialogname eingetragen worden ist. Der Dialogname wird der Ereignisfunktion uebergeben.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogSetFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogSpeakEvent

  • Traegt eine Ereignisfunktion in das DialogSpeak Ereignis ein. DialogSpeak wird ausgeloest, wenn eine Sprachausgabe ausgefuehrt werden soll. Die Sprachausgabedaten werden der Ereignisfunktion uebergeben.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogSpeakFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogSpeakStartEvent

  • Traegt eine Ereignisfunktion in das DialogSpeakStart Ereignis ein. DialogSpeakStart wird ausgeloest, wenn eine Sprachausgabe gestartet wird.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogSpeakStartFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogSpeakStopEvent

  • Traegt eine Ereignisfunktion in das DialogSpeakStop Ereignis ein. DialogSpeakStop wird ausgeloest, wenn eine Sprachausgabe durch den Timeout beendert wird.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogSpeakStopFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogStartEvent

  • Traegt eine Ereignisfunktion in das DialogStart Ereignis ein. DialogStart wird ausgeloest, wenn ein Dialog gestartet wurde.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogStartFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogStateSetEvent

  • Traegt eine Ereignisfunktion in das DialogStateSet Ereignis ein. DialogStateSet wird ausgeloest, wenn ein neuer Dialogzustand eingetragen worden ist. Der Dialogzustand wird der Ereignisfunktion uebergeben.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogStateSetFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addDialogStopEvent

  • Traegt eine Ereignisfunktion in das DialogStop Ereignis ein. DialogStop wird ausgeloest, wenn ein Dialog beendet wurde.

    Parameters

    • aPluginName: string

      Name des Plugins, welches die Funktion eintragt

    • aEventFunc: OnDialogStopFunc

      Funktion, die Ereignis verarbeitet

    Returns number

    Fehlercode 0 oder -1

addErrorEvent

  • addErrorEvent(aPluginName: string, aEventFunc: OnSpeechErrorFunc): number

  • Anmelden einer Ereignis Callback-Funktion fuer die Fehler der Aktion

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    • aEventFunc: OnSpeechErrorFunc

      Ereignis Callback Funktion

    Returns number

    Fehlercode 0 oder -1

addInitEvent

  • addInitEvent(aPluginName: string, aEventFunc: OnSpeechInitFunc): number

  • Anmelden einer Ereignis Callback-Funktion fuer die Initialisierung

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    • aEventFunc: OnSpeechInitFunc

      Ereignis Callback Funktion

    Returns number

    Fehlercode 0 oder -1

addStartEvent

  • Anmelden einer Ereignis Callback-Funktion fuer den Start der Aktion

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    • aEventFunc: OnBaseStartFunc

      Ereignis Callback Funktion

    Returns number

    Fehlercode 0 oder -1

addStopEvent

  • addStopEvent(aPluginName: string, aEventFunc: OnBaseStopFunc): number

  • Anmelden einer Ereignis Callback-Funktion fuer den Stop der Aktion

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    • aEventFunc: OnBaseStopFunc

      Ereignis Callback Funktion

    Returns number

    Fehlercode 0 oder -1

clearContext

  • clearContext(): number

  • Loeschen des aktuellen Kontextes

    Returns number

    Fehlercode 0 oder -1

clearDialog

  • clearDialog(): number

  • Loeschen des Dialogspeichers.

    Returns number

    Fehlercode 0 oder -1

getAction

  • Rueckgabe des ActionInterface, um direkt in Bot auf die Action-Komponente zugreifen zu koennen.

    Returns ActionInterface

    Action-Komponente in Bot

getDialog

  • getDialog(): string

  • Rueckgabe des aktuell eingestellten Dialognamens.

    Returns string

    Name des aktuell ausfuehrbaren Dialogs

getDialogFileName

  • getDialogFileName(): string

  • Rueckgabe des aktuellen Defaultnamens des Dialogskriptes.

    Returns string

    Dialogskriptdateiname

getDialogFilePath

  • getDialogFilePath(): string

  • Rueckgabe des aktuellen Dialogdateiverzeichnisses fuer alle Dialogskripte.

    return {string} Dialogverzeichnis der Dialogskripte

    Returns string

getDialogState

  • getDialogState(): string

  • Gibt den aktuell eingestellten Dialogzustand zurueck.

    Returns string

    Name des aktuell eingestellten Dialogzustands

getListen

  • Rueckgabe des ListenInterface, um direkt in Bot auf die Listen-Komponente zugreifen zu koennen.

    Returns ListenInterface

    Listen-Komponente in Bot

getName

  • getName(): string

  • Name der konkreten Komponente zurueckgeben

    Returns string

    componentName

getServerVersion

  • getServerVersion(): string

  • Server-Version der Komponente zurueckgeben

    Returns string

    componentVersion

getSpeak

  • Rueckgabe des SpeakInterface, um direkt in Bot auf die Speak-Komponente zugreifen zu koennen.

    Returns SpeakInterface

    Speak-Komponente in Bot

getType

  • getType(): string

  • Typ des Komponenten-Interfaces zurueckgeben

    Returns string

    typeName

getVersion

  • getVersion(): string

  • Version der Komponente zurueckgeben

    Returns string

    componentVersion

isAction

  • isAction(): boolean

  • Prueft, ob die Action-Komponente eingeschaltet ist. Nur dann wird sie vom Bot auch verwendet.

    Returns boolean

    True, wenn Action-Komponente von Bot verwendet wird, sonst False

isActive

  • isActive(): boolean

  • pruefen auf aktive Komponente

    Returns boolean

    activeFlag

isErrorOutput

  • isErrorOutput(): boolean

  • pruefen auf Fehlerausgabe auf die Konsole

    Returns boolean

    errorOutputFlag

isListen

  • isListen(): boolean

  • Prueft, ob die Listen-Komponente eingeschaltet ist. Nur dann wird sie vom Bot auch verwendet.

    Returns boolean

    True, wenn Listen-Komponente von Bot verwendet wird, sonst False

isRunning

  • isRunning(): boolean

  • pruefen, ob Komponente gerade beschaeftigt ist

    Returns boolean

    True, Komponente ist beschaeftigt, False sonst

isSpeak

  • isSpeak(): boolean

  • Prueft, ob die Speak-Komponente eingeschaltet ist. Nur dann wird sie vom Bot auch verwendet.

    Returns boolean

    True, wenn Speak-Komponente von Bot verwendet wird, sonst False

loadDialogFile

  • loadDialogFile(aDialogFileName: string): number

  • Laden eines Dialogskriptes in den Dialogspeicher, um ihn ausfuehren zu koennen.

    Parameters

    • aDialogFileName: string

      Name des Dialogskripts

    Returns number

    Fehlercode 0 oder -1

parseSpeechDefData

  • parseSpeechDefData(aDefData: string): number

  • Parsen eines Dialogskripttextes

    Parameters

    • aDefData: string

      Dialogskripttext, der geparst weren soll

    Returns number

    Fehlercode 0 oder -1

parseSpeechDefFile

  • parseSpeechDefFile(aDefFileName: string): number

  • Parsen einer Dialogskriptdatei

    Parameters

    • aDefFileName: string

      Name der Dialogskriptdatei, die geparst werden soll

    Returns number

    Fehlercode 0 oder -1

removeAllEvent

  • removeAllEvent(aPluginName: string): number

  • Entfernen aller angemeldeten Ereignisfunktionen

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    Returns number

    Fehlercode 0 oder -1

removeContextElement

  • removeContextElement(aElementName: string, aContextName: string): number

  • Entfernen eines Elementes in den Kontext.

    Parameters

    • aElementName: string

      Name des Elementes, fuer das der Kontext entfernt wird

    • aContextName: string

      Name des Kontextes

    Returns number

    Fehlercode 0 oder -1

removeDialogActionEvent

  • removeDialogActionEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogAction Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogActionStopEvent

  • removeDialogActionStopEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogActionStop Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogJsonEvent

  • removeDialogJsonEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogJson Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogParseEvent

  • removeDialogParseEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogParse Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogSetEvent

  • removeDialogSetEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogSet Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogSpeakEvent

  • removeDialogSpeakEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogSpeak Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogSpeakStartEvent

  • removeDialogSpeakStartEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogSpeakStart Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogSpeakStopEvent

  • removeDialogSpeakStopEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogSpeakStop Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogStartEvent

  • removeDialogStartEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogStart Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogStateSetEvent

  • removeDialogStateSetEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogStateSet Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeDialogStopEvent

  • removeDialogStopEvent(aPluginName: string): number

  • Entfernt die Ereignisfunktion aus dem DialogStop Ereignis.

    Parameters

    • aPluginName: string

      Name des Plugins, von dem die Funktion entfernt werden soll

    Returns number

    Fehlercode 0 oder -1

removeErrorEvent

  • removeErrorEvent(aPluginName: string): number

  • Entfernen der Ereignisfunktion fuer die Fehler der Aktion

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    Returns number

    Fehlercode 0 oder -1

removeInitEvent

  • removeInitEvent(aPluginName: string): number

  • Entfernen der Ereignisfunktion fuer die Initialisierung

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    Returns number

    Fehlercode 0 oder -1

removeStartEvent

  • removeStartEvent(aPluginName: string): number

  • Entfernen der Ereignisfunktion fuer den Start der Aktion

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    Returns number

    Fehlercode 0 oder -1

removeStopEvent

  • removeStopEvent(aPluginName: string): number

  • Entfernen der Ereignisfunktion fuer den Stop der Aktion

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    Returns number

    Fehlercode 0 oder -1

reset

  • reset(aOption?: any): number

  • Komponente auf initialen Zustand zuruecksetzen

    Parameters

    • Optional aOption: any

      optionale Parameter

    Returns number

setActionOff

  • setActionOff(): number

  • Schaltet die Action-Komponente aus, so dass sie von Bot nicht mehr verwendet wird. Die Aktionen werden nicht mehr an Action weitergereicht.

    Returns number

setActionOn

  • setActionOn(): number

  • Schaltet die Action-Komponente ein, um sie im Bot zu verwenden. Die Aktionen werden dann an Action weitergereicht.

    Returns number

    Fehlercode 0 oder -1

setActiveOff

  • setActiveOff(): number

  • Komponente daktivieren

    Returns number

    Fehlercode oder -1

setActiveOn

  • setActiveOn(): number

  • Komponente aktivieren

    Returns number

    Fehercode 0 oder -1

setDialog

  • setDialog(aDialogName: string): number

  • Eintragen eines Dialognamens, um den Dialog ausfuehren zu koennen. Ein bereits laufender Dialog wird beendet.

    Parameters

    • aDialogName: string

      Name des Dialogs, der im geladenen Dialogskript enthalten sein muss

    Returns number

    Fehlercode 0 oder -1

setDialogFileName

  • setDialogFileName(aDialogFileName: string): number

  • Eintragen eines Default-Dialogsktiptdateinamens.

    Parameters

    • aDialogFileName: string

      Name des Dialogskriptes

    Returns number

setDialogFilePath

  • setDialogFilePath(aDialogFilePath: string): number

  • Eintragen des Dialogdateiverzeichnisses, in dem die Dialogskripte abgelegt sind.

    Parameters

    • aDialogFilePath: string

      lokales Dateiverzeichnis fuer alle Dialogdateien

    Returns number

    Fehlercode 0 oder -1

setDialogState

  • Setzt einen aktuellen Dialogzustand, der ausgefuhert werden kann. Der Dialogzustand ist die kleinste auszufuehrende Einheit eines Dialogs. Ein laufender Dialog wird beendet.

    Parameters

    • aState: string

      Name des zu setzenden Dialogzustands

    • Optional aContext: DialogStateContextInterface

      optionaler Kontext fuer den Dialogzustand

    Returns number

    Fehlercode 0 oder -1

setDialogStateContext

setErrorOutputOff

  • setErrorOutputOff(): void

setErrorOutputOn

  • setErrorOutputOn(): void

setListenOff

  • setListenOff(): number

  • Schaltet die Listen-Komponente aus, so dass sie von Bot nicht mehr verwendet wird. Die Spracheingabe wird nicht mehr an Listen weitergereicht.

    Returns number

setListenOn

  • setListenOn(): number

  • Schaltet die Listen-Komponente ein, um sie im Bot zu verwenden. Die Spracheingabe wird dann an Listen weitergereicht.

    Returns number

    Fehlercode 0 oder -1

setSpeakOff

  • setSpeakOff(): number

  • Schaltet die Speak-Komponente aus, so dass sie von Bot nicht mehr verwendet wird. Die Sprachausgabe wird nicht mehr an Speak weitergereicht.

    Returns number

setSpeakOn

  • setSpeakOn(): number

  • Schaltet die Speak-Komponente ein, um sie im Bot zu verwenden. Die Sprachausgabe wird dann an Speak weitergereicht.

    Returns number

    Fehlercode 0 oder -1

skipNextSpeak

  • skipNextSpeak(): number

  • Ueberspringt eine Sprachausgabe.

    Returns number

    Fehlercode 0 oder -1

start

  • start(): number

  • Startet die Aufgabe.

    Returns number

    Fehlercode 0 oder -1

stop

  • stop(): number

  • Stoppt die Aufgabe

    Returns number

    Fehlercode 0 oder -1

test

  • test(aTestCommand: string, aTestData?: any): any

  • Fuehrt Testkommandos aus, um interne Tests ablaufen lassen zu koennen

    Parameters

    • aTestCommand: string

      Testkommando

    • Optional aTestData: any

      optionale Testdaten

    Returns any

    Rueckgabe der Testergebnisse

toggleDialog

  • toggleDialog(): number

  • Schaltet zwischen Dialog ausfuehren und Dialog beenden hin und her.

    Returns number

    Fehlercode 0 oder -1

transformJsonData

transformJsonFile

  • transformJsonFile(aDefFileName: string): number

  • Umwandlung einer Json-Datei

    Parameters

    • aDefFileName: string

    Returns number

    Fehlercode 0 oder -1

writeDialogData

  • writeDialogData(aDialogData: string): number

  • schreiben eines Dialogskripttextes in den Dialogspeicher, um ihn ausfuehren zu koennen.

    Parameters

    • aDialogData: string

      Dialogskripttext

    Returns number

    Fehlercode 0 oder -1

Generated using TypeDoc