Modul: GlobalApps

Verfügbar ab Version AppServer 20210803-133329

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

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

() AppContentSession | Null

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

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.

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();

getOpenSlashCommand

() String

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.

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);