Versions Compared

Old Version 1

changes.mady.by.user Stefan Schöb

Saved on

compared with

New Version Current

changes.mady.by.user Christoph Süess

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Für was kann ich die Widget API einsetzen?

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

Tip

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:

Code Block
window.micromate.selectLearningPackageAndOpenWidget('learningPackageIdToStart');

Funktionsreferenz

Funktion

Parameter

Beschreibung

selectLearningPackageAndOpenWidget(learningPackageId: string)

learningPackageId: 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(tab: 'badges' | 'chat' | 'learnStudyProgress' | 'scoreboard')

tab: Definiert das Tab in welches gewechselt werden soll.

Wechselt das selektierte Tab im Micromate Widget.

openWidget()

-

Öffnet das Micromate Widget.