Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    AppInfo

    AppInfo Klasse

    Modul: Core

    Die Instanz von AppInfo zur laufenden App erhält man über die AppInstance mit appInstance.getAppInfo()

    Methoden

    getAppDeveloper

    () User

    Liefert den Entwickler der App, falls die serverId knuddelsDE oder knuddelsDEV ist, ansonsten null.

    Rückgabewert:

    User:

    Beispiel:

    var appDeveloper = appInfo.getAppDeveloper(); // i.e.: User:someAwesomeNick

    getAppId

    () String

    Liefert die eindeutige Id der App. Die appId setzt sich zusammen aus

    • id des Entwicklungsservers
    • FTP-Nutzername
    • Ordnername der App -> appKey

    Rückgabewert:

    String:

    appId

    Beispiel:

    var appId = appInfo.getAppId(); // i.e.: 'knuddelsDEV.73457.SudokuApp'

    getAppKey

    () String

    Liefert den eindeutigen Key der App. Der appKey ist der Ordnername, in dem die App liegt.

    Rückgabewert:

    String:

    appKey

    Beispiel:

    var appKey = appInfo.getAppKey(); // i.e.: 'SudokuApp'

    getAppManagers

    () User[]

    Liefert die Liste der AppManager für diese App. Die Channelbesitzer zählen automatisch auch als AppManager.

    Rückgabewert:

    User[]:

    Beispiel:

    var appManagers = appInfo.getAppManagers(); // i.e.: [ User:someAwesomeUser, User:Plex, User:Holgi ]

    getAppName

    () String

    Liefert den in der Konfiguration eingestellten Namen der App.

    Rückgabewert:

    String:

    Name der App

    Beispiel:

    var appName = appInfo.getAppName(); // i.e.: 'Sudoku'

    getAppUid

    () Number

    Liefert die AppUid. Diese ist für jede Sub-Channel Instanz der App unterschiedlich. Wenn RootAppUid == AppUid dann ist dies die Root-App-Instanz.

    Rückgabewert:

    Number:

    Beispiel:

    var appUid = appInfo.getAppUid(); // i.e.: 1460

    getAppVersion

    () String

    Liefert die Version der App, die in der Konfiguration eingestellt wurde.

    Rückgabewert:

    String:

    Beispiel:

    var appVersion = appInfo.getAppVersion(); // i.e.: '1.0'

    getMaxPayoutKnuddelAmount

    () KnuddelAmount

    Liefert den gesamten KnuddelAmount vom BotUser.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

    var maxPayoutKnuddelAmount = appInfo.getMaxPayoutKnuddelAmount(); // i.e.: 0

    getRootAppUid

    () Number

    Liefert die RootAppUid. Diese ist für jede Sub-Channel Instanz der App gleich. Wenn RootAppUid == AppUid dann ist dies die Root-App-Instanz.

    Sie wird für den Link für Auszahlungen aus einem Knuddel-Account benötigt: /knuddelaccount payout:<RootAppUid>:<BETRAG>

    Rückgabewert:

    Number:

    Beispiel:

    var rootAppUid = appInfo.getRootAppUid(); // i.e.: 1460

    getTaxRate

    () Number Veraltet

    Veraltet: Diese Methode liefert ab sofort immer den Wert 0 zurück, da keine Steuern mehr bei Transfers abgezogen werden.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert den Steuersatz, der bei Auszahlung bereits genutzer Knuddel von einem KnuddelAccount an einen User anfällt. Die anfallenden Steuern werden bei Auszahlung vom BotUser abgezogen.

    Rückgabewert:

    Number:

    Beispiel:

    var taxRate = appInfo.getTaxRate(); // 15

    getTotalTaxKnuddelAmount

    () KnuddelAmount Veraltet

    Veraltet: Diese Methode liefert ab sofort immer den Wert 0 zurück, da keine Steuern mehr bei Transfers abgezogen werden.

    KnuddelAccount wurde abgeschafft. Deprecation Hinweis beachten!
    Liefert den KnuddelAmount, der an Steuern anfallen würde, wenn alle User jetzt all ihre Knuddel aus ihrem KnuddelAccount abheben würden.

    Rückgabewert:

    KnuddelAmount:

    Beispiel:

    var totalTaxKnuddelAmount = appInfo.getTotalTaxKnuddelAmount(); // i.e.: 0

    requestKnuddelDebts

    (
    • callback
    )

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

    Liefert die Schulden der App.

    Parameter:

    • callback Function

      wird asynchron aufgerufen.

      • debts KnuddelAmount
      • result String

        Der result-Parameter kann folgende Werte haben:

        • "success" = der ChatServer hat korrekt geantwortet (korrektes Ergebnis)
        • "timeout" = der ChatServer hat nicht rechtzeitig geantwortet (debts = null) [dies kann z.B. geschehen wenn der ChatServer überlastet ist oder ein interner Fehler auftrat - in diesem Fall bitte NICHT wiederholt erneut anfragen!]

    Beispiel:

    appInfo.requestKnuddelDebts(
    function(debts, result) {
        if (result == "success" && debts.getKnuddelCents() > 0) {
            KnuddelsServer.getDefaultBotUser().sendPublicMessage("Die App hat Schulden.")
        }
    }
);

    stopApp

    (
    • [message]
    • [logMessage]
    )
    Veraltet

    Veraltet: nun verfügbar via KnuddelsServer.getAppAccess().getOwnInstance().getRootInstance().stopApp()

    Stoppt diese App.

    Parameter:

    • [message] String optional

      Öffentliche Nachricht, die allen Nutzern beim Stoppen der App angezeigt wird.

    • [logMessage] String optional

      Nachricht, die im App-Logfile angezeigt wird.

    updateApp

    (
    • [message]
    • [logMessage]
    )
    Veraltet

    Veraltet: nun verfügbar via KnuddelsServer.getAppAccess().getOwnInstance().getRootInstance().updateApp()

    Aktualisiert diese App auf die neueste Version.

    Parameter:

    • [message] String optional

      Öffentliche Nachricht, die allen Nutzern beim Aktualisieren der App angezeigt wird.

    • [logMessage] String optional

      Nachricht, die im App-Logfile angezeigt wird.