Avendoo® Online Hilfe

Avendoo® API

Erfahrene Autoren (mit entsprechenden HTML/CSS und JavaScript Kenntnissen) können für die Kursbewertung eines Kurses auf die Avendoo® API (application programming interface) zurückgreifen und so bestimmte Parameter an ein eigenständig erstelltes Design übergeben.

Sie können auf diese API zugreifen, insoweit Sie Zugriff auf diese Kursseiten haben.

Die nachfolgende Tabelle enthält den entsprechenden Befehl und die jeweilige Erklärung:

Methoden in der ratingJsAPI.js

BefehlErklärung

function saveOrEditReview(score, title, message)

Diese Funktion speichert eine neue Kursbewertung für den aktiven Benutzer oder für den Autoren oder bearbeitet eine bestehende Kursbewertung. Die bearbeitete Kursbewertung muss hierbei dem aktiven Benutzer oder dem Autoren gehören.
Die Bearbeitung ist möglich für:
– Sterne (1-5)
– Titel der Kursbewertung
– Nachricht der Kursbewertung

function deleteReview (reviewCd)

Diese Funktion löscht eine Kursbewertung. Die Kursbewertung muss hierbei dem aktiven Benutzer oder dem Autoren gehören.

function getCourseRating()

Diese Funktion gibt die durchschnittliche Kursbewertung der Kursfreigabe aus (gerundet auf ganze Zahlen).

function getReviews(limit, start, optionalExclude)

Diese Funktion gibt eine gewisse Anzahl an Kursbewertungen aus.
Die Bearbeitung ist möglich für:
– Die Anzahl an Kursbewertungen
– Den Einstiegspunkt, ab dem die Kursbewertungen geholt werden
– Die ID eines Nutzers, dessen Kursbewertung nicht geladen werden soll. Sie kann 0 sein. Dies ist hilfreich, wenn der Kommentar dieser Person angepinnt ist und nicht doppelt angezeigt werden soll.

function getPinnedComment (overrideUser)

Diese Funktion lädt den eigenen Kommentar. Sie kann auch verwendet werden, um den Kommentar einer anderen Person zu laden.
Die Bearbeitung ist möglich für die ID eines Nutzers, die 0 sein kann, um seinen eigenen Kommentar zu laden.