Anzeigen:
Modul: HTMLUI

Repräsentiert den visuellen Inhalt einer Applikation, der Usern angezeigt werden soll.

Methoden

addCloseListener

(
  • callback
)

Fügt einen Listener hinzu, der aufgerufen wird, wenn jemand den AppContent schließt.

Parameter:

Beispiel:

appContent.addCloseListener(function(user, appContent){

});

getAppViewMode

() AppViewMode

Liefert den AppViewMode.

Rückgabewert:

Beispiel:

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

getHeight

() Number

Liefert die Höhe des AppContent.

Rückgabewert:

Number:

height

Beispiel:

var height = appContent.getHeight(); // i.e.: 200

getHTMLFile

() HTMLFile

Liefert das HTMLFile, das beim Anlegen des AppContents genutzt wurde.

Rückgabewert:

Beispiel:

var htmlFile = appContent.getHTMLFile();

getLoadConfiguration

() LoadConfiguration

Liefert die LoadConfiguration, mit der die Optik beim Laden des HTML User Interface beeinflusst werden kann.

Rückgabewert:

Beispiel:

var loadConfiguration = appContent.getLoadConfiguration();

getSessions

() AppContentSession[]

Liefert eine Liste aller AppContentSessions, die dieses AppContent, die User gerade geöffnet haben.

Rückgabewert:

Beispiel:

var appContentSessions = appContent.getSessions();

getUsers

() User[]

Liefert eine Liste aller User, die diesen AppContent geöffnet haben.

Rückgabewert:

Beispiel:

var users = appContent.getUsers(); i.e. [ User:Finomosec, User:Plex ]

getWidth

() Number

Liefert die Breite des AppContent.

Rückgabewert:

Number:

width

Beispiel:

var width = appContent.getWidth(); // i.e.: 300

overlayContent

(
  • htmlFile
  • width
  • height
)
AppContent static

Liefert einen AppContent, der das HTMLFile als Overlay oben rechts im Channel anzeigt.

Parameter:

  • htmlFile HTMLFile
  • width Number

    muss eine Ganzzahl zwischen 20 und 1000 sein

  • height Number

    muss eine Ganzzahl zwischen 20 und 1000 sein

Rückgabewert:

Beispiel:

var htmlFile = new HTMLFile('start.html');
var overlayContent = AppContent.overlayContent(htmlFile, 300, 300);
user.sendAppContent(overlayContent);

overlayContent

(
  • htmlFile
)
AppContent static

Liefert einen AppContent, der das HTMLFile als Overlay (200x350) oben rechts im Channel anzeigt.

Parameter:

Rückgabewert:

Beispiel:

var htmlFile = new HTMLFile('start.html');
var overlayContent = AppContent.overlayContent(htmlFile);
user.sendAppContent(overlayContent);

popupContent

(
  • htmlFile
)
AppContent static

Liefert einen AppContent, der das HTMLFile im Applet/HTML-Chat als Popup (300x400) und auf Android als Fullscreen-View anzeigt.

Parameter:

Rückgabewert:

Beispiel:

var htmlFile = new HTMLFile('start.html');

var popupContent = AppContent.popupContent(htmlFile);
user.sendAppContent(popupContent);

popupContent

(
  • htmlFile
  • width
  • height
)
AppContent static

Liefert einen AppContent, der das HTMLFile im Applet/HTML-Chat als Popup und auf Android als Fullscreen-View anzeigt.

Parameter:

  • htmlFile HTMLFile
  • width Number

    muss eine Ganzzahl zwischen 50 und 1000 sein

  • height Number

    muss eine Ganzzahl zwischen 50 und 1000 sein

Rückgabewert:

Beispiel:

var htmlFile = new HTMLFile('start.html');

var popupContent = AppContent.popupContent(htmlFile, 300, 400);
user.sendAppContent(popupContent);

remove

()

Entfernt diesen AppContent, bei allen Usern, die diesen AppContent geöffnet haben.

Beispiel:

appContent.remove();

replaceWithAppContent

(
  • newAppContent
)

Ersetzt den AppContent, bei allen Usern, die diesen AppContent geöffnet haben durch den neuen AppContent.



Hinweis: Es können nur AppContent mit demselben AppViewMode zum Ersetzen genutzt werden.

Parameter:

  • newAppContent AppContent

    Neue AppContent, der denselben AppViewMode haben muss

Beispiel:

appContent.replaceWithAppContent(newAppContent);

sendEvent

(
  • type
  • [data]
)

Sendet Daten an alle Nutzer, die diesen AppContent geöffnet haben.

Parameter:

  • type String

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

  • [data] Object optional

    Daten, die übermittelt werden sollen. Werden als JSON übermittelt und dürfen 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
appContent.sendEvent('getPoints', data);