Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    KnuddelAccount

    KnuddelAccount Klasse

    Modul: Knuddel

    Diese Klasse ist veraltet.

    Eine Instanz von KnuddelAccount ermöglicht den Zugriff auf die freigegebenen Knuddel eines bestimmten User. Knuddel können abgezogen und addiert werden.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweise beachten!
    KnuddelAccounts wurden abgeschafft, um die Nutzung von Knuddel für einen Nutzer in Apps zu vereinfachen. Ab sofort muss ein Nutzer nicht mehr Knuddel auf ein KnuddelAccount aufladen, um sie in einer App nutzen zu können. Statt dessen kann die App direkt Knuddel von einem Nutzer verwenden. Voraussetzung dafür ist, dass der Nutzer ein Tageslimit im Channel einer App gesetzt hat. Dieses Limit wird täglich um Mitternacht zurückgesetzt. Beispiel: Ein Nutzer hat ein Tageslimit von 100 Knuddel gesetzt. Die App kann dann täglich bis zu 100 Knuddel von diesem Nutzer verwenden. Der Nutzer kann das Tageslimit jederzeit ändern. Das Tageslimit kann auch wieder entfernt werden, indem der Nutzer den Knuddel-Zugriff im Channel deaktiviert. Alle Apps in einem Channel teilen sich das vom Nutzer gesetzte Tageslimit. Da sehr viele bereits laufende Apps auf KnuddelAccount zugreifen und die Änderung zu einem großen Umstellungsaufwand führen würde, kann die Klasse KnuddelAccount weiterhin verwendet werden. Jedoch wird empfohlen, die Nutzung von KnuddelAccount in neuen Apps zu vermeiden. Außerdem wird empfohlen, bestehende Apps, die KnuddelAccount verwenden, umzustellen und die Alternativen API-Methoden zu verwenden. Alternative API-Methoden sind im Deprecation-Hinweis der einzelnene Methoden dieser Klasse aufgeführt. Hinweise: Das bestehende Verhalten von KnuddelAccount ändert sich!
    Hier eine Übersicht der Änderungen:

    Übersicht

    Methoden

    Methoden

    getKnuddelAmount

    () KnuddelAmount Veraltet

    Veraltet: Diese Methode gibt ab sofort das gleiche zurück wie {{#crossLink "User/getKnuddelAmount:method"}}{{/crossLink}} und sollte damit ersetzt werden.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert den KnuddelAmount eines Users, über den die App gerade frei verfügen kann.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

     var knuddelAccount = user.getKnuddelAccount();
 
 var knuddelAmount = knuddelAccount.getKnuddelAmount();

    getKnuddelAmountUnused

    () KnuddelAmount Veraltet

    Veraltet: Diese Methode gibt ab sofort das gleiche zurück wie {{#crossLink "User/getKnuddelAmount:method"}}{{/crossLink}} und sollte damit ersetzt werden.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert den KnuddelAmount aus dem KnuddelAccount, der noch nicht von der App genutzt wurde. Beim Auszahlen dieser Knuddel aus dem KnuddelAccount an den User fallen keine Steuern an.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountUnused = knuddelAccount.getKnuddelAmountUnused();

    getKnuddelAmountUsed

    () KnuddelAmount Veraltet

    Veraltet: Diese Methode gibt ab sofort immer 0 zurück.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert den KnuddelAmount aus dem KnuddelAccount, der bereits von der App genutzt wurde. Beim Auszahlen dieser Knuddel aus dem KnuddelAccount an den User fallen Steuern an.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountUsed = knuddelAccount.getKnuddelAmountUsed();

    getTotalKnuddelAmountAppToUser

    () KnuddelAmount Veraltet

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert die Summe aller Transfers, die die App an diesen KnuddelAccount bzw. User überwiesen hat.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountAppToUser = knuddelAccount.getTotalKnuddelAmountAppToUser();

    getTotalKnuddelAmountUserToApp

    () KnuddelAmount Veraltet

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert die Summe aller Transfers, die die App von diesem KnuddelAccount bzw. User abgebucht/erhalten hat.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountUserToApp = knuddelAccount.getTotalKnuddelAmountUserToApp();

    getUser

    () User Veraltet

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert den Nutzer, dem der KnuddelAccount gehört.

    Rückgabewert:

    User:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAccountUser = knuddelAccount.getUser();

    hasEnough

    (
    • knuddelAmount
    )
    Boolean Veraltet

    Veraltet: Diese Methode gibt ab sofort das gleiche zurück wie {{#crossLink "User/canTransferKnuddelToApp:method"}}{{/crossLink}} und sollte damit ersetzt werden.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert die Information, ob in diesem Moment genug Knuddel verfügbar sind.

    Parameter:

    Rückgabewert:

    Boolean:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAmoundNeeded = new KnuddelAmount(10);

var hasEnough = knuddelAccount.hasEnough(knuddelAmoundNeeded);

    use

    (
    • knuddelAmount
    • displayReasonText
    • [parameters]
    )
    Veraltet

    Veraltet: Diese Methode wurde abgeschafft. Verwende stattdessen {{#crossLink "User/transferKnuddelToApp:method"}}{{/crossLink}}.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Versucht eine bestimmte Menge Knuddel zu verwenden. Dies ist nur möglich, wenn der User auf seinem KnuddelAccount genug Knuddel besitzt und online im Channel ist oder eine globale App offen hat. Vom KnuddelAccount des Besitzer des Channel können Knuddel auch abgebucht werden, wenn dieser nicht im Channel online ist.

    Ist das Event App.onBeforeKnuddelReceived implementiert, so wird dieses direkt nach dem use aufgerufen, um zu entscheiden, ob die Knuddel angenommen werden sollen.



    Hinweis: Knuddel an einen Nutzer senden kannst du mit der Methode transferKnuddel.

    Parameter:

    • knuddelAmount KnuddelAmount
    • displayReasonText String

      für die Anzeige im /knuddelaccount-Kontoauszug.

    • [parameters] Object optional
      • [transferReason] String optional

        transferReason, intern für die App. Limit: 200 Zeichen.

      • [onError] Function optional

        Callback, der aufgerufen wird, falls das Nutzen der Knuddel fehlschlägt.

      • [onSuccess] Function optional

        Callback, der aufgerufen wird, falls das Nutzen der Knuddel erfolgreich ist.

    Beispiel:

    var knuddelAmount = new KnuddelAmount(1);

var useOptions = {
    onError: function(message)
    {
        KnuddelsServer.getDefaultLogger().info('Knuddel Abbuchen fehlgeschlagen: ' + message);
    },
    onSuccess: function()
    {
        KnuddelsServer.getDefaultLogger().info('Knuddel Abbuchen erfolgreich.');
    }
}

knuddelAccount.use(knuddelAmount, 'Spiel starten', useOptions);