Anzeigen:
Modul: Core

Mit einer Instanz von AppProfileEntryAccess kann eine App AppProfileEntry-Objekte (Profileinträge) erzeugen und verwalten.

Die Instanz für die AppProfileEntryAccess erhält man über das KnuddelsServer-Objekt mit KnuddelsServer.getAppProfileEntryAccess()



Achtung: Derzeit darf eine App bis zu fünf AppProfileEntries haben.

Achtung: Profileinträge werden nur dann angezeigt, wenn der Channel sichtbar ist.

Methoden

createOrUpdateEntry

(
  • toplist
  • toplistDisplayType
)
AppProfileEntry

Erzeugt oder aktualisiert ein AppProfileEntry anhand der übergebenen Toplist und dem ToplistDisplayType und liefert den AppProfileEntry im Anschluss zurück.

Profileinträge, die erzeugt werden, sind nur sichtbar, solange die App läuft und werden im Profil ausgeblendet, sofern die App aus ist.

Parameter:

Rückgabewert:

Beispiel:

var toplist = toplistAccess.createOrUpdateToplist('points', 'Punkte');

appProfileEntryAccess.createOrUpdateEntry(toplist, ToplistDisplayType.Value);

getAllProfileEntries

() AppProfileEntry[]

Liefert die Liste aller AppProfileEntry-Objekte, die diese App erzeugt hat.

Rückgabewert:

Beispiel:

var allProfileEntries = appProfileEntryAccess.getAllProfileEntries();

getAppProfileEntry

(
  • userPersistenceNumberKey
)
AppProfileEntry

Liefert den AppProfileEntry für den übergebenen userPersistenceNumberKey.

Parameter:

  • userPersistenceNumberKey String

Rückgabewert:

Beispiel:

var pointsProfileEntry = appProfileEntryAccess.getAppProfileEntry('points');

removeEntry

(
  • appProfileEntry
)

Löscht den übergebenen AppProfileEntry.

Parameter:

Beispiel:

appProfileEntryAccess.removeEntry(appProfileEntry);