Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    AppContent

    AppContent Klasse

    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){
    // code here
});

    getAppViewMode

    () AppViewMode

    Liefert den AppViewMode.

    Rückgabewert:

    AppViewMode:

    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:

    HTMLFile:

    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:

    LoadConfiguration:

    Beispiel:

    var loadConfiguration = appContent.getLoadConfiguration();

    getSessions

    () AppContentSession[]

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

    Rückgabewert:

    AppContentSession[]:

    Beispiel:

    var appContentSessions = appContent.getSessions();

    getUsers

    () User[]

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

    Rückgabewert:

    User[]:

    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

    globalContent

    (
    • htmlFile
    )
    AppContent static

    Liefert einen AppContent, der das HTMLFile als als Globale App (300x400) anzeigt. Dies kann nur in new GlobalAppConfig(...) verwendet werden.

    Parameter:

    Rückgabewert:

    AppContent:

    globalContent

    (
    • htmlFile
    • width
    • height
    )
    AppContent static

    Liefert einen AppContent, der das HTMLFile als als Globale App anzeigt. Dies kann nur in new GlobalAppConfig(...) verwendet werden.

    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:

    AppContent:

    headerbarContent

    (
    • htmlFile
    • height
    )
    AppContent static

    Liefert einen AppContent, der das HTMLFile im Applet/HTML-Chat als HeaderBar anzeigt.

    1. Die Breite bei setSize() wird ignoriert. Die Höhe ist auf 20 - 500 limitiert. Client.getHostFrame().setSize(0, 200);
    2. Im HTMLChat scheint per default der Channel-Hintergrund durch die Headerbar durch. Um dies zu unterbinden muss man lediglich dem body eine Hintergrundfarbe geben.

    Parameter:

    • htmlFile HTMLFile
    • height Number

      muss eine Ganzzahl zwischen 20 und 500 sein

    Rückgabewert:

    AppContent:

    Beispiel:

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

var headerbarContent = AppContent.headerbarContent(htmlFile, 50);
user.sendAppContent(headerbarContent);

    isAllowJFXBrowser

    () Boolean

    Liefert den Wert, der mittels setAllowJFXBrowser(boolean) gesetzt werden kann. Siehe dort.

    Rückgabewert:

    Boolean:

    Beispiel:

    var allowJFX = appContent.isAllowJFXBrowser();

    isResponsive

    () Boolean

    Liefert den Wert, der mittels setResponsive(boolean) gesetzt werden kann. Siehe dort.

    Rückgabewert:

    Boolean:

    Beispiel:

    var isResponsive = appContent.isResponsive();

    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:

    AppContent:

    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:

    AppContent:

    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:

    AppContent:

    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:

    AppContent:

    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

      Neuer 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 (bei DirectConnection: 1MB).

    Beispiel:

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

    setAllowJFXBrowser

    (
    • allowJFXBrowser
    )

    Legt fest ob dieser AppContent im JFX-Browser angezeigt werden darf. Ist dem nicht so, wird dem User stattdessen eine Info angezeigt, wie er den JX-Browser bekommen kann. Default: true

    Parameter:

    Beispiel:

    appContent.setAllowJFXBrowser(false);

    setResponsive

    (
    • isResponsive
    )

    Legt fest ob dieser AppContent immer auf die anfangs gesetzte Breite und Höhe skaliert werden soll (responsive == false) oder ob der View sich dynamisch an mehr oder weniger verfügbare Pixel anpassen kann (responsive == true). Default: false

    Parameter:

    Beispiel:

    appContent.setResponsive(true);