Avendoo® Online Hilfe

Avendoo® API

Lehrmittel API

BefehlBeschreibung

fn_getAPIVersion()

Gibt die Versionsnummer der aktuellen API wieder. Im Moment gibt die Funktion den Wert „2“ zurück (Stand September 2015).

fn_getActualPageNumber()

Gibt an, auf welcher Seite man sich aktuell befindet. Seite 1 = a, Seite 2 = b, Unterseite 1 von Seite 2 = ba etc.

fn_setAllPagesRead()

Setzt alle Lehrmittelseiten auf „visited“, wodurch das Lehrmittel auf dem Lernpfad als „abgeschlossen“ gewertet wird. Der Lerner befindet sich automatisch auf der letzten Lehrmittelseite.

Hinweis:
Die Änderungen innerhalb des Lehrmittels sind erst beim nächsten Öffnen bzw. nach einem erneuten Laden des Lehrmittels zu sehen. Siehe hierzu auch „fn_reload_page()“.

fn_reload_page()

Lädt die Seite neu

fn_getUserLogin()

Gibt den Loginnamen zurück.

Anwendungsbeispiel:
Im Lehrmittel soll der User mit seinem Namen begrüßt werden.

API Code

fn_getUserLanguage()

Gibt die Sprache, die für den Lerner hinterlegt ist, in Form eines Länderkürzels zurück.
Die Länderkürzel entsprechen der ISO 639-1.

Achtung:
Die Sprache, die für den Lerner hinterlegt ist, entspricht nicht zwangsläufig der Sprache, in der der Lerner das Lehrmittel bearbeitet.

fn_isPageVisited()

Gibt den Wert „true“ bzw. „false“ zurück, je nachdem ob eine Seite bereits angesehen (true) wurde oder nicht (false).

fn_getVisitedPages()

Die Funktion liefert ein Array mit allen Seiten, die sich der Lernende bereits angesehen hat.

fn_getTutorialId()

Gibt die ID zurück, mit der jedes Lehrmittel nummeriert wird.

fn_getAssignmentId()

Gibt die ID zurück, mit der jede Kursfreigabe nummeriert wird.

fn_getPageId()

Gibt die ID zurück, mit der jede Lehrmittel-Seite nummeriert wird.

fn_setData()

Setzt die Daten für alle JavaScript-Varianten mit Text, auch Falsch-Richtig-Werte.
Beispiel:
fn_setData(„objectType“, 4): „objectType“ könnte „Frage 1“ sein.

fn_getData()

Liest die Daten, die gespeichert wurden, für alle JavaScript-Varianten mit Text aus.
Beispiel:
fn_setData(„objectType“, 4);
fn_setData(„objectType“, fn_getData(„objectType“) + 6);
fn_getData(„objectType“); => 10

Die Tutorial- Assignment- und PageId sind eindeutige 13-stellige Zahlen und sehen in etwa so aus „1437638469552_1“. Zwei unterschiedliche Lehrmittel, Kursfreigaben oder Lehrmittelseiten haben niemals die gleiche ID.

Onboard-Navigation im Lehrmittel

BefehlErklärung

fn_opencloseMenu()

Blendet das Menü zur Navigation durch das Lehrmittel ein bzw. aus.

fn_closeMenu()

Blendet das Menü zur Navigation durch das Lehrmittel aus.

fn_left()

Öffnet die vorherige Seite.

fn_up()

Bei einer eingerückten Seite öffnet diese Funktion die Seite, die sich eine Ebene höher befindet.

fn_right()

Öffnet die nächste Seite.

Diese Funktionen erlauben es dem Autor, eine individuelle Navigation innerhalb der Lehrmittel zu erstellen, indem die Funktionalität der onboard-Navigation von Avendoo® nachgestellt wird.

Anwendungsbeispiel:

Innerhalb des Lehrmittels soll mithilfe von individuellen Buttons navigiert werden. Dabei ist die Menüleiste des Lehrmittels standardmäßig ausgeblendet und wird nur bei Bedarf eingeblendet.
API Code

Navigation

Funktionen, um zu anderen Lehrmittelseiten zu springen

BefehlErklärung

fn_getPages()

Die Funktion liefert ein Array, in dem jeder Lehrmittelseite ein Buchstabe zugeordnet wird – beginnend bei „a“. Für jede Einrückung wird dem jeweiligen Buchstaben ein weiterer Buchstabe angehängt – ebenfalls beginnend mit „a“.
Die erste Unterseite der ersten Seite hat also den Wert „aa“.
Die vierte Unterseite der dritten Seite hat den Wert „cd“ usw.

Hinweis:
Da jeder Seite ein Wert zugeordnet wird, eignet sich diese Funktion in Kombination mit der Methode „length“ gut, um die gesamten Seiten eines Lehrmittels zu zählen.
fn_getPages().length – 1 gibt die Gesamtseitenzahl eines Lehrmittels zurück.

fn_openPageByMenuPosition(position)

Mit der Funktion fn_openPageByMenuPosition(position) kann man auf eine beliebige Lehrmittelseite springen. Dafür setzt man für „position“ einfach das passende Buchstabenkürzel der jeweiligen Lehrmittelseite ein (siehe fn_getPages()).

 

Anwendungsbeispiel:
Man möchte zu der zweiten Unterseite der vierten Seite springen:

API Code 3

fn_openPageByPageId(pageId)

Diese Funktion ist ähnlich zu der Funktion „fn_openPageByMenuPosition(position)“. Allerdings wird die Position nicht in Form von Buchstaben angegeben sondern in Form der pageId (siehe hierzu auch fn_getPageId()).

fn_switch2otherTutorial(tutorialId,pageId)
fn_switch2originalTutorial(tutorialId,pageId)

Mithilfe dieser beiden Funktionen kann auf eine beliebige Seite in einem anderen Lehrmittel gesprungen werden.

Achtung:
Damit zu einem anderen Lehrmittel gesprungen werden kann, müssen sich beide Lehrmittel auf demselben Lernpfad befinden.

Beim Aufruf von einer bestimmten Seite innerhalb bzw. außerhalb eines Lehrmittels nimmt Avendoo® dem Autor bereits viel Arbeit ab. Klicken Sie im Editor auf „Lehrmittel verlinken“, wird automatisch ein Link zur gewünschten Lehrmittelseite erstellt. Im Quellcode können Sie den fertig erstellen Link kopieren, abändern und wiederverwerten.