Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    AppInstance

    AppInstance Klasse

    Modul: Core

    Repräsentiert die Instanz einer App.

    Die eigene Instanz von AppInstance erhält man über das AppAccess-Objekt mit appAccess.getOwnInstance()

    Methoden

    getAllInstances

    (
    • [includeSelf]
    )
    AppInstance[]

    Liefert alle App-Instanzen dieser App in diesem Channel und Subchannels. Mit includeSelf = false kann man die eigene Instanz ausschließen.

    Parameter:

    • [includeSelf] Boolean optional

      true by default.

    Rückgabewert:

    AppInstance[]:

    Beispiel:

    var otherInstances = ownInstance.getAllInstances(false);

    getAppInfo

    () AppInfo

    Liefert die AppInfo.

    Rückgabewert:

    AppInfo:

    Beispiel:

    var appInfo = ownInstance.getAppInfo();

    getChannelName

    () String

    Liefert den Namen des Channels in dem diese AppInstance läuft.

    Rückgabewert:

    String:

    Beispiel:

    var channelName = appInstance.getChannelName(); // i.e. String[ '/Knuddelonia' ]

    getRegisteredChatCommandNames

    () String[] | Null

    Liefert die Namen der ChatCommands, die diese AppInstnce derzeit registriert hat.

    Rückgabewert:

    String[] | Null:

    Beispiel:

    var registeredChatCommandNames = appInstance.getRegisteredChatCommandNames(); // i.e. String[ 'blacklist', 'sayHello' ]

    getRootInstance

    () RootAppInstance

    Liefert die Root-Instanz der aktuellen App-Instanz.

    Rückgabewert:

    RootAppInstance:

    Beispiel:

    const kEventCountOnlineMinutes = 'kEventCountOnlineMinutes';

function storeOnlineMinutes(onlineMinutes)
{
    var ownInstance = KnuddelsServer.getAppAccess().getOwnInstance();
    
    if (!ownInstance.isRootInstance())
    {
        ownInstance.getRootInstance().sendAppEvent(kEventCountOnlineMinutes, {
            onlineMinutes : onlineMinutes
        });
    }
    else
    {
        KnuddelsServer.getPersistence().addNumber('onlineMinutes', onlineMinutes);
    }
}

this.onAppEventReceived = function(appInstance, type, data)
{
    if (type == kEventCountOnlineMinutes)
    {
        var onlineMinutes = data['onlineMinutes'];
        storeOnlineMinutes(onlineMinutes);
    }
}

    getStartDate

    () Date

    Liefert den Startzeitpunkt dieser AppInstance.

    Rückgabewert:

    Date:

    Beispiel:

    var startDate = ownInstance.getStartDate(); // i.e. Date[Tue Jan 05 2016 23:00:11 GMT+0100 (MEZ)]

    isRootInstance

    () Boolean

    Informiert, ob die aktuelle AppInstanz eine Root-Instanz ist.

    Rückgabewert:

    Boolean:

    Beispiel:

    var isRootInstance = ownInstance.isRootInstance();

    sendAppEvent

    (
    • type
    • data
    )

    Sendet ein App-Event an diese App-Instanz.

    Parameter:

    Beispiel:

    const kEventCountJoin = 'kEventCountJoin';

App.onUserJoined = function(user)
{
    var eventPayload = {
        nick: user.getNick()
    };
    
    ownInstance.getRootInstance().sendAppEvent(kEventCountJoin, eventPayload);
}

    Beispiel-Code

    In diesen Beispielen wird diese Klasse verwendet: