Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20240419-122957 (ChatServer: 20240419-122957)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    ToplistAccess

    ToplistAccess Klasse

    Modul: Toplist

    Mit einer Instanz von ToplistAccess kann eine App Toplist erzeugen und verwalten.

    Die Instanz für die ToplistAccess erhält man über das KnuddelsServer-Objekt mit KnuddelsServer.getToplistAccess()

    Methoden

    createOrUpdateToplist

    (
    • userPersistenceNumberKey
    • displayName
    • [parameters]
    )
    Toplist

    Erzeugt oder aktualisiert die Toplist für den übergebenen userPersistenceNumberKey.

    Parameter:

    • userPersistenceNumberKey String

      Persistenz-Key für den die Topliste erzeugt oder aktualisiert werden soll

    • displayName String

      Anzeigename der Topliste (2-50 Zeichen lang)

    • [parameters] Object optional

      Möglichkeit ein weitere Parameter zu übergeben.

      • [labelMapping] Object optional

        Mapping der gespeicherten Zahl zu einem Anzeigenamen (max. 250 Stück, je 2-50 Zeichen lang)

      • [ascending] Boolean optional

        Sortierreihenfolge ändern (Default: false)

      • [sortIndex] Number optional

        Index für die Sortierreihenfolge mehrerer Toplisten untereinander in /apptop und im Profil.
        - Nur Ganzzahlen. Kann negativ sein. (Default: 0)
        - Kleine Werte = weiter oben, große Werte = weiter unten.
        - Die Standard-Sortierung bei gleichem sortIndex ist alphabetisch nach displayName.
        - Verfügbar ab Version AppServer 108855

    Rückgabewert:

    Toplist:

    Beispiel:

    var labelMapping = {
    1   : 'Anfänger', // 1 bis <25
    25  : 'Beginner', // 25 bis <50
    50  : 'Profi', // 50 bis <100
    100 : 'Genius' // ab 100
};

var toplist = toplistAccess.createOrUpdateToplist('points', 'Punkte', {
    labelMapping: labelMapping,
    ascending: false,
    sortIndex: 100
});

    getAllToplists

    () Toplist[]

    Liefert die Liste aller Toplisten, die diese App erzeugt hat.

    Rückgabewert:

    Toplist[]:

    Beispiel:

    var allToplists = toplistAccess.getAllToplists();

    getToplist

    (
    • userPersistenceNumberKey
    )
    Toplist

    Liefert die Toplist mit dem Persistenz-Key zurück.

    Parameter:

    • userPersistenceNumberKey String

    Rückgabewert:

    Toplist:

    Beispiel:

    var pointsToplist = toplistAccess.getToplist('points');

    removeToplist

    (
    • toplist
    )

    Löscht die übergebene Toplist oder die Toplist mit dem Persistenz-Key.

    Parameter:

    Beispiel:

    toplistAccess.removeToplist(toplist);