Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20220502-155727 (ChatServer: 20220502-155727)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    KnuddelAccount

    KnuddelAccount Klasse

    Modul: Knuddel

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

    Methoden

    getKnuddelAmount

    () KnuddelAmount

    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

    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

    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

    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

    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

    Liefert den Nutzer, dem der KnuddelAccount gehört.

    Rückgabewert:

    User:

    Beispiel:

    var knuddelAccount = user.getKnuddelAccount();

var knuddelAccountUser = knuddelAccount.getUser();

    hasEnough

    (
    • knuddelAmount
    )
    Boolean

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

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