Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20250502-115203 (ChatServer: 20250502-115203)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    UserPersistence

    UserPersistence Klasse

    Extends Persistence
    Modul: Persistence

    Für jeden User kann eine UserPersistence angefordert werden, um sich für einen bestimmten Nutzer Dinge persistent zu merken.

    Methoden

    addNumber

    (
    • key
    • value
    )
    Number

    Geerbt von Persistence:

    Addiert den übergebenen value auf die unter dem Key key vorhandenen Wert drauf. Value kann auch negativ sein um eine Subtraktion durchzuführen. Falls keine Zahl für den key existiert, so wird der value für key gespeichert.

    Parameter:

    • key String
    • value Number

      (darf nicht null, undefined, NaN oder unendlich sein)

    Rückgabewert:

    Number:

    Der neue Wert, der für key gespeichert ist.

    Beispiel:

    var joinCount = persistence.addNumber('kJoinCount', 1);

    deleteAll

    () Number

    Verfügbar ab Version AppServer 88569

    Löscht alle Daten, die in dieser UserPersistence für diesen User gespeichert sind.

    Rückgabewert:

    Number:

    Beispiel:

    var deletedElementCount = userPersistence.deleteAll();

    deleteAllNumbers

    () Number

    Verfügbar ab Version AppServer 88569

    Löscht alle Zahlenwerte, die in dieser UserPersistence für diesen User gespeichert sind.

    Rückgabewert:

    Number:

    Anzahl der gelöschten Zahlenwerte

    Beispiel:

    userPersistence.deleteAllNumbers();

    deleteAllObjects

    () Number

    Verfügbar ab Version AppServer 88569

    Löscht alle Objekte, die in dieser UserPersistence für diesen User gespeichert sind.

    Rückgabewert:

    Number:

    Anzahl der gelöschten Objekte

    Beispiel:

    var deletedObjectCount = userPersistence.deleteAllObjects();

    deleteAllStrings

    () Number

    Verfügbar ab Version AppServer 88569

    Löscht alle Zeichenketten, die in dieser UserPersistence für diesen User gespeichert sind.

    Rückgabewert:

    Number:

    Anzahl der gelöschten Zeichenketten.

    Beispiel:

    var deletedStringCount = userPersistence.deleteAllStrings();

    deleteNumber

    (
    • key
    )

    Geerbt von Persistence:

    Löscht die Zahl, die unter key gespeichert ist.

    Parameter:

    Beispiel:

    persistence.deleteNumber('kJoinCount');

    deleteObject

    (
    • key
    )

    Geerbt von Persistence:

    Löscht das Objekt, das unter key gespeichert ist.

    Parameter:

    Beispiel:

    persistence.deleteObject('kDonationStats');

    deleteString

    (
    • key
    )

    Geerbt von Persistence:

    Löscht die Zeichenkette, die unter key gespeichert ist.

    Parameter:

    Beispiel:

    persistence.deleteString('kWelcomeString');

    getNumber

    (
    • key
    • [defaultValue]
    )
    Number

    Geerbt von Persistence:

    Liefert die Zahl, die für den key gespeichert ist. Falls für key keine Zahl gespeichert ist, so gibt die Methode den defaultValue zurück.

    Parameter:

    • key String
    • [defaultValue] Number optional

      muss eine Zahl sein und darf nicht null, undefined... sein.

    Rückgabewert:

    Number:

    Beispiel:

    persistence.getNumber('kStartCount', 1);

    getObject

    (
    • key
    • [defaultValue]
    )
    Object

    Geerbt von Persistence:

    Liefert das Objekt, das für den key gespeichert ist. Falls für key kein Objekt gespeichert ist, so gibt die Methode den defaultValue zurück.

    Parameter:

    Rückgabewert:

    Object:

    Beispiel:

    persistence.getObject('kDonationStats', null);

    getString

    (
    • key
    • [defaultValue]
    )
    String

    Geerbt von Persistence:

    Liefert die Zeichenkette, die für den key gespeichert ist. Falls für key keine Zeichenkette gespeichert ist, so gibt die Methode den defaultValue zurück.

    Parameter:

    Rückgabewert:

    String:

    Beispiel:

    persistence.getString('kWelcomeString');

    hasNumber

    (
    • key
    )
    Boolean

    Geerbt von Persistence:

    Informiert darüber, ob unter dem key eine Zahl abgespeichert ist.

    Parameter:

    Rückgabewert:

    Boolean:

    Beispiel:

    persistence.hasNumber('kJoinCount');

    hasObject

    (
    • key
    )
    Boolean

    Geerbt von Persistence:

    Informiert darüber, ob unter dem key ein Objekt abgespeichert ist.

    Parameter:

    Rückgabewert:

    Boolean:

    hasString

    (
    • key
    )
    Boolean

    Geerbt von Persistence:

    Informiert darüber, ob unter dem key ein String abgespeichert ist.

    Parameter:

    Rückgabewert:

    Boolean:

    Beispiel:

    persistence.hasString('kWelcomeString');

    setNumber

    (
    • key
    • value
    )

    Geerbt von Persistence:

    Setzt die Zahl value für den key. Falls bereits eine Zahl für den key existiert, so wird diese überschrieben.

    Parameter:

    Beispiel:

    var newStartCount = persistence.getNumber('kStartCount', 0) + 1;
persistence.setNumber('kStartCount', newStartCount);

    setObject

    (
    • key
    • object
    )

    Geerbt von Persistence:

    Setzt das Objekt value für den key. Falls bereits ein Objekt für den key existiert, so wird dieses überschrieben. Das als JSON serialisierte Objekt darf maximal 100kb groß sein.

    Parameter:

    Beispiel:

    var updatedDonationStats = persistence.getObject('kDonationStats');

updatedDonationStats.donations = updatedDonationStats.donations + 1;

persistence.setObject('kDonationStats', updatedDonationStats);

    setString

    (
    • key
    • value
    )

    Geerbt von Persistence:

    Setzt die Zeichenkette value für den key. Falls bereits eine Zeichenkette für den key existiert, so wird diese überschrieben.

    Parameter:

    Beispiel:

    var newWelcomeString = 'Willkommen in meinem Reich.';
persistence.setString('kWelcomeString', newWelcomeString);