Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    GlobalAppConfig

    GlobalAppConfig Klasse

    Modul: GlobalApps

    Verfügbar ab Version AppServer 20210803-133329

    Ermöglicht die Konfiguration einer globalen App. Siehe new GlobalAppConfig(...) für ein Verwendungsbeispiel.

    Methoden

    getAllowedGenders

    () Gender[]

    Liefert die aktuelle Einstellung für allowedGenders zurück. Siehe setAllowedGenders(...) für mehr Details.

    Rückgabewert:

    Gender[]:

    allowedGenders

    Beispiel:

    let allowedGenders = globalAppConfig.getAllowedGenders();

    getAllowedUserIds

    () Number[]

    Liefert die allowedUserIds mit den Ids von Usern, welche diese App öffnen dürfen. Siehe setAllowedUserIds(...) für mehr Details.

    Rückgabewert:

    Number[]:

    allowedUserIds Array mit den Ids von Usern, welche diese App öffnen dürfen.

    Beispiel:

    let allowedUserIds = globalAppConfig.getAllowedUserIds();

    getBlockedUserIds

    () Number[]

    Liefert die blockedUserIds mit den Ids von Usern, welche diese App NICHT öffnen dürfen. Siehe setBlockedUserIds(...) für mehr Details.

    Rückgabewert:

    Number[]:

    blockedUserIds Array mit den Ids von Usern, welche diese App NICHT öffnen dürfen.

    Beispiel:

    let blockedUserIds = globalAppConfig.getBlockedUserIds();

    getCategories

    () GlobalAppCategory[]

    Gibt die konfigurierten Kategorien dieser App zurück. Siehe setCategories(...) für mehr Details.

    Rückgabewert:

    GlobalAppCategory[]:

    categories Array mit den Kategorien dieser App. Standard: []

    Beispiel:

    let categories = globalAppConfig.getCategories();

    getDisplayName

    () String

    Liefert den aktuellen displayName zurück. Siehe setDisplayName(...) für mehr Details.

    Rückgabewert:

    String:

    displayName

    Beispiel:

    let displayName = globalAppConfig.getDisplayName();

    getFeaturedCardColor

    () Color

    Liefert die aktuelle featuredCardColor zurück. Siehe setFeaturedCardColor(...) für mehr Details.

    Rückgabewert:

    Color:

    featuredCardColor

    Beispiel:

    let featuredCardColor = globalAppConfig.getFeaturedCardColor();

    getFeaturedImagePath

    () String

    Liefert den aktuellen featuredImagePath zurück. Standard: "". Siehe setFeaturedImagePath(...) für mehr Details.

    Rückgabewert:

    String:

    featuredImagePath

    Beispiel:

    let featuredImagePath = globalAppConfig.getFeaturedImagePath();

    getId

    () String

    Liefert die globalAppId zurück. Siehe new GlobalAppConfig(...) für mehr Details.

    Rückgabewert:

    String:

    globalAppId

    Beispiel:

    let globalAppId = globalAppConfig.getId();

    getImagePath

    () String

    Liefert den aktuellen imagePath zurück. Standard: "". Siehe setImagePath(...) für mehr Details.

    Rückgabewert:

    String:

    imagePath

    Beispiel:

    let imagePath = globalAppConfig.getImagePath();

    getMaxAge

    () Boolean

    Liefert die aktuelle Einstellung für maxAge zurück. Siehe setMaxAge(...) für mehr Details.

    Rückgabewert:

    Boolean:

    maxAge

    Beispiel:

    let maxAge = globalAppConfig.getMaxAge();

    getMinAge

    () Boolean

    Liefert die aktuelle Einstellung für minAge zurück. Siehe setMinAge(...) für mehr Details.

    Rückgabewert:

    Boolean:

    minAge

    Beispiel:

    let minAge = globalAppConfig.getMinAge();

    getMinRegDays

    () Boolean

    Liefert die aktuelle Einstellung für minRegDays zurück. Siehe setMinRegDays(...) für mehr Details.

    Rückgabewert:

    Boolean:

    minRegDays

    Beispiel:

    let minRegDays = globalAppConfig.getMinRegDays();

    getMinStatus

    () UserStatus

    Liefert die aktuelle Einstellung für minStatus zurück. Siehe setMinStatus(...) für mehr Details.

    Rückgabewert:

    UserStatus:

    minStatus

    Beispiel:

    let minStatus = globalAppConfig.getMinStatus();

    getOpenRequestHandler

    () Function

    Liefert den OpenRequestHandler, welcher in new GlobalAppConfig(...) oder per setOpenRequestHandler(...) gesetzt wurde.

    Rückgabewert:

    Function:

    Der OpenRequestHandler

    Beispiel:

    let openRequestHandler = globalAppConfig.getOpenRequestHandler();

    getSessionOpenedCallback

    () Function

    Liefert den SessionOpenedCallback, welcher per setSessionOpenedCallback(...) gesetzt wurde oder undefined.

    Rückgabewert:

    Function:

    Der SessionOpenedCallback

    Beispiel:

    let sessionOpenedCallback = globalAppConfig.getSessionOpenedCallback();

    getShowDeveloper

    () Boolean

    Gibt zurück, ob in der Info-Bar im globalen App-Fenster der Entwickler der App angezeigt werden soll, oder nicht. Siehe setShowDeveloper(...) für mehr Details.

    Rückgabewert:

    Boolean:

    Standard: false

    Beispiel:

    let showDeveloper = globalAppConfig.getShowDeveloper();

    GlobalAppConfig

    (
    • globalAppId
    • displayName
    • openRequestHandler
    )

    Erzeugt eine GlobalAppConfig-Instanz um deine globale App im App-Menü zu registrieren.

    Parameter:

    • globalAppId String

      Eine (in deiner User-App) eindeutige ID, welche diese globale App identifiziert. Die ID muss zwischen 1 und 25 Zeichen lang sein und darf nur aus Buchstaben und Zahlen bestehen. Sie wird verwendet um diese Instanz zu identifizieren z.B. in AppAccess.unregisterGlobalApp(String globalAppId) oder als Teil des Slash-Befehls um diese App zu öffnen.

    • displayName String

      Der Anzeige-Name deiner globalen App. Dieser wird in der App-Übersicht angezeigt. Er muss zwischen 2 und 40 Zeichen lang sein und sollte deine App gut beschreiben.

    • openRequestHandler Function

      Eine Funktion, welche aufgerufen wird, wenn ein User diese App anklickt um sie zu öffnen. Die Funktion muss einen AppContent mit AppViewMode.Global zurück geben. Siehe AppContent.globalContent(HTMLFile).

    Beispiel:

    try {
    var globalAppConfig = new GlobalAppConfig('game1', 'Mein Spiel', function(user, globalAppInstance) {
        return AppContent.globalContent(new HTMLFile('game1.html'), 400, 400);
    });
    // globalAppConfig.set[...](...); // setze weitere Optionen für diese globale App
    var globalAppInstance = KnuddelsServer.getAppAccess().registerGlobalApp(globalAppConfig);
} catch (e) {
    // Fehlerbehandlung, z.B. loggen oder Nachricht and den Channel-Owner oder App-Entwickler.
}

    isRestrictToOneIp

    () Boolean

    Liefert die aktuelle Einstellung für restrictToOneIp zurück. Siehe setRestrictToOneIp(...) für mehr Details.

    Rückgabewert:

    Boolean:

    restrictToOneIp

    Beispiel:

    let restrictToOneIp = globalAppConfig.isRestrictToOneIp();

    setAllowedGenders

    (
    • [allowedGenders]
    )

    Setzt die erlaubten Geschlechter für diese App. Ist das Geschlecht des Users nicht in dieser Liste, so wird ihm/ihr diese App nicht angezeigt und kann nicht geöffnet werden.

    Parameter:

    • [allowedGenders] Gender[] optional multiple

      Die erlaubten Genders für diese App. Standard: Alle (Gender.Male, Gender.Female, Gender.Unknown)

    Beispiel:

    globalAppConfig.setAllowedGenders(Gender.Male, Gender.Unknown);

    setAllowedUserIds

    (
    • allowedUserIds
    )

    Setzt die allowedUserIds mit userIds von Usern, welche diese App öffnen dürfen. Wenn diese Liste nicht leer ist können NUR User auf dieser Liste diese globale App sehen und öffnen. Ist die Liste leer, so können grundsätzlich alle User die App sehen und öffnen. Die anderen Beschränkungen (Alter, Status, etc.) werden für User auf der Liste nicht mehr geprüft.

    Parameter:

    • allowedUserIds Number[]

      Array mit ids von Usern, welche diese App öffnen dürfen. Die Liste ist auf 1000 Einträge limitiert.

    Beispiel:

    globalAppConfig.setAllowedUserIds([500, 43342, 46474742, 1345664]);

    setBlockedUserIds

    (
    • blockedUserIds
    )

    Parameter:

    • blockedUserIds Number[]

      Array mit userIds von Usern, welche diese App nicht öffnen dürfen. Die Liste ist auf 1000 Einträge limitiert.

    Beispiel:

    globalAppConfig.setBlockedUserIds([500, 43342, 46474742, 1345664]);

    setCategories

    (
    • [categories]
    )

    Setzt die Kategorien für diese App. Die Kategorien werden verwendet um alle Apps in sinnvolle Themenbereiche zu unterteilen und sie werden in der App-Übersicht angezeigt. Außerdem werden anhand der Kategorie die Standard-Bilder für die App gewählt, falls die App keine eigenen Bilder konfiguriert hat.

    Parameter:

    • [categories] GlobalAppCategory optional multiple

      Die Kategorien der App (Anzahl: 0-2).

    Beispiel:

    globalAppConfig.setCategories(GlobalAppCategory.Puzzle); // ... oder bis zu 2 Kategorien:
globalAppConfig.setCategories(GlobalAppCategory.Casino, GlobalAppCategory.Slotmachine);

    setDisplayName

    (
    • displayName
    )

    Setzt den displayName (Anzeige-Name) für diese Globale App. Der displayName wird initial beim Anlegen einer globalen App gesetzt. Mit dieser Methode kann er nachträglich geändert werden. Siehe new GlobalAppConfig(...) für mehr Details.

    Parameter:

    • displayName String

      Dieser Name wird in der App-Übersicht für deine App angezeigt. Wähle ihn mit Bedacht!

    Beispiel:

    globalAppConfig.setDisplayName('Mein neuer Name');

    setFeaturedCardColor

    (
    • featuredCardColor
    )

    Setzt die App-Farbe für die Anzeige als "Featured App" deiner globalen App in der App-Übersicht. Rufe die Funktion mit null auf um die Farbe zurück auf Standard zu setzen.

    Parameter:

    • featuredCardColor Color

      Die Farbe für die Anzeige als Featured-App in der App-Übersicht. Standard: Color.fromRGB(48, 48, 48)

    Beispiel:

    globalAppConfig.setFeaturedCardColor(Color.fromRGB(0, 200, 0));

    setFeaturedImagePath

    (
    • [featuredImagePath]
    )

    Setzt das App-Bild für die Anzeige als "Featured App" deiner globalen App im App-Menü. Wird kein Bild gesetzt, so nimmt das System ein Standard-Bild entsprechend der App-Kategorie. Das Bild muss die Größe 366 x 145 px haben. Hat es eine andere Größe, so wir das Standard-Bild verwendet.

    Erlaubt sind GIF (unanimiert), PNG und JPG Bilder. Das Bild muss existieren. Rufe die Funktion mit " auf um das Bild zurück auf Standard zu setzen.

    Parameter:

    • [featuredImagePath] String optional

      Relativer Pfad zu deinem Featured-App-Bild im www-Ordner deiner App. z.B. 'featured1.png' -> 'ftp/meineApp/www/featured1.png' oder 'images/featured2.png' -> 'ftp/meineApp/www/images/featured2.png'

    Beispiel:

    globalAppConfig.setFeaturedImagePath('featured1.png'); // ftp/meineApp/www/featured1.png (muss existieren)

    setImagePath

    (
    • [imagePath]
    )

    Setzt das App-Bild für die normale Anzeige deiner globalen App im App-Menü. Wird kein Bild gesetzt, so nimmt das System ein Standard-Bild entsprechend der App-Kategorie. Das Bild muss die Größe 140 x 114 px haben. Hat es eine andere Größe, so wir das Standard-Bild verwendet.

    Erlaubt sind GIF (unanimiert), PNG und JPG Bilder. Das Bild muss existieren. Rufe die Funktion mit "" auf um das Bild zurück auf Standard zu setzen.

    Parameter:

    • [imagePath] String optional

      Relativer Pfad zu deinem App-Bild im www-Ordner deiner App. z.B. 'app1.png' -> 'ftp/meineApp/www/app1.png' oder 'images/app2.png' -> 'ftp/meineApp/www/images/app2.png'

    Beispiel:

    globalAppConfig.setImagePath('game1.png'); // ftp/meineApp/www/game1.png (muss existieren)

    setMaxAge

    (
    • maxAge
    )

    Setzt das maxAge für diese Globale App. Nur User, welche höchstens dieses Alter haben, können diese globale App sehen und öffnen.

    Parameter:

    • maxAge Number

      Das neue Maximalalter. Standard: 999

    Beispiel:

    globalAppConfig.setMaxAge(50);

    setMinAge

    (
    • minAge
    )

    Setzt das minAge für diese Globale App. Nur User, welche mindestens dieses Alter haben, können diese globale App sehen und öffnen.

    Parameter:

    • minAge Number

      Das neue Mindestalter. Standard: 0

    Beispiel:

    globalAppConfig.setMinAge(18);

    setMinRegDays

    (
    • minRegDays
    )

    Setzt das minRegDays für diese Globale App. Nur User, welche mindestens so viele Tage bei Knuddels registriert sind, können diese globale App sehen und öffnen. Hiermit kann man also neue Accounts für eine gewisse Zeit ausschließen.

    Parameter:

    • minRegDays Number

      Die neue Anzahl Tage seit Registrierung. Standard: 0, Max: 999

    Beispiel:

    globalAppConfig.setMinRegDays(7);

    setMinStatus

    (
    • minStatus
    )

    Setzt den minStatus für diese Globale App. Nur User, welche mindestens diesen Status haben, können diese globale App sehen und öffnen.

    Parameter:

    • minStatus UserStatus

      Der neue Mindeststatus. Standard: Newbiew

    Beispiel:

    globalAppConfig.setMinStatus(UserStatus.Stammi);

    setOpenRequestHandler

    (
    • openRequestHandler
    )

    Hiermit kann der OpenRequestHandler nachträglich überschrieben werden. Siehe new GlobalAppConfig(...) für mehr Details.

    Parameter:

    • openRequestHandler Function

      Der neue OpenRequestHandler.

    Beispiel:

    globalAppConfig.setOpenRequestHandler(function(user, globalAppInstance) {
    return AppContent.globalContent(new HTMLFile('app1.html'), 400, 300);
});

    setRestrictToOneIp

    (
    • restrictToOneIp
    )

    Setzt restrictToOneIp für diese Globale App. Legt fest, ob diese App nur einmal pro IP geöffnet werden darf. Diese Option blendet die App nicht aus, sondern zeigt dem Nutzer eine entsprechende Meldung an, wenn ein zweites mal (zweiter Account) von der selben IP versucht wird diese App zu öffnen.

    Parameter:

    • restrictToOneIp Boolean

      Darf diese globale App nur einmal pro IP geöffnet werden? Standard: false

    Beispiel:

    globalAppConfig.setRestrictToOneIp(true);

    setSessionOpenedCallback

    (
    • [sessionOpenedCallback]
    )

    Hiermit kann der SessionOpenedCallback gesetzt werden. Dieser wird aufgerufen, nachdem eine neue AppContentSession für diese globale App geöffnet wurde. Hier können z.B. Events an den Client gesendet werden, die direkt nach dem Öffnen der UI benötigt werden.

    Parameter:

    • [sessionOpenedCallback] Function optional

      Der neue SessionOpenedCallback.

    Beispiel:

    globalAppConfig.setSessionOpenedCallback(function(appContentSession) {
    const user = appContentSession.getUser(); // der User, falls er gebaucht wird
    appContentSession.sendEvent('initialData', {name: 'Hugo'}); // optional, macht aber oft Sinn
});

    setShowDeveloper

    (
    • [showDeveloper]
    )

    Legt fest, ob in der Info-Bar im globalen App-Fenster der Entwickler der App angezeigt werden soll, oder nicht. Wenn true dann wird der Nick des Entwicklers dieser App im Info-Bereich in der Info-Bar im globalen App-Fenster angezeigt.

    Parameter:

    • [showDeveloper] Boolean optional

      Standard: false

    Beispiel:

    globalAppConfig.setShowDeveloper(true);

    toString

    () String

    Rückgabewert:

    String:

    Liefert die GlobalAppConfig als JSON-String.

    Beispiel:

    logger.log('Meine GlobalAppConfig: ' + globalAppConfig.toString());