Verweis auf die 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.

Verweis auf die 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 returns-

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

Beispiel example-

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 parameters-

Rückgabe returns-getstore-name

Ein Objekt, das den Store darstellt.

Beispiel example-getstore-name

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 zu erhalten.

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

getName() getname

Gibt den Namen des Segments als Zeichenfolgenwert zurück.

getPath() getpath

Gibt den Repository-Pfad der Segmentdefinition als Zeichenfolgenwert 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 returns-getresolvedsegments

Ein Array mit 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):

Werte können Objekte sein.

Parameter parameters-addallitems

Rückgabe returns-addallitems

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 parameters-addreference

Rückgabe returns-addreference

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 parameters-getitem

Rückgabe returns-getitem

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 parameters-getkeys

Rückgabe returns-getkeys

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

getReferences() getreferences

Ruft die Referenzen aus dem Store ab.

Rückgabe returns-getreferences

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 parameters-gettree

Rückgabe returns-gettree

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

init(name, config) init-name-config

Initialisiert den Store.

Parameter parameters-init

isEventingPaused() iseventingpaused

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

Rückgabe returns-iseventingpaused

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 parameters-removeitem

Rückgabe returns-removeitem

Ein boolean-Wert:

removeReference(key) removereference-key

Entfernt eine Referenz aus dem Store.

Parameter parameters-removereference

Rückgabe returns-removereference

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. Das 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 parameters-reset

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 parameters-resolvereference

Rückgabe returns-resolvereference

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

Nimmt das Eventing für diesen Store wieder auf, 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 dem Store ein Schlüssel-Wert-Paar 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 parameters-setitem

Rückgabe returns-setitem

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 init-Funktion an, wenn Sie eine Instanz dieser Klasse erstellen.

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. Diese Funktion gibt keinen Wert zurück.

Parameter parameters-configureservice

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 returns-getrawresponse

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 die Informationen, die zum Erstellen der Service-URL erforderlich sind.

Rückgabe returns-getservicedetails

Ein Objekt mit den folgenden Eigenschaften:

getServiceURL(resolve) getserviceurl-resolve

Ruft die URL des JSONP-Service ab.

Parameter parameters-getserviceurl

Rückgabe returns-getserviceurl

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

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

initialisiert das ContextHub.Store.JSONPStore-Objekt.

Parameter parameters-init-1

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, bewirkt die Funktion nichts.

Parameter parameters-queryservice

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 Eigenschaft „initialValues“ des Konfigurationsobjekts bereitgestellt, das zum Instanziieren des Store-Objekts verwendet wird.

Parameter parameters-reset-1

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 und übernimmt dadurch alle Funktionen dieser Klasse. 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 und übernimmt dadurch alle Funktionen dieser Klasse. 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 UI-Modul-Renderer bei ContextHub. Nachdem der Renderer registriert wurde, kann er verwendet werden, um UI-Module zu erstellen. Verwenden Sie diese Funktion, wenn Sie erweiternContextHub.UI.BaseModuleRenderer, um einen benutzerdefinierten Benutzeroberflächenmodul-Renderer zu erstellen.

Parameter parameters-registerrenderer

Beispiel example-registerrenderer

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 parameters-exists

Rückgabe returns-exists

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

Beispiel example-exists

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 parameters-getallitems

Rückgabe returns-getallitems

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

Beispiel example-getallitems

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

getItem(key) getitem-key-1

Gibt einen Cookie-Wert zurück.

Parameter parameters-getitem-1

Rückgabe returns-getitem-1

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

Beispiel example-getitem-1

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 parameters-getkeys-1

Rückgabe returns-getkeys-1

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

Beispiel example-getkeys-1

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 parameters-removeitem-1

Rückgabe returns-removeitem-1

Diese Funktion gibt keinen Wert zurück.

Beispiel example-removeitem-1

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 parameters-setitem-1

Rückgabe returns-setitem-1

Das Cookie mit dem eingestellten Wert.

Beispiel example-setitem-1

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 getKeys-Funktion abgeglichen und mithilfe der removeItem-Funktion entfernt.

Parameter parameters-vanish

Rückgabe returns-vanish

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 verwendet.

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

off(name, selector) off-name-selector

Löst eine Funktion von einem Ereignis.

Parameter parameters-off

Rückgabe returns-off

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 parameters-on

Rückgabe returns-on

Wenn das Argument triggerForPastEvents 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 example-on

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 parameters-once

Rückgabe returns-once

Wenn das Argument triggerForPastEvents 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 parameters-inherit

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 parameters-parse

Rückgabe returns-parse

Ein JavaScript-Objekt

Beispiel example-parse

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 Zeichenfolgenwerte des JSON-Formats.

Parameter parameters-stringify

Rückgabe returns-stringify

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 example-stringify

Der folgende Code:

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

Rückgabe:

"{'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 parameters-addallitems-1

Rückgabe returns-addallitems-1

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 parameters-cleanup

Rückgabe returns-cleanup

Eine Kopie des Baums, der bereinigt wird.

getItem() getitem

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

Parameter parameters-getitem-2

Rückgabe returns-getitem-2

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 example-getitem-2

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 Beispiel-Code 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 parameters-getkeys-2

Rückgabe returns-getkeys-2

Ein Array von Schlüsseln.

Beispiel example-getkeys-2

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 parameters-removeitem-2

Rückgabe returns-removeitem-2

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

Beispiel example-removeitem-2

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 parameters-sanitizekey

Rückgabe returns-sanitizekey

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 example-sanitizekey

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 parameters-setitem-2

Rückgabe returns-setitem-2

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

Beispiel example-setitem-2

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

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. Sie können entweder die registrierten Kandidaten eines bestimmten Store-Typs oder aller Store-Typen abrufen.

Parameter parameters-getregisteredcandidates

Rückgabe returns-getregisteredcandidates

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 Store-Typ mit demselben Namen erneut registriert wird, gibt die Funktion den Store-Typ mit der höchsten Priorität zurück.

Parameter parameters-getstorefromcandidates

Rückgabe returns-getstorefromcandidates

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. Diese Funktion benötigt keine Parameter.

Rückgabe returns-getsupportedstoretypes

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 als Store-Kandidaten mit einem Namen und einer Priorität.

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 von registrierten Store-Kandidaten mit dem gleichen Namen.

Parameter parameters-registerstorecandidate

Beispiel example-registerstorecandidate

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