Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    UserPersistenceStrings

    UserPersistenceStrings Klasse

    Modul: Persistence

    Mit dieser Klasse ist es möglich nicht User-spezifische Abfragen auf die UserPersistence auszuführen.

    Übersicht

    Methoden

    Methoden

    deleteAll

    (
    • key
    )
    Number static

    Verfügbar ab Version AppServer 82478

    Löscht alle gespeicherten Strings für den übergebenen key.

    Parameter:

    Rückgabewert:

    Number:

    Anzahl der gelöschten Einträge

    Beispiel:

    var deleted = UserPersistenceStrings.deleteAll('knuddelSpent');

    each

    (
    • key
    • callback
    • [parameters]
    )
    static

    Ruft eine Funktion für alle Nutzer auf, die einen bestimmten key in der UserPersistence gesetzt haben. Hierbei greifen die übergebenen Filter.

    Parameter:

    • key String
    • callback Function

      wird asynchron für jeden Eintrag aufgerufen. Wenn diese Methode false returned, dann wird für alle weiteren Einträge der callback nicht aufgerufen.

    • [parameters] Object optional
      • [ascending] Boolean optional

        Entscheidet, ob numerisch aufwärts (true, default) oder abwärts (false) sortiert werden soll.

      • [maximumCount] Number optional

        Maximale Anzahl an Elementen, für die each aufgerufen werden soll.

      • [onStart] Function optional

        Methode, die aufgerufen wird, bevor damit begonnen wird für jedes Element die callback-Methode aufzurufen.

      • [onEnd] Function optional

        Methode, die aufgerufen wird, nachdem für jedes Element die callback-Methode aufgerufen wurde oder die callback-Methode false returned hat.

      • [online] Boolean optional

        Verfügbar ab Version AppServer 20200525-192452

        Wenn angegeben, so wird der callback nur für User mit dem entsprechenden Online Status aufgerufen (so wie user.isOnline() == online). Es wird aber empfohlen anstatt user.isOnline() diesen Parameter zu verwenden, da dieser intern optimiert ist und nur die passenden User überhaupt lädt.

    Beispiel:

    UserPersistenceStrings.each('name', function(user, value, index, totalCount, key) {
    user.sendPostMessage('Betreff', 'Dein name lautet: ' + value);
    return true;
}, { ascending: false, maximumCount: 10, online: true });

    exists

    (
    • key
    • value
    • [ignoreCase]
    )
    Boolean static

    Verfügbar ab Version AppServer 88571

    Liefert die Information, ob für einen bestimmten key und value bei einem beliebigen Nutzer eine Paarung existiert.

    Parameter:

    Rückgabewert:

    Boolean:

    Information, ob Eintrag existiert.

    Beispiel:

    var exists = UserPersistenceStrings.exists('personalName', 'Keksmann');

    getAllKeys

    (
    • [filterKey]
    )
    String[] static

    Verfügbar ab Version AppServer 82483

    Liefert alle keys, die für User in der Persistence gespeichert wurden.

    Parameter:

    • [filterKey] String optional

      Zeichenkette, die im key vorkommen muss, damit sie für die Rückgabe relevant ist

    Rückgabewert:

    String[]:

    Liste mit allen keys

    Beispiel:

    var allKeys = UserPersistenceStrings.getAllKeys(); // i.e.: [ 'points', 'knuddelLost' ]

    getNicksByKey

    (
    • key
    • callback
    )

    Verfügbar ab Version AppServer 20201113-145716, ChatServer 20201113-145716

    Liefert ein Array von Nicks für einen bestimmten key.

    Parameter:

    Beispiel:

    UserPersistenceStrings.getNicksByKey(
        "playedGame",
        function(nicks) {
            KnuddelsServer
                .getDefaultBotUser()
                .sendPublicMessage(JSON.stringify(nicks))
        }
    );

    getUserIdsByKey

    (
    • key
    • callback
    )

    Verfügbar ab Version AppServer 20201113-145716, ChatServer 20201113-145716

    Liefert ein Array von UserIds für einen bestimmten key.

    Parameter:

    Beispiel:

    UserPersistenceStrings.getUserIdsByKey(
        "playedGame",
        function(userIds) {
            KnuddelsServer
                .getDefaultBotUser()
                .sendPublicMessage(JSON.stringify(userIds))
        }
    );