Interface IDialogService

export: Dialog Schnittstelle

Hierarchy

IService
- IDialogService

Implemented by

DialogService

Index

Properties

Properties

actionEvent

actionEvent: EventEmitter<IDialogAction>

actionStopEvent

actionStopEvent: EventEmitter<any>

active

active: boolean

context

context: any

Eigenschaft Kontext eintragen.

dialog

dialog: string

Eigenschaft Dialog eintragen.

errorEvent

errorEvent: EventEmitter<any>

errorOutput

errorOutput: boolean

file

file: string

Eigenschaft File eintragen fuer die aktuelle Dialogdatei.

importEvent

importEvent: EventEmitter<any>

initEvent

initEvent: EventEmitter<any>

parseEvent

parseEvent: EventEmitter<any>

path

path: string

Eigenschaft Path eintragen fuer das Dialogverzeichnis.

setDialogEvent

setDialogEvent: EventEmitter<string>

setStateEvent

setStateEvent: EventEmitter<string>

speakEvent

speakEvent: EventEmitter<IDialogSpeak>

speakStopEvent

speakStopEvent: EventEmitter<any>

startEvent

startEvent: EventEmitter<any>

state

state: string

Eigenschaft State setzen.

stopEvent

stopEvent: EventEmitter<any>

Methods

addContextElement

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

- Defined in packages/dialog/src/dialog-service.interface.ts:270
Eintragen eines Kontextes zu einem Element.

Parameters
- aElementName: string
  
  Name des Elementes
- aContextName: string
  
  Name des Kontexts
Returns number

clearContext

clearContext(): number

- Defined in packages/dialog/src/dialog-service.interface.ts:258
Loeschen des aktuellen Kontextes

Returns number

Fehlercode 0 oder -1

clearDialog

clearDialog(): number

- Defined in packages/dialog/src/dialog-service.interface.ts:139
alle Dialogdaten aus dem Dialogspeicher loeschen.

Returns number

Fehlercode 0 oder -1

getApiVersion

getApiVersion(): string

Inherited from IService.getApiVersion
- Defined in packages/service/src/service.interface.ts:79
API-Version des Services zurueckgeben

Returns string

API-Version des Service

getComponentName

getComponentName(): string

Inherited from IService.getComponentName
- Defined in packages/service/src/service.interface.ts:52
Komponenten-Name zurueckgeben

Returns string

Komponenten-Name

getDialog

getDialog(): string

- Defined in packages/dialog/src/dialog-service.interface.ts:159
Aktuell eingestellten Dialog zurueckgeben

Returns string

Rueckgabe des Dialognamens

getFile

getFile(): string

- Defined in packages/dialog/src/dialog-service.interface.ts:130
Rueckgabe des aktuell eingetragenen Dialogdateinamens

Returns string

aktuellen Dialogdateinamen zurueckgeben

getName

getName(): string

Inherited from IService.getName
- Defined in packages/service/src/service.interface.ts:61
Name der konkreten Service-Instanz zurueckgeben

Returns string

Service-Name

getPath

getPath(): string

- Defined in packages/dialog/src/dialog-service.interface.ts:109
Rueckgabe des aktuell eingetragenen Dialogverzeichnisses

Returns string

aktuelles Dialogverzeichnis zurueckgeben

getState

getState(): string

- Defined in packages/dialog/src/dialog-service.interface.ts:224
Hier wird der aktuelle Dialogzustand zurueckgegeben

Returns string

Rueckgabe des Dialogzustandsnamens

getVersion

getVersion(): string

Inherited from IService.getVersion
- Defined in packages/service/src/service.interface.ts:70
Version des Services zurueckgeben

Returns string

Service-Version

import

import(aJsonDialogData: IDialogData[]): number

- Defined in packages/dialog/src/dialog-service.interface.ts:170
Json-Daten importieren und im Dialogspeicher ablegen

Parameters
- aJsonDialogData: IDialogData[]
  
  Json-Dialogdaten
Returns number

init

init(aOption?: any): number

Inherited from IService.init
- Defined in packages/service/src/service.interface.ts:89
Initialisierung des Service

Parameters
- Optional aOption: any
  
  optionale Parameter zur Konfiguration des Service
Returns number

Fehlercode 0 oder -1

isActive

isActive(): boolean

Inherited from IService.isActive
- Defined in packages/service/src/service.interface.ts:116
pruefen auf aktiven Service

Returns boolean

activeFlag

isErrorOutput

isErrorOutput(): boolean

Inherited from IService.isErrorOutput
- Defined in packages/service/src/service.interface.ts:143
pruefen auf Fehlerausgabe auf die Konsole

Returns boolean

errorOutputFlag

isExistState

isExistState(aState: string): boolean

- Defined in packages/dialog/src/dialog-service.interface.ts:234
pruefen, ob es den Zustand ueberhaupt gibt

Parameters
- aState: string
  
  Name des zu pruefenden Zustands
Returns boolean

True - Zustand existiert

isInit

isInit(): boolean

Inherited from IService.isInit
- Defined in packages/service/src/service.interface.ts:107
pruefen auf initialisierten Service

Returns boolean

Rueckgabe, ob Service initialisiert ist

isRunning

isRunning(): boolean

Inherited from IService.isRunning
- Defined in packages/service/src/service.interface.ts:169
pruefen, ob Service gerade beschaeftigt ist

Returns boolean

True, Service ist beschaeftigt, False sonst

parse

parse(aDialogData: string): number

- Defined in packages/dialog/src/dialog-service.interface.ts:181
Dialogskript parsen und im Dialogspeicher ablegen

Parameters
- aDialogData: string
  
  Dialogskript
Returns number

parseFile

parseFile(aDialogFileName?: string): number

- Defined in packages/dialog/src/dialog-service.interface.ts:192
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

- Defined in packages/dialog/src/dialog-service.interface.ts:282
Entfernen eines Kontextes zu einem Element.

Parameters
- aElementName: string
  
  Name des Elementes
- aContextName: string
  
  Name des Kontexts
Returns number

reset

reset(aOption?: any): number

Inherited from IService.reset
- Defined in packages/service/src/service.interface.ts:98
Service auf initialen Zustand zuruecksetzen

Parameters
- Optional aOption: any
  
  optionale Parameter
Returns number

setActiveOff

setActiveOff(): number

Inherited from IService.setActiveOff
- Defined in packages/service/src/service.interface.ts:134
Service daktivieren

Returns number

Fehlercode oder -1

setActiveOn

setActiveOn(): number

Inherited from IService.setActiveOn
- Defined in packages/service/src/service.interface.ts:125
Service aktivieren

Returns number

Fehercode 0 oder -1

setDialog

setDialog(aDialogName: string): number

- Defined in packages/dialog/src/dialog-service.interface.ts:150
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

Inherited from IService.setErrorOutputOff
- Defined in packages/service/src/service.interface.ts:157
Fehlerausgabe auf Konsole ausschalten

Returns void

setErrorOutputOn

setErrorOutputOn(): void

Inherited from IService.setErrorOutputOn
- Defined in packages/service/src/service.interface.ts:150
Fehlerausgabe auf Konsole einschalten

Returns void

setFile

setFile(aFileName: string): number

- Defined in packages/dialog/src/dialog-service.interface.ts:121
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

- Defined in packages/dialog/src/dialog-service.interface.ts:100
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

- Defined in packages/dialog/src/dialog-service.interface.ts:215
Dialogzustand setzen

Parameters
- aStateName: string
  
  Name des Dialogzustands im Dialogskript
Returns number

Fehlercode 0 oder -1

setStateContext

setStateContext(aStateContext: any): number

- Defined in packages/dialog/src/dialog-service.interface.ts:245
Dialogzustandskontext eintragen. Der Kontext dient zur variablen Steuerung der Dialogzustaende.

Parameters
- aStateContext: any
  
  Dialogzustantskontext
Returns number

Fehlercode 0 oder -1

start

start(): number

Inherited from IService.start
- Defined in packages/service/src/service.interface.ts:178
Startet die Aufgabe.

Returns number

Fehlercode 0 oder -1

stop

stop(): number

Inherited from IService.stop
- Defined in packages/service/src/service.interface.ts:187
Stoppt die Aufgabe

Returns number

Fehlercode 0 oder -1

test

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

Inherited from IService.test
- Defined in packages/service/src/service.interface.ts:202
Fuehrt Testkommandos aus, um interne Tests ablaufen lassen zu koennen

Parameters
- aTestCommand: string
  
  Testkommando
- Optional aTestData: any
  
  optionale Testdaten
Returns any

Rueckgabe der Testergebnisse

toggle

toggle(): number

- Defined in packages/dialog/src/dialog-service.interface.ts:201
Dialog ein/ausschalten

Returns number

Fehlercode 0 oder -1

Generated using TypeDoc