Modul: HTMLUI

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

Methoden

getAppContent

() AppContent

Liefert den verbundenen AppContent.

Rückgabewert:

Beispiel:

var appContent = appContentSession.getAppContent();

getAppViewMode

() AppViewMode

Liefert den AppViewMode.

Rückgabewert:

Beispiel:

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

getGlobalAppInstance

() GlobalAppInstance | Null

BETA Diese API ist noch in der Entwicklung und kann sich bis zum Release noch ändern.

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

Rückgabewert:

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

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.

Beispiel:

var points = user.getPersistence().getNumber('points');

var data = {
    points: points
}

// via Client.addEventListener('getPoints', callback) kann das Event clientseitig empfangen werden
appContentSession.sendEvent('getPoints', data);