Referenz zur ContextHub-JavaScript-API contexthub-javascript-api-reference

Die ContextHub-JavaScript-API ist für Ihre Skripte verfügbar, wenn die ContextHub-Komponente zur Seite hinzugefügt wurde.

ContextHub-Konstanten contexthub-constants

Konstante Werte, die von der ContextHub-JavaScript-API definiert werden.

Ereigniskonstanten event-constants

In der folgenden Tabelle sind die Namen von Ereignissen aufgeführt, die bei ContextHub-Stores auftreten. Siehe auch ContextHub.Utils.Eventing.

Benutzeroberflächen-Ereigniskonstanten ui-event-constants

In der folgenden Tabelle sind die Namen der Ereignisse aufgeführt, die für die ContextHub-Benutzeroberfläche auftreten.

Referenz zur ContextHub-JavaScript-API contexthub-javascript-api-reference-2

Das ContextHub-Objekt bietet Zugriff auf alle Stores.

Funktionen (ContextHub) functions-contexthub

getAllStores() getallstores

Gibt alle registrierten ContextHub-Stores zurück.

Diese Funktion hat keine Parameter.

Rückgabe

Ein Objekt, das alle ContextHub-Stores enthält. Jeder Store ist ein Objekt, das denselben Namen wie der Store verwendet.

Beispiel

Im folgenden Beispiel werden alle Stores und anschließend der Geolocation-Store abgerufen:

var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation;

getStore(name) getstore-name

Ruft einen Store als ein JavaScript-Objekt ab.

Parameter

Rückgabe

Ein Objekt, das den Store darstellt.

Beispiel

Im folgenden Beispiel wird der Geolocation-Store abgerufen:

var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Stellt ein ContextHub-Segment dar. Verwenden Sie ContextHub.SegmentEngine.SegmentManager , um Segmente abzurufen.

Funktionen (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment

getName() getname

Gibt den Namen des Segments als String -Wert zurück.

getPath() getpath

Gibt den Repository-Pfad der Segmentdefinition als String-Wert zurück.

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Bietet Zugriff auf ContextHub-Segmente.

Funktionen (ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

Gibt die Segmente zurück, die im aktuellen Kontext aufgelöst werden. Diese Funktion hat keine Parameter.

Rückgabe

Ein Array von ContextHub.SegmentEngine.Segment -Objekten.

ContextHub.Store.Core contexthub-store-core

Die Basisklasse für ContextHub-Stores.

Eigenschaften (ContextHub.Store.Core) properties-contexthub-store-core

Vielseitigkeit eventing

Ein ContextHub.Utils.Eventing-Objekt. Verwenden Sie dieses Objekt zum Binden von Funktionen zum Speichern von Ereignissen. Weitere Informationen über den Standardwert und die Initialisierung finden Sie unter init (name,config).

name name

Der Name des Stores.

persistence persistence

Ein ContextHub.Utils.Persistence -Objekt. Weitere Informationen über den Standardwert und die Initialisierung finden Sie unter init(name,config).

Funktionen (ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(tree, options) addallitems-tree-options

Führt ein Datenobjekt oder ein Array mit den Store-Daten zusammen. Jedes Schlüssel/Wert-Paar im Objekt oder Array wird dem Store hinzugefügt (über die Funktion setItem):

Beachten Sie, dass Werte Objekte sein können.

Parameter

Rückgabe

Ein boolean-Wert:

addReference(key, anotherKey) addreference-key-anotherkey

Erstellt einen Verweis von einem Schlüssel zum anderen. Ein Schlüssel kann sich nicht selbst referenzieren.

Parameter

Rückgabe

Ein boolean-Wert:

announceReadiness() announcereadiness

Löst das ready-Ereignis für diesen Store aus. Diese Funktion hat keine Parameter und gibt keinen Wert zurück.

clean() clean

Entfernt alle Daten aus dem Store. Die Funktion hat keine Parameter und keinen Rückgabewert.

getItem(key) getitem-key

Gibt den Wert zurück, der einem Schlüssel zugeordnet ist.

Parameter

Rückgabe

Ein Objekt, das den Wert für den Schlüssel darstellt.

getKeys(includeInternals) getkeys-includeinternals

Ruft die Schlüssel aus dem Store ab. Optional können Sie die Schlüssel abrufen, die intern vom ContextHub-Framework verwendet werden.

Parameter

Rückgabe

Ein Array von Schlüsselnamen (string-Werte).

getReferences() getreferences

Ruft die Referenzen aus dem Store ab.

Rückgabe

Ein Array, das referenzierende Schlüssel als Indizes für die referenzierten Schlüssel verwendet:

getTree(includeInternals) gettree-includeinternals

Ruft die Datenstruktur aus dem Store ab. Optional können Sie die Schlüssel/Wert-Paare einbeziehen, die intern vom ContextHub-Framework verwendet werden.

Parameter

Rückgabe

Ein Objekt, das die Datenstruktur darstellt. Die Schlüssel sind die Eigenschaftsnamen des Objekts.

init(name, config) init-name-config

Initialisiert den Store.

Parameter

isEventingPaused() iseventingpaused

Ermittelt, ob das Eventing für diesen Store angehalten wurde.

Rückgabe

Ein boolescher Wert:

pauseEventing() pauseeventing

Setzt das Eventing für den Store aus, sodass keine Ereignisse ausgelöst werden. Diese Funktion erfordert keine Parameter und gibt keinen Wert zurück.

removeItem(key, options) removeitem-key-options

Entfernt ein Schlüssel/Wert-Paar aus dem Store.

Wenn ein Schlüssel entfernt wird, löst die Funktion das data-Ereignis aus. Die Ereignisdaten enthalten den Namen des Stores, den Namen des entfernten Schlüssels, den entfernten Wert, den neuen Wert für den Schlüssel (null) und den Aktionstyp „Entfernen“.

Optional können Sie das Auslösen des Ereignisses data verhindern.

Parameter

Rückgabe

Ein boolean-Wert:

removeReference(key) removereference-key

Entfernt eine Referenz aus dem Store.

Parameter

Rückgabe

Ein boolean-Wert:

reset(keepRemainingData) reset-keepremainingdata

Setzt die Anfangswerte der persistenten Daten des Stores zurück. Optional können Sie alle anderen Daten aus dem Store entfernen. Eventing wird für diesen Store angehalten, während der Store zurückgesetzt wird. Diese Funktion gibt keinen Wert zurück.

Anfangswerte werden in der initialValues-Eigenschaft des config-Objekts bereitgestellt, das zum Instanziieren des Store-Objekts verwendet wird.

Parameter

Setzt die Anfangswerte der persistenten Daten des Stores zurück. Optional können Sie alle anderen Daten aus dem Store entfernen. Eventing wird für diesen Store angehalten, während der Store zurückgesetzt wird. Diese Funktion gibt keinen Wert zurück.

Anfangswerte werden in der initialValues-Eigenschaft des config-Objekts bereitgestellt, das zum Instanziieren des Store-Objekts verwendet wird.

Parameter

resolveReference(key, retry) resolvereference-key-retry

Ruft einen referenzierten Schlüssel ab. Optional können Sie die Anzahl der Iterationen angeben, die zur Auflösung der besten Übereinstimmung verwendet werden sollen.

Parameter

Rückgabe

Ein string-Wert, der den referenzierten Schlüssel darstellt. Wenn keine Referenz aufgelöst wird, wird der Wert des key-Parameters zurückgegeben.

resumeEventing() resumeeventing

Setzt das Ereignis für diesen Store fort, damit Ereignisse ausgelöst werden. Diese Funktion definiert keine Parameter und gibt keinen Wert zurück.

setItem(key, value, options) setitem-key-value-options

Fügt ein Schlüssel/Wert-Paar dem Store hinzu.

Löst das data-Ereignis nur aus, wenn der Wert für den Schlüssel sich von dem Wert unterscheidet, der aktuell für den Schlüssel gespeichert ist. Optional können Sie das Auslösen des data-Ereignisses verhindern.

Die Ereignisdaten umfassen den Store-Namen, den Schlüssel, den vorherigen Wert, den neuen Wert und den Aktionstyp von set.

Parameter

Rückgabe

Ein boolean-Wert:

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Ein Store, der JSON-Daten enthält. Die Daten werden von einem externen JSONP-Service oder optional von einem Service abgerufen, der JSON-Daten zurückgibt. Geben Sie die Details des Service mithilfe der -Funktion an, wenn Sie eine Instanz dieser Klasse erstellen.init

Der Speicher verwendet speicherinterne Persistenz (JavaScript-Variable). Speicherdaten sind nur während der Lebensdauer der Seite verfügbar.

ContextHub.Store.JSONPStore erweitert ContextHub.Store.Core und übernimmt die Funktionen dieser Klasse.

Funktionen (ContextHub.Store.JSONPStore) functions-contexthub-store-jsonpstore

configureService(serviceConfig, override) configureservice-serviceconfig-override

Konfiguriert die Details für die Verbindung mit dem JSONP-Service, den dieses Objekt verwendet. Sie können entweder die vorhandene Konfiguration aktualisieren oder ersetzen. Die Funktion gibt keinen Wert zurück.

Parameter

getRawResponse() getrawresponse

Gibt die unbearbeitete Antwort zurück, die seit dem letzten Aufruf des JSONP-Service zwischengespeichert wurde. Für die Funktion sind keine Parameter erforderlich.

Rückgabe

Ein Objekt, das die unformatierte Antwort darstellt.

getServiceDetails() getservicedetails

Ruft das Service-Objekt für dieses ContextHub.Store.JSONPStore-Objekt ab. Das Service-Objekt enthält alle Informationen, die zum Erstellen der Service-URL erforderlich sind.

Rückgabe

Ein Objekt mit den folgenden Eigenschaften:

getServiceURL(resolve) getserviceurl-resolve

Ruft die URL des JSONP-Service ab.

Parameter

Rückgabe

Ein string-Wert, der die Service-URL darstellt.

init(name, config) init-name-config-1

initialisiert das Objekt ContextHub.Store.JSONPStore .

Parameter

queryService(reload) queryservice-reload

Fragt den Remote-JSONP-Service ab und speichert die Antwort zwischen. Wenn die Zeit seit dem letzten Aufruf dieser Funktion kleiner als der Wert von config.service.ttl ist, wird der Service nicht aufgerufen und die zwischengespeicherte Antwort wird nicht geändert. Optional können Sie einen Aufruf des Service erzwingen. Die Eigenschaft config.service.ttl wird festgelegt, wenn die init-Funktion aufgerufen wird, um den Store zu initialisieren.

Löst das bereites Ereignis aus, wenn die Abfrage beendet ist. Wenn die JSONP-Dienst-URL nicht festgelegt ist, führt die Funktion nichts aus.

Parameter

Zurücksetzen reset

Setzt die Anfangswerte der persistenten Daten des Stores zurück und ruft dann den JSONP-Service auf. Optional können Sie alle anderen Daten aus dem Store entfernen. Eventing wird für diesen Store angehalten, während die Anfangswerte zurückgesetzt werden. Diese Funktion gibt keinen Wert zurück.

Anfangswerte werden in der initialValues-Eigenschaft des config-Objekts bereitgestellt, das zum Instanziieren des Store-Objekts verwendet wird.

Parameter

resolveParameter(f) resolveparameter-f

Löst den angegebenen Parameter auf.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore erweitert ContextHub.Store.JSONPStore so, dass es alle Funktionen dieser Klasse übernimmt. Die Daten, die vom JSONP-Service abgerufen werden, bleiben jedoch gemäß der Konfiguration der ContextHub-Persistenz bestehen. (Siehe Persistenzmodi.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore erweitert ContextHub.Store.Core so, dass es alle Funktionen dieser Klasse übernimmt. Die Daten in diesem Store werden gemäß der Konfiguration der ContextHub-Persistenz beibehalten.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore erweitert ContextHub.Store.Core so, dass es alle Funktionen dieser Klasse übernimmt. Die Daten in diesem Store werden mithilfe der speicherinternen Persistenz beibehalten (JavaScript-Objekt).

ContextHub.UI contexthub-ui

Verwaltet Benutzeroberflächenmodule und Benutzeroberflächenmodul-Renderer.

Funktionen (ContextHub.UI) functions-contexthub-ui

registerRenderer(moduleType, renderer, dontRender) registerrenderer-moduletype-renderer-dontrender

Registriert einen Benutzeroberflächenmodul-Renderer bei ContextHub. Nachdem der Renderer registriert wurde, kann er wie folgt verwendet werden: Benutzeroberflächenmodule erstellen. Verwenden Sie diese Funktion, wenn Sie extending ContextHub.UI.BaseModuleRenderer , um einen benutzerdefinierten Benutzeroberflächenmodul-Renderer zu erstellen.

Parameter

Beispiel

Im folgenden Beispiel wird ein Renderer als Modultyp contexthub.browserinfo registriert.

ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

ContextHub.Utils.Cookie contexthub-utils-cookie

Eine Service-Programmklasse für die Interaktion mit Cookies.

Funktionen (ContextHub.Utils.Cookie) functions-contexthub-utils-cookie

exists(key) exists-key

Ermittelt, ob ein Cookie vorhanden ist.

Parameter

Rückgabe

Wenn boolean den Wert „true“ aufweist, bedeutet das, dass das Cookie vorhanden ist.

Beispiel

if (ContextHub.Utils.Cookie.exists("name")) {
   // conditionally-executed code
}

getAllItems(filter) getallitems-filter

Gibt alle Cookies zurück, deren Schlüssel einem Filter entsprechen.

Parameter

Rückgabe

Ein Objekt von Cookies. Objekteigenschaften sind Cookie-Schlüssel und Schlüsselwerte sind Cookie-Werte.

Beispiel

ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])

getItem(key) getitem-key-1

Gibt einen Cookie-Wert zurück.

Parameter

Rückgabe

Das Cookie-Wert oder null, wenn kein Cookie für den Schlüssel gefunden wurde.

Beispiel

ContextHub.Utils.Cookie.getItem("name");

getKeys(filter) getkeys-filter

Gibt ein Array der Schlüssel der vorhandenen Cookies zurück, die mit einem Filter übereinstimmen.

Parameter

Rückgabe

Ein Array von Zeichenfolgen, wobei jede Zeichenfolge der Schlüssel eines Cookies ist, das dem Filter entspricht.

Beispiel

ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])

removeItem(key, options) removeitem-key-options-1

Entfernt ein Cookie. Um das Cookie zu entfernen, wird der Wert auf eine leere Zeichenfolge gesetzt und das Ablaufdatum wird auf den Tag vor dem aktuellen Datum gesetzt.

Parameter

Rückgabe

Diese Funktion gibt keinen Wert zurück.

Beispiel

ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);

setItem(key, value, options) setitem-key-value-options-1

Erstellt ein Cookie mit dem angegebenen Schlüssel und Wert und fügt das Cookie zum aktuellen Dokument hinzu. Optional können Sie Optionen angeben, die die Attribute des Cookies konfigurieren.

Parameter

Rückgabe

Das Cookie mit dem eingestellten Wert.

Beispiel

ContextHub.Utils.Cookie.setItem("name", "mycookie", {
    expires: 3,
    domain: 'localhost',
    path: '/some/directory',
    secure: true
});

vanish(filter, options) vanish-filter-options

Entfernt alle Cookies, die einem gegebenen Filter entsprechen. Cookies werden mithilfe der Funktion getKeys abgeglichen und mithilfe der Funktion removeItem entfernt.

Parameter

Rückgabe

Diese Funktion gibt keinen Wert zurück.

ContextHub.Utils.Eventing contexthub-utils-eventing

Ermöglicht es Ihnen, Funktionen an ContextHub-Store-Ereignisse zu binden und zu lösen. Greifen Sie auf ContextHub.Utils.Eventing -Objekte für einen Store zu, der die Eventing -Eigenschaft des Stores.

Funktionen (ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off(name, selector) off-name-selector

Löst eine Funktion von einem Ereignis.

Parameter

Rückgabe

Diese Funktion gibt keinen Wert zurück.

on(name, handler, selector, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

Bindet eine Funktion an ein Ereignis. Die Funktion wird jedes Mal aufgerufen, wenn das Ereignis eintritt. Optional kann die Funktion für Ereignisse aufgerufen werden, die in der Vergangenheit aufgetreten sind, bevor die Bindung hergestellt wurde.

Parameter

Rückgabe

Wenn das triggerForPastEvents-Argument true ist, gibt diese Funktion einen boolean-Wert zurück, der angibt, ob das Ereignis in der Vergangenheit aufgetreten ist:

Wenn triggerForPastEvents den Wert false ergibt, gibt diese Funktion keinen Wert zurück.

Beispiel

Im folgenden Beispiel wird eine Funktion an das Datenereignis des Geolocation-Stores gebunden. Die Funktion füllt ein Element auf der Seite mit dem Wert für das Datenelement „Breite“ aus dem Store.

<div class="location">
    <p>latitude: <span id="lat"></span></p>
</div>

<script>
    var geostore = ContextHub.getStore("geolocation");
    geostore.eventing.on(ContextHub.Constants.EVENT_DATA_UPDATE,getlat,"getlat");

    function getlat(){
       latitude = geostore.getItem("latitude");
       $("#lat").html(latitude);
    }
</script>

once(name, handler, selector, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

Bindet eine Funktion an ein Ereignis. Die Funktion wird nur einmal beim ersten Auftreten des Ereignisses aufgerufen. Optional kann die Funktion für das Ereignis aufgerufen werden, das in der Vergangenheit aufgetreten ist, bevor die Bindung hergestellt wurde.

Parameter

Rückgabe

Wenn das triggerForPastEvents-Argument true ist, gibt diese Funktion einen boolean-Wert zurück, der angibt, ob das Ereignis in der Vergangenheit aufgetreten ist:

Wenn triggerForPastEvents den Wert false ergibt, gibt diese Funktion keinen Wert zurück.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Eine Service-Programmklasse, mit der ein Objekt die Eigenschaften und Methoden eines anderen Objekts übernehmen kann.

Funktionen (ContextHub.Utils.inheritance) functions-contexthub-utils-inheritance

inherit(child, parent) inherit-child-parent

Bewirkt, dass ein Objekt die Eigenschaften und Methoden eines anderen Objekts übernimmt.

Parameter

ContextHub.Utils.JSON contexthub-utils-json

Stellt Funktionen zum Serialisieren von Objekten im JSON-Format und zum Deserialisieren von JSON-Strings in Objekten bereit.

Funktionen (ContextHub.Utils.JSON) functions-contexthub-utils-json

parse(data) parse-data

Analysiert einen String als JSON und konvertiert ihn in ein JavaScript-Objekt.

Parameter

Rückgabe

Ein JavaScript-Objekt

Beispiel

Der Code ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); gibt das folgende Objekt zurück:

Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(data) stringify-data

Serialisiert JavaScript-Werte und -Objekte in String-Werte des JSON-Formats.

Parameter

Rückgabe

Der serialisierte String-Wert. Wenn data ein RegExp-Wert ist, gibt diese Funktion ein leeres Objekt zurück. Wenn data eine Funktion ist, wird undefined zurückgegeben.

Beispiel

Der folgende Code gibt "{'city':'Basel','country':'Switzerland','population':'173330'}": zurück.

ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

ContextHub.Utils.JSON.tree contexthub-utils-json-tree

Diese Klasse erleichtert die Manipulation von Datenobjekten, die gespeichert oder aus ContextHub-Stores abgerufen werden.

Funktionen (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree

addAllItems() addallitems

Erstellt eine Kopie eines Datenobjekts und fügt die Datenstruktur aus einem zweiten Objekt hinzu. Die Funktion gibt die Kopie zurück und ändert keines der ursprünglichen Objekte. Wenn die Datenbäume der beiden Objekte identische Schlüssel enthalten, überschreibt der Wert des zweiten Objekts den Wert des ersten Objekts.

Parameter

Rückgabe

Ein Objekt, das die zusammengeführten Daten enthält.

cleanup() cleanup

Erstellt eine Kopie eines Objekts, sucht und entfernt Elemente in der Datenstruktur, die keine Werte, Nullwerte oder undefinierten Werte enthalten, und gibt die Kopie zurück.

Parameter

Rückgabe

Eine Kopie des Baums, der bereinigt wird.

getItem() getitem

Ruft den Wert eines Objekts für den a-Schlüssel ab.

Parameter

Rückgabe

Der Wert, der dem Schlüssel entspricht. Wenn der Schlüssel untergeordnete Schlüssel hat, gibt diese Funktion ein komplexes Objekt zurück. Wenn der Typ des Werts für den Schlüssel undefined ist, wird null zurückgegeben.

Beispiel

Betrachten Sie das folgende JavaScript-Objekt:

myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

Der folgende Beispiel-Code gibt den Wert 260 zurück.

ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

Der folgende Beispielcode ruft den Wert für einen Schlüssel mit untergeordneten Schlüsseln ab:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

Die Funktion gibt das folgende Objekt zurück:

Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys() getkeys

Ruft alle Schlüssel aus der Datenstruktur eines Objekts ab. Optional können Sie nur die Schlüssel der untergeordneten Elemente eines bestimmten Schlüssels abrufen. Sie können auch optional eine Sortierreihenfolge der abgerufenen Schlüssel angeben.

Parameter

Rückgabe

Ein Array von Schlüsseln.

Beispiel

Betrachten Sie das folgende Objekt:

myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

Das Skript ContextHub.Utils.JSON.tree.getKeys(myObject); gibt das folgende Array zurück:

["/location", "/location/city", "/location/country", "/location/latitude", "/location/longitude", "/location/weather", "/location/weather/humidity", "/location/weather/precipitation", "/location/weather/temperature", "/location/weather/wind"]

removeItem() removeitem

Erstellt eine Kopie eines bestimmten Objekts, entfernt den angegebenen Zweig aus der Datenstruktur und gibt die geänderte Kopie zurück.

Parameter

Rückgabe

Eine Kopie des ursprünglichen Datenobjekts mit entferntem Schlüssel.

Beispiel

Betrachten Sie das folgende Objekt:

myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

Das folgende Beispielskript entfernt den Zweig /one/two/three/four aus der Datenstruktur:

myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

Die Funktion gibt das folgende Objekt zurück:

myObject {
  one: {
    foo: "bar"
  }
}

sanitizeKey(key) sanitizekey-key

Bereinigt Stringwerte, um sie als Schlüssel nutzbar zu machen. Um eine Zeichenfolge zu bereinigen, führt diese Funktion die folgenden Aktionen aus:

Verwenden Sie das resultierende Array, um einen verwendbaren Schlüssel zu erstellen. Parameter

Rückgabe

Ein Array von string-Werten, wobei jeder String der Teil des key ist, der durch Schrägstriche abgegrenzt wurde. stellt den bereinigten Schlüssel dar. Wenn das bereinigte Array eine Länge von hat, gibt diese Funktion nullnull zurück.

Beispiel

Der folgende Code bereinigt einen String zum Erstellen des Arrays ["this", "is", "a", "path"] und generiert dann den Schlüssel "/this/is/a/path" aus dem Array:

var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(tree, key, value) setitem-tree-key-value

Fügt dem Datenbaum einer Kopie eines Objekts ein Schlüssel/Wert-Paar hinzu. Weitere Informationen zu Datenbäumen finden Sie unter Persistenz.

Parameter

Rückgabe

Eine Kopie des tree-Objekts, das das value/key-Paar enthält.

Beispiel

Betrachten Sie den folgenden JavaScript-Code:

var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

var myKey = "/user/location/details";

var myValue = {
      population: 173330,
      elevation: 260
     };

myObject = ContextHub.Utils.JSON.tree.setItem(myObject, myKey, myValue);

Das myObject -Objekt hat den folgenden Wert:

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

Ermöglicht es Ihnen, Store-Kandidaten zu registrieren und registrierte Store-Kandidaten zu erhalten.

Funktionen (ContextHub.Utils.storeCandidates) functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Gibt die Store-Typen zurück, die als Store-Kandidaten registriert sind. Rufen Sie entweder die registrierten Candicates eines bestimmten Storetyps oder aller Storetypen ab.

Parameter

Rückgabe

Ein Objekt von Storetypen. Die Objekteigenschaften sind die Namen des Store-Typs und die Eigenschaftswerte sind ein Array registrierter Store-Kandidaten.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Gibt einen Store-Typ aus den registrierten Kandidaten zurück. Wenn mehr als ein Storetyp mit demselben Namen gespeichert wird, gibt die Funktion den Storetyp mit der höchsten Priorität zurück.

Parameter

Rückgabe

Ein Objekt, das den registrierten Store-Kandidaten darstellt. Wenn der angeforderte Store-Typ nicht registriert ist, wird ein Fehler ausgegeben.

getSupportedStoreTypes() getsupportedstoretypes

Gibt die Namen der Storetypen zurück, die als Storekandidaten registriert sind. Für diese Funktion sind keine Parameter erforderlich.

Rückgabe

Ein Array von String-Werten, wobei jeder String der Store-Typ ist, mit dem ein Store-Kandidat registriert wurde. Siehe den storeType-Parameter der Funktion .ContextHub.Utils.storeCandidates.registerStoreCandidate

registerStoreCandidate(store, storeType, priority, applies) registerstorecandidate-store-storetype-priority-applies

Registriert ein Store-Objekt mit einem Namen und einer Priorität als Store-Kandidaten.

Die Priorität ist eine Zahl, die die Bedeutung der gleichnamigen Store angibt. Wenn ein Storekandidat unter Verwendung des gleichen Namens wie ein bereits registrierter Storekandidat registriert wird, wird der Kandidat mit der höheren Priorität verwendet. Beim Registrieren eines Store-Kandidaten wird der Store nur registriert, wenn die Priorität höher ist als die gleichen registrierten Store-Kandidaten.

Parameter

Beispiel

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);