Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    GlobalAppInstance

    GlobalAppInstance Klasse

    Modul: GlobalApps

    Verfügbar ab Version AppServer 20210803-133329

    Ermöglicht Zugriff eine globale App Instanz.

    Eine User-App kann globale Apps registrieren. Diese werden (auf den meisten Clients) im "Spiele und Apps" Menü in der Sidebar angezeigt. User können diese Apps starten ohne den zugehörigen Channel zu betreten.

    Die Instanz von GlobalAppInstance erhält man beim Registrieren über AppAccess.registerGlobalApp(GlobalAppConfig) oder später über AppAccess.getGlobalAppInstance(...) oder AppAccess.getAllGlobalAppInstances().

    Methoden

    closeActiveSessions

    ()

    Schließt (im Client) und entfernt alle aktiven AppContentSessions dieser globalen App-Instanz.

    getActiveSession

    (
    • userId
    )
    AppContentSession | Null

    Liefert die AppContentSessions dieser globalen App-Instanz für die übergebene User-Id.

    Parameter:

    • userId Number

      Die neue GlobalAppConfig.

    Rückgabewert:

    AppContentSession | Null:

    Die AppContentSession des übergebenen Users oder null.

    getActiveSessions

    () AppContentSession[]

    Liefert alle aktiven AppContentSessions dieser globalen App-Instanz.

    Rückgabewert:

    AppContentSession[]:

    Array mit den AppContentSessions.

    getAddAsFavoriteChatCommand

    () String

    Verfügbar ab Version AppServer 20220502-125000

    Liefert den Slash-Befehl um diese globale App als Favorit hinzuzufügen. Favoriten werden (derzeit [Mai 2022] nur in der STAPP) in der Seitenleiste angezeigt und können mit nur einem Klick geöffnet werden.

    Rückgabewert:

    String:

    Der Befehl für diese globale App.

    getAppConfig

    () GlobalAppConfig

    Liefert die aktuelle GlobalAppConfig dieser GlobalAppInstance.

    Rückgabewert:

    GlobalAppConfig:

    Die aktuelle GlobalAppConfig. Änderungen daran werden NICHT automatisch übernommen. Siehe auch AppContent/setAppConfig:method.

    Beispiel:

    let globalAppConfig = globalAppInstance.getAppConfig();

    getOpenAppChatCommand

    () String

    Verfügbar ab Version AppServer 20220502-125000

    Liefert den Slash-Befehl um diese globale App über den Standard-Mechanismus zu öffnen.

    Rückgabewert:

    String:

    Der Start-Befehl für diese globale App.

    getOpenSlashCommand

    () String Veraltet

    Veraltet: Verwende stattdessen getOpenAppChatCommand()

    Liefert den Slash-Befehl um diese globale App über den Standard-Mechanismus zu öffnen.

    Rückgabewert:

    String:

    Der Start-Befehl für diese globale App.

    getRemoveAsFavoriteChatCommand

    () String

    Verfügbar ab Version AppServer 20220502-125000

    Liefert den Slash-Befehl um diese globale App als Favorit zu entfernen. Favoriten werden (derzeit [Mai 2022] nur in der STAPP) in der Seitenleiste angezeigt und können mit nur einem Klick geöffnet werden.

    Rückgabewert:

    String:

    Der Befehl für diese globale App.

    hasAsFavorite

    (
    • user
    )
    Boolean

    Verfügbar ab Version AppServer 20220502-152500

    Liefert true, wenn der übergebene User diese globale App als Favorit gesetzt hat. Favoriten werden (derzeit [Mai 2022] nur in der STAPP) in der Seitenleiste angezeigt und können mit nur einem Klick geöffnet werden.

    Parameter:

    • user User

      Der User, der geprüft werden soll.

    Rückgabewert:

    Boolean:

    true, wenn der User diese globale App als Favorit gesetzt hat, sonst false.

    Beispiel:

    let isFavorite = KnuddelsServer.getAppAccess().getGlobalAppInstance('myGlobalApp').hasAsFavorite(user);

    openGlobalApp

    (
    • user
    • [forceReplace]
    )
    AppContentSession

    Versucht diese globale App für den angegebenen User zu öffnen. Falls der User diese Globale App bereits offen hat (und forceReplace == false ist), wird die bereits existierende AppContentSession zurückgegeben und nichts weiter getan.

    Die Globale App kann für den User nur geöffnet werden, wenn:

    • der User die Globale App grundsätzlich öffnen kann (GlobalAppConfig)
    • und aktuell im Channel ist oder bereits eine Globale App dieser User App offen hat
    Wenn die Globale App nicht bereits für den User offen ist und nicht geöffnet werden konnte, wird undefined zurückgegeben.

    Parameter:

    • user User

      Der User, für den diese Globale App geöffnet werden soll.

    • [forceReplace] Boolean optional

      Wenn true, so wird die App erneut geöffnet, auch wenn sie bereits offen war. (Default: false)

    Rückgabewert:

    AppContentSession:

    Die AppContentSession des User für diese Globale App oder undefined, falls die App nicht geöffnet werden konnte.

    setAppConfig

    (
    • appConfig
    )

    Setzt die GlobalAppConfig für diese GlobalAppInstance. Die neuen Einstellungen werden sofort aktiviert. Bereits geöffnete Apps werden dabei NICHT automatisch geschlossen, falls die neuen Einstellungen dies nicht mehr erlauben würden.

    Parameter:

    Beispiel:

    let globalAppConfig = globalAppInstance.getAppConfig();
globalAppConfig.setMinAge(24);
globalAppInstance.setAppConfig(globalAppConfig);