Hilfe-Center

CustomData

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:

Copy

handleValue = function (value) {
alert(value);
}

CONTAILOR.API.CustomData.getItem("myKey", handleValue);

Wichtig!

setItem kann nur aufgerufen werden, wenn ein Benutzer am System angemeldet ist.

CONTAILOR.API.CustomData.setItem(key, value, options, callbackFunction)

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

  • fileIDs (optional - Default []): IDs von Dateien, zu denen die gespeicherten Daten Bezug haben
  • pageID (optional - Default 0): ID der Seite, zu der die gespeicherten Daten Bezug haben
  • shapeID (optional - Default 0): ID des Shapes, zu dem die gespeicherten Daten Bezug haben
  • attributeValueID (optional - Default 0): ID des Attributs, zu dem die gespeicherten Daten Bezug haben
  • userID (optional - Default 0): ID des Benutzers , zu dem die gespeicherten Daten Bezug haben
  • administratorID (optional - Default 0): ID des Administrators, zu dem die gespeicherten Daten Bezug haben
  • sessionID (optional - Default '""): String-Identifier der Sitzung, zu der die gespeicherten Daten Bezug haben

​​​​​​callbackFunction - Funktion, die nach Ausführung der Funktion aufgerufen werden soll. Sie bekommt als Parameter einen String-Status. Dieser kann wie folgt lauten:

  • "Saved": Der Wert wurde erfolgreich gespeichert
  • "NoChanges": Die Aktion löste keine Änderung aus
  • "Failed": Fehlgeschlagen. Dies ist in aller Regel nur dann der Fall, wenn es in CustomData bereits einen Wert mit dem angegebenen Schlüssel gibt.
  • "NotAllowed": Es ist kein User angemeldet oder es wurde kein oder ein nicht angemeldeter User zum Setzen des Werts übergeben
Copy

CONTAILOR.API.CustomData.setItem("myKey", "myValue", {fileIDs: [4, 2], pageID: 42}, handleSetFunction);

CONTAILOR.API.CustomData.getItem(key, callbackFunction) 

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.

Copy

CONTAILOR.API.CustomData.getItem("myKey", handleGetFunction);

CONTAILOR.API.CustomData.getItem(key, options, callbackFunction) 

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.

  • options: Hiermit kann gewählt werden, welche Werte auf das gesuchte Item zutreffen sollen:

Mögliche Optionen sind (werden nicht existente Optionen angegeben, werden diese ignoriert):

  • parentID
  • fileID
  • pageID
  • shapeID
  • attributeValueID
  • userID
  • administratorID
  • sessionID
Copy

CONTAILOR.API.CustomData.getItem("myKey", handleGetFunction);

CONTAILOR.API.CustomData.deleteItem(key, callbackFunction)

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.

Copy

CONTAILOR.API.CustomData.deleteItem("myKey", handleDeleteFunction)

War dieser Beitrag hilfreich?
0 von 0 fanden dies hilfreich.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.