Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    Persistence

    Persistence Klasse

    Modul: Persistence

    Eine Instanz von Persistence ermöglicht die persistente Speicherung von Zahlen, Zeichenketten und JSON-Objekten. Es gibt die zwei Arten AppPersistence und UserPersistence

    Jeder eigene Datentyp hat seinen eigenen Namensraum. So kann derselbe key für eine Zahl, Zeichenkette und auch JSON-Objekt genutzt werden.



    Hinweis: Mit der Persistence gespeicherte Informationen überleben sogar die Deinstallation und Neuinstallation der App.

    Methoden

    addNumber

    (
    • key
    • value
    )
    Number

    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);

    deleteNumber

    (
    • key
    )

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

    Parameter:

    Beispiel:

    persistence.deleteNumber('kJoinCount');

    deleteObject

    (
    • key
    )

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

    Parameter:

    Beispiel:

    persistence.deleteObject('kDonationStats');

    deleteString

    (
    • key
    )

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

    Parameter:

    Beispiel:

    persistence.deleteString('kWelcomeString');

    getNumber

    (
    • key
    • [defaultValue]
    )
    Number

    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

    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

    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

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

    Parameter:

    Rückgabewert:

    Boolean:

    Beispiel:

    persistence.hasNumber('kJoinCount');

    hasObject

    (
    • key
    )
    Boolean

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

    Parameter:

    Rückgabewert:

    Boolean:

    hasString

    (
    • key
    )
    Boolean

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

    Parameter:

    Rückgabewert:

    Boolean:

    Beispiel:

    persistence.hasString('kWelcomeString');

    setNumber

    (
    • key
    • value
    )

    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
    )

    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
    )

    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);