Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ActionInterface

Action Schnittstelle

Hierarchy

Index

Methods

Methods

addElement

  • Parameters

    Returns number

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

addFunction

  • Parameters

    Returns number

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

getActionName

  • getActionName(): string

  • Aktionsname zurueckgeben

    Returns string

    Rueckgabe des aktuell eingestellten Aktionsnamens

getElementName

  • getElementName(): string

  • Elementname zurueckgeben

    Returns string

    Rueckgabe des aktuell eingestellten Elementnamens

getElementType

  • getElementType(): string

  • Elementtyp zurueckgeben

    Returns string

    Rueckgabe des aktuell eingestellten Elementtyps

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

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

removeElement

  • removeElement(aElementName: string): number

  • Parameters

    • aElementName: string

    Returns number

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

removeFunction

  • removeFunction(aFunctionName: string): number

  • Parameters

    • aFunctionName: string

    Returns number

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

setActionName

  • setActionName(aActionName: string): number

  • Aktionsnamen eintragen

    Parameters

    • aActionName: string

      Name der aktuell auszufuehrenden Aktion

    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

setElementName

  • setElementName(aElementName: string): number

  • Elementname eintragen

    Parameters

    • aElementName: string

      Name des Elemens

    Returns number

    Fehlercode 0 oder -1

setElementType

  • setElementType(aElementType: string): number

  • Elementtyp eintragen

    Parameters

    • aElementType: string

      Name des Elementyps

    Returns number

    Fehlercode 0 oder -1

setErrorOutputOff

  • setErrorOutputOff(): void

setErrorOutputOn

  • setErrorOutputOn(): void

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