Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    ToplistLabelChangeEvent

    ToplistLabelChangeEvent Klasse

    Modul: Toplist

    ToplistLabelChangeEvents erhalten EventListener die bei einer Toplist mit der Methode addLabelChangeListener erzeugt wurden, nachdem sich der Anzeigename für einen User geändert hat.

    Das ToplistLabelChangeEvent enthält alle wichtigen Daten, um auf die Änderung zu reagieren und dem User beispielsweise für den Aufstieg zu gratulieren.

    Methoden

    getNewLabel

    () String

    Liefert den neuen Anzeigenamen. Hatte der User nun keinen Anzeigenamen mehr, so ist dieser Wert null.

    Rückgabewert:

    String:

    Beispiel:

    var newLabel = toplistLabelChangeEvent.getNewLabel(); // i.e.: 'Profi'

    getNewValue

    () Number

    Liefert den neuen Wert.

    Rückgabewert:

    Number:

    Beispiel:

    var newValue = toplistLabelChangeEvent.getNewValue(); // i.e.: 100

    getOldLabel

    () String

    Liefert den vorherigen Anzeigenamen. Hatte der User vorher keinen Anzeigenamen, so ist dieser Wert null.

    Rückgabewert:

    String:

    Beispiel:

    var oldLabel = toplistLabelChangeEvent.getOldLabel(); // i.e.: 'Anfänger'

    getOldValue

    () Number

    Liefert den Wert, der vor der Änderung gespeichert war.

    Rückgabewert:

    Number:

    Beispiel:

    var oldValue = toplistLabelChangeEvent.getOldValue(); // i.e.: 3

    getToplist

    () Toplist

    Liefert die zugehörige Toplist.

    Rückgabewert:

    Toplist:

    Beispiel:

    var toplist = toplistLabelChangeEvent.getToplist();

    getUser

    () User

    Liefert den User für den das Event ausgelöst wurde.

    Rückgabewert:

    User:

    Beispiel:

    var user = toplistLabelChangeEvent.getUser(); // i.e.: User:someAwesomeNick