CustomData.js umfasst die Funktionalität zum Steuern des Custom-Data-Datenspeichers.
Prinzip der Callback-Funktionen:
Die meisten der hier angebotenen JS-Funktionen haben als Parameter eine Callback-Funktion. Sie dient dazu den Status oder die erhaltenen Daten zu verarbeiten.
Den Status oder den erhaltenen Wert bekommt die Funktion als Übergabe-Parameter.
Beispiel:
Soll ein Wert aus CustomData gelesen und anschließend angezeigt werden, so kann dies mit folgender Funktion stattfinden:
handleValue = function (value) {
alert(value);
}
CONTAILOR.API.CustomData.getItem("myKey", handleValue);
Wichtig!
setItem kann nur aufgerufen werden, wenn ein Benutzer am System angemeldet ist.
Speichert einen Wert in CustomData.
key - Schlüsselbezeichner, unter dem der Wert ansprechbar sein soll. Dieser muss eindeutig sein, darf also noch nicht exstieren. Esistiert der Wert bereits wird ein Status "Failed" geliefert.
value - Zu speichernder Wert
options - Ein Objekt, das folgende Optionen enthalten kann (werden nicht existente Optionen angegeben, werden diese ignoriert):
callbackFunction - Funktion, die nach Ausführung der Funktion aufgerufen werden soll. Sie bekommt als Parameter einen String-Status. Dieser kann wie folgt lauten:
CONTAILOR.API.CustomData.setItem("myKey", "myValue", {fileIDs: [4, 2], pageID: 42}, handleSetFunction);
Holt einen Wert aus CustomData.
callbackFunction - Funktion, die nach Ausführung der Funktion aufgerufen werden soll. Sie bekommt als Parameter den gewünschten Wert.
CONTAILOR.API.CustomData.getItem("myKey", handleGetFunction);
Holt einen Wert aus CustomData.
key - Schlüsselbezeichner des gewünschten Werts. Existiert kein Wert zum gegebenen Schlüssel, wird undefined geliefert.
callbackFunction - Funktion, die nach Ausführung der Funktion aufgerufen werden soll. Sie bekommt als Parameter den gewünschten Wert.
Mögliche Optionen sind (werden nicht existente Optionen angegeben, werden diese ignoriert):
CONTAILOR.API.CustomData.getItem("myKey", handleGetFunction);
Löscht einen Wert aus CustomData.
key: Schlüsselbezeichner des gewünschten Werts. Existiert kein Wert zum gegebenen Schlüssel, kommt "Failed" als Status zurück.
callbackFunction: Funktion, die nach Ausführung der Funktion aufgerufen werden soll. Sie bekommt als Parameter den gewünschten Wert.
CONTAILOR.API.CustomData.deleteItem("myKey", handleDeleteFunction)