Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    AppContentSession

    AppContentSession Klasse

    Modul: HTMLUI

    Repräsentiert den visuellen Inhalt einer App, der einem User angezeigt wird.

    Methoden

    getAppContent

    () AppContent

    Liefert den verbundenen AppContent.

    Rückgabewert:

    AppContent:

    Beispiel:

    var appContent = appContentSession.getAppContent();

    getAppViewMode

    () AppViewMode

    Liefert den AppViewMode.

    Rückgabewert:

    AppViewMode:

    Beispiel:

    var appViewMode = appContentSession.getAppViewMode(); // i.e.: AppViewMode.Popup

    getGlobalAppInstance

    () GlobalAppInstance | Null

    Liefert die zugehörige GlobalAppInstance, falls vorhanden. Bei AppContentSessions, welche nicht zu einer globalen App gehören wird null zurückgegeben.

    Rückgabewert:

    GlobalAppInstance | Null:

    Beispiel:

    var globalAppInstance = appContentSession.getGlobalAppInstance();

    getOpenTimestamp

    () Date

    Liefert den Zeitstempel, wann diese Session gestartet wurde als Date-Objekt.

    Rückgabewert:

    Date:

    Beispiel:

    var openTimestamp = appContentSession.getOpenTimestamp();

    getUser

    () User

    Liefert den User.

    Rückgabewert:

    User:

    user

    Beispiel:

    var user = appContentSession.getUser(); // i.e.: User:Kolloid

    isConnectedUsingDirectConnection

    () Boolean

    Abfrage, ob diese AppContentSession per Direct-Connection verbunden ist. Siehe auch Client.getDirectConnection().

    Rückgabewert:

    Boolean:

    Beispiel:

    var usesDirectConnection = appContentSession.isConnectedUsingDirectConnection();

    remove

    ()

    Entfernt die AppContentSession beim verbundenen User.

    Beispiel:

    appContentSession.remove();

    sendEvent

    (
    • type
    • [data]
    )

    Sendet ein Event eines bestimmten Typs mit Nutzdaten zum Client. Auf Client-Seite kann man via Client.addEventListener() einen Event-Observer registrieren in dem man das Event verarbeitet.

    Die Nutzdaten können ein String, ein Objekt, oder ein Array von Strings und/oder Objekten sein. Das Objekt muss via JSON.stringify() zu einem String konvertierbar sein. Nach der Konvertierung zu einem JSON-String wird auf Einhaltung der Limits geprüft.

    Parameter:

    • type String

      darf maximal 100 Zeichen lang sein. Das einzelne Zeichen '*' kann nicht als type verwendet werden.

    • [data] Json optional

      Nutzdaten die übermittelt werden sollen. Sie werden als JSON-String übermittelt und dürfen als solcher maximal 10.000 Zeichen lang sein (bei DirectConnection: 1MB).

    Beispiel:

    var points = user.getPersistence().getNumber('points');
var data = {
    points: points
}
appContentSession.sendEvent('getPoints', data);
// Mit Client.addEventListener('getPoints', callback) kann das Event im Client empfangen werden.