Class BotService

export: BotService Klasse fuer Speech-Angular. Definiert einen Bot mit Aktionen und Sprachausgabe

Hierarchy

BaseService
- BotService

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new BotService(): BotService

Overrides BaseService.constructor
- Defined in bot/bot-service.ts:145
Konstruktor

Returns BotService

Accessors

action

get action(): boolean
set action(aActionFlag: boolean): void

- Defined in bot/bot-service.ts:633
Eigenschaft Action zurueckgeben.

readonly

Returns boolean
- Defined in bot/bot-service.ts:617
Eigenschaft Action setzen. Wenn Action eingeschaltet ist, wird die Dialogaktion ueber die Action-Komponente ausgefuehrt.

Parameters
- aActionFlag: boolean
  
  True, wenn Aktionsverarbeitung erfolgen soll, False sonst
Returns void

actionEvent

get actionEvent(): EventEmitter<BotServiceActionInterface>

- Defined in bot/bot-service.ts:448
Ereignis fuer Aktionen

readonly

Returns EventEmitter<BotServiceActionInterface>

actionStopEvent

get actionStopEvent(): EventEmitter<unknown>

- Defined in bot/bot-service.ts:459
Ereignis fuer Aktionen beenden

readonly

Returns EventEmitter<unknown>

active

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

Inherited from BaseService.active
- Defined in base/base-service.ts:315
Eigenschaft aktive Komponente zurueckgeben

readonly

Returns boolean

aActiveFlag - True, wenn aktive, False sonst
Inherited from BaseService.active
- Defined in base/base-service.ts:299
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

- Defined in bot/bot-service.ts:966
Eigenschaft Kontext eintragen.

Parameters
- aStateContext: any
  
  aktuelles Kontextobjekt zum State eintragen
Returns void

dialog

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

- Defined in bot/bot-service.ts:815
Eigenschaft Dialog zurueckgeben.

Returns string

aDialogName - Name des aktuellen Dialogs
- Defined in bot/bot-service.ts:804
Eigenschaft Dialog eintragen.

Parameters
- aDialogName: string
  
  Name des aktuellen Dialogs
Returns void

aDialogName - Name des aktuellen Dialogs

errorEvent

get errorEvent(): EventEmitter<any>

Inherited from BaseService.errorEvent
- Defined in base/base-service.ts:508
Ereignis fuer Fehler aufgetreten

readonly

Returns EventEmitter<any>

errorEvent

errorOutput

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

Inherited from BaseService.errorOutput
- Defined in base/base-service.ts:381
Eigenschaft fuer Konsolenausgabe zurueckgeben

readonly

Returns boolean

aErrorOutputFlag - True, wenn Konsolenausgabe erfolgen soll, False sonst
Inherited from BaseService.errorOutput
- Defined in base/base-service.ts:365
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

- Defined in bot/bot-service.ts:746
Eigenschaft File fuer die aktuelle Dialogdatei zurueckgeben.

Returns string

aFileName - Name der aktuellen Dialogdatei
- Defined in bot/bot-service.ts:735
Eigenschaft File eintragen fuer die aktuelle Dialogdatei.

Parameters
- aFileName: string
  
  Name der Dialogdatei
Returns void

aFileName - Name der aktuellen Dialogdatei

importEvent

get importEvent(): EventEmitter<unknown>

- Defined in bot/bot-service.ts:393
Ereignis fuer importiere Json-DialogDaten

readonly

Returns EventEmitter<unknown>

initEvent

get initEvent(): EventEmitter<unknown>

Inherited from BaseService.initEvent
- Defined in base/base-service.ts:472
Ereignis fuer Init

readonly

Returns EventEmitter<unknown>

initEvent

parseEvent

get parseEvent(): EventEmitter<unknown>

- Defined in bot/bot-service.ts:404
Ereignis fuer geparstes Dialogskript

readonly

Returns EventEmitter<unknown>

path

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

- Defined in bot/bot-service.ts:691
Eigenschaft Path zurueckgeben

readonly

Returns string

aPath - Dialogverzeichnis fuer alle Dialogdateien
- Defined in bot/bot-service.ts:680
Eigenschaft Path eintragen fuer das Dialogverzeichnis.

Parameters
- aPath: string
  
  lokales Verzeichnis zu den Dialogdateien
Returns void

aPath - Dialogverzeichnis fuer alle Dialogdateien

setDialogEvent

get setDialogEvent(): EventEmitter<string>

- Defined in bot/bot-service.ts:382
Ereignis fuer neu eingestellten Dialog

readonly

Returns EventEmitter<string>

setStateEvent

get setStateEvent(): EventEmitter<string>

- Defined in bot/bot-service.ts:438
Ereignis fuer neu eingestellten Dialogzustand

readonly

Returns EventEmitter<string>

speak

get speak(): boolean
set speak(aSpeakFlag: boolean): void

- Defined in bot/bot-service.ts:557
Eigenschaft Speak zurueckgeben.

readonly

Returns boolean
- Defined in bot/bot-service.ts:541
Eigenschaft Speak setzen. Wenn Speak eingeschaltet ist, wird der Dialogtext als Sprachausgabe ueber die Speak-Komponente erzeugt.

Parameters
- aSpeakFlag: boolean
  
  True, wenn Sprachausgabe erfolgen soll, False sonst
Returns void

speakEvent

get speakEvent(): EventEmitter<string>

- Defined in bot/bot-service.ts:470
Ereignis fuer Sprachausgabe starten

readonly

Returns EventEmitter<string>

speakStopEvent

get speakStopEvent(): EventEmitter<unknown>

- Defined in bot/bot-service.ts:481
Ereignis fuer Sprachausgabe beendet

readonly

Returns EventEmitter<unknown>

startEvent

get startEvent(): EventEmitter<unknown>

Overrides BaseService.startEvent
- Defined in bot/bot-service.ts:415
Ereignis fuer gestarteten Dialog

readonly

Returns EventEmitter<unknown>

state

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

- Defined in bot/bot-service.ts:938
Eigenschaft State zurueckgeben.

Returns string
- Defined in bot/bot-service.ts:927
Eigenschaft State setzen.

Parameters
- aStateName: string
  
  Name des aktuell einzustellenden Zustands
Returns void

stopEvent

get stopEvent(): EventEmitter<unknown>

Overrides BaseService.stopEvent
- Defined in bot/bot-service.ts:427
Ereignis fuer beendeten Dialog

readonly

Returns EventEmitter<unknown>

Methods

addContextElement

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

- Defined in bot/bot-service.ts:998
Eintragen eines Kontextes zu einem Element.

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

clearContext

clearContext(): number

- Defined in bot/bot-service.ts:980
Loeschen des aktuellen Kontextes

Returns number

Fehlercode 0 oder -1

clearDialog

clearDialog(): number

- Defined in bot/bot-service.ts:757
alle Dialogdaten aus dem Dialogspeicher loeschen.

Returns number

Fehlercode 0 oder -1

getComponentName

getComponentName(): string

Inherited from BaseService.getComponentName
- Defined in base/base-service.ts:104
Returns string

getDialog

getDialog(): string

- Defined in bot/bot-service.ts:789
Aktuell eingestellten Dialog zurueckgeben

Returns string

Rueckgabe des Dialognamens

getDialogFileName

getDialogFileName(): string

- Defined in bot/bot-service.ts:720
Rueckgabe des aktuell eingetragenen Dialogdateinamens

Returns string

aktuellen Dialogdateinamen zurueckgeben

getDialogFilePath

getDialogFilePath(): string

- Defined in bot/bot-service.ts:665
Rueckgabe des aktuell eingetragenen Dialogverzeichnisses

Returns string

aktuelles Dialogverzeichnis zurueckgeben

getName

getName(): string

Inherited from BaseService.getName
- Defined in base/base-service.ts:108
Returns string

getState

getState(): string

- Defined in bot/bot-service.ts:912
Hier wird der aktuelle Dialogzustand zurueckgegeben

Returns string

Rueckgabe des Dialogzustandsnamens

getVersion

getVersion(): string

Inherited from BaseService.getVersion
- Defined in base/base-service.ts:112
Returns string

import

import(aJsonDialogData: BotServiceDataInterface[]): number

- Defined in bot/bot-service.ts:828
Json-Daten importieren und im Dialogspeicher ablegen

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

init

init(aOption?: BotServiceOptionInterface): number

Overrides BaseService.init
- Defined in bot/bot-service.ts:270
Initialisierung des Service.

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

errorCode(0,-1)

isAction

isAction(): boolean

- Defined in bot/bot-service.ts:571
Pruefen auf aktive Aktionsverarbeitung

Returns boolean

actionFlag - true, Aktionsverarbeitung ist aktiv, false sonst

isActive

isActive(): boolean

Inherited from BaseService.isActive
- Defined in base/base-service.ts:257
pruefen auf aktive Komponente

Returns boolean

aktivFlag

isErrorOutput

isErrorOutput(): boolean

Inherited from BaseService.isErrorOutput
- Defined in base/base-service.ts:327
pruefen auf Konsolen-Ausgabe von Fehlermeldungen

Returns boolean

isInit

isInit(): boolean

Inherited from BaseService.isInit
- Defined in base/base-service.ts:243
pruefen auf initialisierten Service

Returns boolean

Rueckgabe, ob Service initialisiert ist

isRunning

isRunning(): boolean

Inherited from BaseService.isRunning
- Defined in base/base-service.ts:522
pruefen auf laufende Aktion

Returns boolean

runningFlag

isSpeak

isSpeak(): boolean

- Defined in bot/bot-service.ts:495
Pruefen auf aktive Sprachausgabe

Returns boolean

speakFlag - true, Sprachausgabe ist aktiv, false sonst

parse

parse(aDialogData: string): number

- Defined in bot/bot-service.ts:845
Dialogskript parsen und im Dialogspeicher ablegen

Parameters
- aDialogData: string
  
  Dialogskript
Returns number

parseFile

parseFile(aDialogFileName?: string): number

- Defined in bot/bot-service.ts:862
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 bot/bot-service.ts:1016
Entfernen eines Kontextes zu einem Element.

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

reset

reset(aOption?: BotServiceOptionInterface): number

Overrides BaseService.reset
- Defined in bot/bot-service.ts:283
Ruecksetzen des Services, alle Werte werden auf ihre Defaultwerte gesetzt

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

Fehlercode 0 oder -1

setActionOff

setActionOff(): number

- Defined in bot/bot-service.ts:601
Aktionsverarbeitung fuer den Bot ausschalten

Returns number

Fehlercode 0 oder -1

setActionOn

setActionOn(): number

- Defined in bot/bot-service.ts:586
Aktionsverarbeitung fuer den Bot einschalten

Returns number

Fehlercode 0 oder -1

setActiveOff

setActiveOff(): number

Inherited from BaseService.setActiveOff
- Defined in base/base-service.ts:285
Komponente daaktivieren

Returns number

Fehlercode 0 oder -1

setActiveOn

setActiveOn(): number

Inherited from BaseService.setActiveOn
- Defined in base/base-service.ts:271
Komponente aktivieren

Returns number

Fehlercode 0 oder -1

setDialog

setDialog(aDialogName: string): number

- Defined in bot/bot-service.ts:774
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

setDialogFileName

setDialogFileName(aFileName: string): number

- Defined in bot/bot-service.ts:705
Eintragen einer Dialogdatei (z.B. 'speech.def'). Beinhalted das Dialogskript fuer den Dialoginterpreter.

Parameters
- aFileName: string
  
  Dialogskriptdateiname
Returns number

Fehlercode 0 oder -1

setDialogFilePath

setDialogFilePath(aFilePath: string): number

- Defined in bot/bot-service.ts:650
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

setErrorOutputOff

setErrorOutputOff(): void

Inherited from BaseService.setErrorOutputOff
- Defined in base/base-service.ts:351
Ausschalten der Konsolen-Fehlerausgabe

Returns void

setErrorOutputOn

setErrorOutputOn(): void

Inherited from BaseService.setErrorOutputOn
- Defined in base/base-service.ts:339
Einschalten der Konsolen-Fehlerausgabe

Returns void

setSpeakOff

setSpeakOff(): number

- Defined in bot/bot-service.ts:525
Sprachausgabe fuer den Bot ausschalten

Returns number

Fehlercode 0 oder -1

setSpeakOn

setSpeakOn(): number

- Defined in bot/bot-service.ts:510
Sprachausgabe fuer den Bot einschalten

Returns number

Fehlercode 0 oder -1

setState

setState(aStateName: string): number

- Defined in bot/bot-service.ts:897
Dialogzustand setzen

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

Fehlercode 0 oder -1

setStateContext

setStateContext(aStateContext: any): number

- Defined in bot/bot-service.ts:951
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 BaseService.start
- Defined in base/base-service.ts:536
Aktion starten. Vorher muessen die Aktionsdaten eingetragen sein.

Returns number

Fehlercode 0 oder -1

stop

stop(): number

Inherited from BaseService.stop
- Defined in base/base-service.ts:551
Aktion stoppen.

Returns number

Fehlercode 0 oder -1

test

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

Inherited from BaseService.test
- Defined in base/base-service.ts:571
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

- Defined in bot/bot-service.ts:877
Dialog ein/ausschalten

Returns number

Fehlercode 0 oder -1

Static getConfig

getConfig(): BotServiceOptionInterface

- Defined in bot/bot-service.ts:143
Rueckgabe der Konfiguration fuer den BotService, um die Konfiguration zu veraendern. Muss vor der Erzeugung des BotService aufgerufen werden. Wird nur im Zusammenhang mit dem gesetzten ConstructorInitFlag verwendet, welches die Initialisierung des BotService im Konstruktor vornimmt. Bei manuellem Aufruf von Init kann diese Funktion zur Uebergabe der Optionen verwendet werden.

static

Returns BotServiceOptionInterface

BotServiceOptions - dient zur Einstellung der otionalen Parameter

Static isConstructorInit

isConstructorInit(): boolean

- Defined in bot/bot-service.ts:105
pruefen auf ConstructorInitFlag fuer Festlegung, ob der Konstructor init aufruft.

static

Returns boolean

ConstructorInitFlag - True, Konstructor initialisiert den BotService, False sonst

Static setConstructorInitOff

setConstructorInitOff(): void

- Defined in bot/bot-service.ts:127
loescht das ConstructorInitFlag, um init nicht im Konstruktor aufzurufen.

static

Returns void

Static setConstructorInitOn

setConstructorInitOn(): void

- Defined in bot/bot-service.ts:116
setzen des ConstructorInitFlag auf true, um init im Konstruktor aufzurufen.

static

Returns void