Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IntentInterface

export

Intent Schnittstelle

Hierarchy

Index

Methods

abort

  • abort(): number
  • Sofortiger Abbruch der Spracheingabe ohne Resultate zurueckzugeben

    deprecated

    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

addIntentResultEvent

  • Eintragen eines Sprachanalyse-Ergebnis Events. Hier wird das Ergebnis der Sprachanalyse zurueckgegeben.

    Parameters

    • aPluginName: string

      Name des Plugins

    • aEventFunc: OnIntentResultFunc

      Ereignis-Behandlungsfunktion

    Returns number

    Fehlercode 0 oder -1

addListenResultEvent

  • Eintragen eines Spracheingabe-Ergebnis Events. Hier wird der Ergebnistext der Spracheingabe zurueckgegeben.

    deprecated

    Parameters

    • aPluginName: string

      Name des Plugins

    • aEventFunc: OnListenResultFunc

      Ereignis-Behandlungsfunktion

    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

getIntentText

  • getIntentText(): string
  • Rueckgabe des aktuell zu analysierenden Textes

    Returns string

    zu analysierender Text

getLanguage

  • getLanguage(): string
  • aktuell eingestellte Sprache zurueckgeben

    Returns string

    language - Kurzzeichenstring fuer Sprache ( de, en )

getLanguageList

  • getLanguageList(): Array<string>
  • Rueckgabe aller vorhandenen Language-Namen

    Returns Array<string>

    Liste der Language-Namen

getNLU

  • getNLU(): string
  • Rueckgabe des eingestellten NLU-Namens

    Returns string

    Name der aktuellen NLU

getNLUList

  • getNLUList(): Array<string>
  • Rueckgabe aller vorhandenen NLU-Namen

    Returns Array<string>

    Liste der NLU-Namen

getName

  • getName(): string
  • Name der konkreten Komponente zurueckgeben

    Returns string

    componentName

getServerVersion

  • getServerVersion(): string
  • Server-Version der Komponente zurueckgeben

    Returns string

    componentVersion

getType

  • getType(): string
  • Typ des Komponenten-Interfaces zurueckgeben

    Returns string

    typeName

getVersion

  • getVersion(): string
  • Version der Komponente zurueckgeben

    Returns string

    componentVersion

isActive

  • isActive(): boolean
  • pruefen auf aktive Komponente

    Returns boolean

    activeFlag

isErrorOutput

  • isErrorOutput(): boolean
  • pruefen auf Fehlerausgabe auf die Konsole

    Returns boolean

    errorOutputFlag

isNLU

  • isNLU(): boolean
  • pruefen auf vorhandene NLU

    Returns boolean

    True, wenn NLU vorhanden ist, False sonst

isRunning

  • isRunning(): boolean
  • pruefen, ob Komponente gerade beschaeftigt ist

    Returns boolean

    True, Komponente ist beschaeftigt, False sonst

removeAllEvent

  • removeAllEvent(aPluginName: string): number
  • Entfernen aller angemeldeten Ereignisfunktionen

    Parameters

    • aPluginName: string

      Name des Beobachter-Plugins

    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

removeIntentResultEvent

  • removeIntentResultEvent(aPluginName: string): number
  • Enfernen eines Sprachanalyse-Ergebnis Events.

    Parameters

    • aPluginName: string

      Name des Plugins

    Returns number

    Fehlercode 0 oder -1

removeListenResultEvent

  • removeListenResultEvent(aPluginName: string): number
  • Enfernen eines Spracheingabe-Ergebnis Events.

    deprecated

    Parameters

    • aPluginName: string

      Name des 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

setActiveOff

  • setActiveOff(): number
  • Komponente daktivieren

    Returns number

    Fehlercode oder -1

setActiveOn

  • setActiveOn(): number
  • Komponente aktivieren

    Returns number

    Fehercode 0 oder -1

setErrorOutputOff

  • setErrorOutputOff(): void

setErrorOutputOn

  • setErrorOutputOn(): void

setIntentText

  • setIntentText(aText: string): number
  • Eintragen des zu anlysierenden Textes

    Parameters

    • aText: string

      zu analysierender Text

    Returns number

    Fehlercode 0 oder -1

setLanguage

  • setLanguage(aLanguage: string): number
  • Aendern der Sprache

    Parameters

    • aLanguage: string

      Kurzzeichen fuer Sprache ( de, en )

    Returns number

    Fehlercode 0 oder -1

setNLU

  • setNLU(aNLUName: string): number
  • Setzen der aktuellen NLU ueber ihren Namen

    Parameters

    • aNLUName: string

      Name der NLU

    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

Generated using TypeDoc