Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DialogService

export

DialogService Klasse fuer Speech-Angular.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected mComponentName

mComponentName: string = ""

Private mDialog

mDialog: IDialog = null

Private mDialogActionEvent

mDialogActionEvent: EventEmitter<IDialogAction> = new EventEmitter<IDialogAction>( DIALOG_ASYNC_EVENT )

Private mDialogActionStopEvent

mDialogActionStopEvent: EventEmitter<any> = new EventEmitter<any>( DIALOG_ASYNC_EVENT )

Private mDialogImportEvent

mDialogImportEvent: EventEmitter<any> = new EventEmitter<any>( DIALOG_ASYNC_EVENT )

Private mDialogParseEvent

mDialogParseEvent: EventEmitter<any> = new EventEmitter<any>( DIALOG_ASYNC_EVENT )

Private mDialogSetEvent

mDialogSetEvent: EventEmitter<string> = new EventEmitter<string>( DIALOG_ASYNC_EVENT )

Private mDialogSpeakEvent

mDialogSpeakEvent: EventEmitter<IDialogSpeak> = new EventEmitter<IDialogSpeak>( DIALOG_ASYNC_EVENT )

Private mDialogSpeakStopEvent

mDialogSpeakStopEvent: EventEmitter<any> = new EventEmitter<any>( DIALOG_ASYNC_EVENT )

Private mDialogStartEvent

mDialogStartEvent: EventEmitter<any> = new EventEmitter<any>( DIALOG_ASYNC_EVENT )

Private mDialogStateSetEvent

mDialogStateSetEvent: EventEmitter<string> = new EventEmitter<string>( DIALOG_ASYNC_EVENT )

Private mDialogStopEvent

mDialogStopEvent: EventEmitter<any> = new EventEmitter<any>( DIALOG_ASYNC_EVENT )

Protected mErrorEvent

mErrorEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Protected mErrorOutputFlag

mErrorOutputFlag: boolean = SERVICE_ERROR_OUTPUT

Fehlerausgabe fuer Konsole festlegen

Protected mInitEvent

mInitEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Protected mServiceApiVersion

mServiceApiVersion: string = SERVICE_API_VERSION

Protected mServiceName

mServiceName: string = "Service"

Protected mServiceVersion

mServiceVersion: string = SERVICE_VERSION_STRING

Protected mStartEvent

mStartEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Protected mStopEvent

mStopEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Static Private constructorInitFlag

constructorInitFlag: boolean = true

legt fest, ob die Initialisierung im Konstruktor bereits erfolgt

Static Private dialogServiceConfig

dialogServiceConfig: IDialogOption = DialogServiceConfig

definiert die Konfiguration des DialogService

Accessors

actionEvent

actionStopEvent

  • Ereignis fuer Aktionen beenden

    readonly

    Returns EventEmitter<any>

active

  • get active(): boolean
  • set active(aActiveFlag: boolean): void

  • Eigenschaft aktive Komponente zurueckgeben

    readonly

    Returns boolean

    aActiveFlag - True, wenn aktive, False sonst

  • Eigenschaft aktive Komponente setzen

    Parameters

    • aActiveFlag: boolean

      True, wenn aktive, False sonst

    Returns void

    aActiveFlag - True, wenn aktive, False sonst

context

  • set context(aStateContext: any): void

  • Eigenschaft Kontext eintragen.

    Parameters

    • aStateContext: any

      aktuelles Kontextobjekt zum State eintragen

    Returns void

dialog

  • get dialog(): string
  • set dialog(aDialogName: string): void

  • Eigenschaft Dialog zurueckgeben.

    Returns string

    aDialogName - Name des aktuellen Dialogs

  • Eigenschaft Dialog eintragen.

    Parameters

    • aDialogName: string

      Name des aktuellen Dialogs

    Returns void

    aDialogName - Name des aktuellen Dialogs

errorEvent

  • Ereignis fuer Fehler aufgetreten

    readonly

    Returns EventEmitter<any>

    errorEvent

errorOutput

  • get errorOutput(): boolean
  • set errorOutput(aErrorOutputFlag: boolean): void

  • Eigenschaft fuer Konsolenausgabe zurueckgeben

    readonly

    Returns boolean

    aErrorOutputFlag - True, wenn Konsolenausgabe erfolgen soll, False sonst

  • Eigenschaft fuer Fehlerausgabe auf der Konsole setzen

    Parameters

    • aErrorOutputFlag: boolean

      True, wenn Konsolenausgabe erfolgen soll, False sonst

    Returns void

    aErrorOutputFlag - True, wenn Konsolenausgabe erfolgen soll, False sonst

file

  • get file(): string
  • set file(aFileName: string): void

  • Eigenschaft File fuer die aktuelle Dialogdatei zurueckgeben.

    Returns string

    aFileName - Name der aktuellen Dialogdatei

  • Eigenschaft File eintragen fuer die aktuelle Dialogdatei.

    Parameters

    • aFileName: string

      Name der Dialogdatei

    Returns void

    aFileName - Name der aktuellen Dialogdatei

importEvent

  • Ereignis fuer importieren der Json-DialogDaten

    readonly

    Returns EventEmitter<any>

initEvent

  • Ereignis fuer Init

    readonly

    Returns EventEmitter<any>

    initEvent

parseEvent

  • Ereignis fuer geparstes Dialogskript

    readonly

    Returns EventEmitter<any>

path

  • get path(): string
  • set path(aPath: string): void

  • Eigenschaft Path zurueckgeben

    readonly

    Returns string

    aPath - Dialogverzeichnis fuer alle Dialogdateien

  • Eigenschaft Path eintragen fuer das Dialogverzeichnis.

    Parameters

    • aPath: string

      lokales Verzeichnis zu den Dialogdateien

    Returns void

    aPath - Dialogverzeichnis fuer alle Dialogdateien

setDialogEvent

  • Ereignis fuer neu eingestellten Dialog

    readonly

    Returns EventEmitter<string>

setStateEvent

  • Ereignis fuer neu eingestellten Dialogzustand

    readonly

    Returns EventEmitter<string>

speakEvent

  • Ereignis fuer Sprachausgabe starten

    readonly

    Returns EventEmitter<IDialogSpeak>

speakStopEvent

  • Ereignis fuer Sprachausgabe beendet

    readonly

    Returns EventEmitter<any>

startEvent

  • Ereignis fuer gestarteten Dialog

    readonly

    Returns EventEmitter<any>

state

  • get state(): string
  • set state(aStateName: string): void

  • Eigenschaft State zurueckgeben.

    Returns string

  • Eigenschaft State setzen.

    Parameters

    • aStateName: string

      Name des aktuell einzustellenden Zustands

    Returns void

stopEvent

  • Ereignis fuer beendeten Dialog

    readonly

    Returns EventEmitter<any>

Methods

Protected _addAllEvent

  • _addAllEvent(aServiceName: string): number

  • Anbindung der Bot-Events an die EventEmitter von Angular

    Parameters

    • aServiceName: string

      Name des Services

    Returns number

    Fehlercode 0 oder 1

Protected _createComponent

  • _createComponent(aComponentName: string, aOption: any): any

  • Hier wird die Komponente erzeugt.

    Parameters

    • aComponentName: string

      Name der zu erzeugenden Komponente

    • aOption: any

      optionale Parameter fuer die Initialisierung der Komponente

    Returns any

    Rueckgabe der Action-Instanz

Protected _error

  • _error(aFuncName: string, aErrorText: string): void

  • Ausgabe eines Fehlers

    Parameters

    • aFuncName: string

      Name der Funktion, wo der Fehler auftrat

    • aErrorText: string

      Fehlertext

    Returns void

Protected _exception

  • _exception(aFuncName: string, aException: any): void

  • Ausgabe einer Exception

    Parameters

    • aFuncName: string

      Name der Funktion, in der die Exception auftrat

    • aException: any

      Exception-Objekt

    Returns void

Protected _setOption

  • Optionen eintragen

    Parameters

    Returns number

addContextElement

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

  • Eintragen eines Kontextes zu einem Element.

    Parameters

    • aElementName: string

      Name des Elementes

    • aContextName: string

      Name des Kontexts

    Returns number

clearContext

  • clearContext(): number

  • Loeschen des aktuellen Kontextes

    Returns number

    Fehlercode 0 oder -1

clearDialog

  • clearDialog(): number

  • alle Dialogdaten aus dem Dialogspeicher loeschen.

    Returns number

    Fehlercode 0 oder -1

getApiVersion

  • getApiVersion(): string

getComponentName

  • getComponentName(): string

getDialog

  • getDialog(): string

  • Aktuell eingestellten Dialog zurueckgeben

    Returns string

    Rueckgabe des Dialognamens

getFile

  • getFile(): string

  • Rueckgabe des aktuell eingetragenen Dialogdateinamens

    Returns string

    aktuellen Dialogdateinamen zurueckgeben

getName

  • getName(): string

getPath

  • getPath(): string

  • Rueckgabe des aktuell eingetragenen Dialogverzeichnisses

    Returns string

    aktuelles Dialogverzeichnis zurueckgeben

getState

  • getState(): string

  • Hier wird der aktuelle Dialogzustand zurueckgegeben

    Returns string

    Rueckgabe des Dialogzustandsnamens

getVersion

  • getVersion(): string

import

  • Json-Daten importieren und im Dialogspeicher ablegen

    Parameters

    Returns number

init

  • Initialisierung des Service.

    Parameters

    • Optional aOption: IDialogOption

      optionale Parameter zur Konfiguration des Service

    Returns number

    errorCode(0,-1)

isActive

  • isActive(): boolean

isErrorOutput

  • isErrorOutput(): boolean

isExistState

  • isExistState(aState: string): boolean

  • pruefen, ob es den Zustand ueberhaupt gibt

    Parameters

    • aState: string

      Name des zu pruefenden Zustands

    Returns boolean

    True - Zustand existiert

isInit

  • isInit(): boolean

  • pruefen auf initialisierten Service

    Returns boolean

    Rueckgabe, ob Service initialisiert ist

isRunning

  • isRunning(): boolean

parse

  • parse(aDialogData: string): number

  • Dialogskript parsen und im Dialogspeicher ablegen

    Parameters

    • aDialogData: string

      Dialogskript

    Returns number

parseFile

  • parseFile(aDialogFileName?: string): number

  • Dialogskript Datei parsen und im Dialogspeicher ablegen

    Parameters

    • Optional aDialogFileName: string

      Dialogskript Dateiname

    Returns number

    Fehlercode 0 oder -1

removeContextElement

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

  • Entfernen eines Kontextes zu einem Element.

    Parameters

    • aElementName: string

      Name des Elementes

    • aContextName: string

      Name des Kontexts

    Returns number

reset

  • Ruecksetzen des Services, alle Werte werden auf ihre Defaultwerte gesetzt

    Parameters

    • Optional aOption: IDialogOption

      optionale Parameter zur Konfiguration des Service

    Returns number

    Fehlercode 0 oder -1

setActiveOff

  • setActiveOff(): number

setActiveOn

  • setActiveOn(): number

setDialog

  • setDialog(aDialogName: string): number

  • Dialog ueber seinen Namen einstellen. Der Dialog muss im Dialogskript vorhanden sein.

    Parameters

    • aDialogName: string

      Name des Dialogs im Dialogskript

    Returns number

    Fehlercode 0 oder -1

setErrorOutputOff

  • setErrorOutputOff(): void

setErrorOutputOn

  • setErrorOutputOn(): void

setFile

  • setFile(aFileName: string): number

  • Eintragen einer Dialogdatei (z.B. 'speech.def'). Beinhalted das Dialogskript fuer den Dialoginterpreter.

    Parameters

    • aFileName: string

      Dialogskriptdateiname

    Returns number

    Fehlercode 0 oder -1

setPath

  • setPath(aFilePath: string): number

  • Eintragen eines Dialogdateiverzeichnisses (z.B. 'assets/speech/'). Muss mit '/' abgeschlossen werden !

    Parameters

    • aFilePath: string

      lokales Verzeichnis zu den Dialogdaten

    Returns number

    Fehlercode 0 oder -1

setState

  • setState(aStateName: string): number

  • Dialogzustand setzen

    Parameters

    • aStateName: string

      Name des Dialogzustands im Dialogskript

    Returns number

    Fehlercode 0 oder -1

setStateContext

  • setStateContext(aStateContext: any): number

  • Dialogzustandskontext eintragen. Der Kontext dient zur variablen Steuerung der Dialogzustaende.

    Parameters

    • aStateContext: any

      Dialogzustantskontext

    Returns number

    Fehlercode 0 oder -1

start

  • start(): number

  • Aktion starten. Vorher muessen die Aktionsdaten eingetragen sein.

    Returns number

    Fehlercode 0 oder -1

stop

  • stop(): number

  • Aktion stoppen.

    Returns number

    Fehlercode 0 oder -1

test

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

  • Testfunktionen aufrufen

    Parameters

    • aTestCommand: string

      Name des Testbefehls

    • Optional aTestData: any

      optionale Daten fuer den Test

    Returns any

    Rueckgabe der Testergebnisse { result: 0 }

toggle

  • toggle(): number

  • Dialog ein/ausschalten

    Returns number

    Fehlercode 0 oder -1

Static getConfig

  • Rueckgabe der Konfiguration fuer den DialogService, um die Konfiguration zu veraendern. Muss vor der Erzeugung des DialogService aufgerufen werden. Wird nur im Zusammenhang mit dem gesetzten ConstructorInitFlag verwendet, welches die Initialisierung des DialogService im Konstruktor vornimmt. Bei manuellem Aufruf von Init kann diese Funktion zur Uebergabe der Optionen verwendet werden.

    static

    Returns IDialogOption

    DialogServiceOptions - dient zur Einstellung der otionalen Parameter

Static isConstructorInit

  • isConstructorInit(): boolean

  • pruefen auf ConstructorInitFlag fuer Festlegung, ob der Konstructor init aufruft.

    static

    Returns boolean

    ConstructorInitFlag - True, Konstructor initialisiert den DialogService, False sonst

Static setConstructorInitOff

  • setConstructorInitOff(): void

  • loescht das ConstructorInitFlag, um init nicht im Konstruktor aufzurufen.

    static

    Returns void

Static setConstructorInitOn

  • setConstructorInitOn(): void

  • setzen des ConstructorInitFlag auf true, um init im Konstruktor aufzurufen.

    static

    Returns void

Generated using TypeDoc