Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Für was kann die Widget API eingesetzt werden?

Die Widget API ermöglicht die Steuerung des Micromate Widgets durch eine externe Anwendung im Frontend. z.B. kann das Widget geöffnet und ein spezifisches Lernpaket aufgerufen werden.

Anleitung

Das Wichtigste in Kürze

  1. Die Widget API kann im Browser über JavaScript aufgerufen werden.

  2. Die Widget API ist über das globale “micromate”-Objekt erreichbar, welches über das window-Objekt bereitgestellt wird.

Verwendung

Die Funktionen auf dem globalen micromate-Objekt können aus einem beliebigen Script im Browser ausgeführt werden:

window.micromate.selectLearningPackageAndOpenWidget('learningPackageIdToStart');

Funktionsreferenz

Funktion

Parameter

Beschreibung

selectLearningPackageAndOpenWidget

Name:
learningPackageId

Type:
string

Beschreibung:
Id des Lernpakets, welches selektiert werden soll.

Selektiert das übergebene Lernpaket für den Benutzer und öffnet das Widget in der Chat-Ansicht.

Mit der Selektion eines Lernpaketes wird automatisch die erste Nachricht an den Benutzer zum Start des Lernpaketes gesendet.

switchTab

Name:
tab

Type:
'badges' | 'chat' | 'learnStudyProgress' | 'scoreboard'

Beschreibung:
Definiert das Tab in welches gewechselt werden soll.

Wechselt das selektierte Tab im Micromate Widget.

openWidget

-

Öffnet das Micromate Widget.

  • No labels