(02) botApi

Die botApi ermöglicht eine Schnittstelle zum Zugriff auf Bot-Funktionen, wenn der Bot z.B. über ein IFrame in eine andere Seite eingebettet ist.

botApiQuerySelector('iframe_elem_id', debug = false)

Erstellt und gibt eine Schnittstelle für din angegebenen CSS-Selektor des HTML-IFrame-Elements zurück. Die Funktion kann mehrfach mit verschiedenen CSS-Selektoren aufgerufen werden.

await botApiQuerySelector('bot-iframe');

botApi('iframe_elem_id', debug = false)

Erstellt und gibt eine Schnittstelle für die angegebene ID des HTML-IFrame-Element zurück. Die Funktion kann mehrfach mit verschiedenen IFrame-IDs aufgerufen werden.

await botApi('bot-iframe');

.waitForInitialIdle()

Diese Funktion wartet darauf, dass der Bot seine Initialisierung abgeschlossen hat und sich im Ruhezustand befindet. Erst danach ist der Bot vollständig bereit, RAGAI-Befehle entgegenzunehmen.

await botApi.waitForInitialIdle();

.waitForNextIdle()

Diese Funktion wartet darauf, dass der Bot das nächste mal in den Status Idle wechselt. Danach ist dann z.B. der Bot fertig mit Schreiben.

await botApi.waitForNextIdle();

.eventStream('eventName', args[])

Hier werden der erfasste Eventname und die übermittelten Optionen emittiert.

await botApi.eventStream('');

.registerCourse()

Registriert für den Nutzer einen Kurs im Train-System.

await botApi.registerCourse('asdfg76JHUI6dsafuz');

.unRegisterExternalFunction('functionName', function())

Entfernt eine zuvor registrierte, dem IFrame gegenüber externe JS-Funktion.

await botApi.unRegisterExternalFunction('echo', () => { console.log('echo');});

.registerExternalFunction('functionName', function())

Registriert eine dem IFrame fremde JS-Funktion.

await botApi.registerExternalFunction('echo', () => { console.log('echo');});

.callExternalFunction('functionName', args[])

Aufruf einer dem IFrame fremden JS-Funktion.

await botApi.callExternalFunction('echo', []);

.getScormApi()

Emittiert die Schnittstelle für eine SCORM-Kommunikation zurück.

await botApi.getScormApi();

.userMessage('message')

Emittiert eine Nachricht aus Nutzersicht an das IFrame.

await botApi.userMessage('Hello Bot')

.userBypass('message')

Sendet eine Nachricht aus Nutzersicht an die KI.

await botApi.userBypass('Secret Message to Bot');

.botMessage('message')

Emittiert eine Nachricht aus Botsicht an das IFrame.

await botApi.botMessage('Hello User');

.botBypass('message')

Sendet eine Nachricht aus Botsicht an den Nutzer.

await botApi.botBypass('Secret Message to User');

.runMessage('message')

Emittiert eine Nachricht an das IFrame.

await botApi.runMessage('Hello Bot');

.botSay('message', 'voice')

Lässt eine Nachricht als Audio ausgeben.

await botApi.botSay();

.youtubeCard('video_id')

Zeigt ein YouTube-Video direkt im Chatverlauf an.

await botApi.youtubeCard();

.vimeoCard('video_id')

Zeigt ein Vimeo-Video direkt im Chatverlauf an.

await botApi.vimeoCard();

.iframeCard('url')

Zeigt eine eingebettete Website als iFrame direkt im Chatverlauf an.

await botApi.iframeCard();

.confetti()

Lässt Konfetti im IFrame anzeigen.

await botApi.confetti()