ContextHub JavaScript API-naslaggids contexthub-javascript-api-reference

De JavaScript API van ContextHub is beschikbaar aan uw manuscripten wanneer de component ContextHub aan de paginais toegevoegd.

ContextHub-constanten contexthub-constants

Constante waarden die door de ContextHub JavaScript API worden gedefinieerd.

Gebeurtenisconstanten event-constants

De volgende lijst maakt een lijst van de namengebeurtenissen die voor Winkels ContextHub voorkomen. Zie ook ContextHub.Utils.Event.

UI-gebeurtenisconstanten ui-event-constants

De volgende lijst maakt een lijst van de namen van gebeurtenissen die voor ContextHub UI voorkomen.

ContextHub JavaScript API-naslaggids contexthub-javascript-api-reference-2

Het voorwerp ContextHub verleent toegang tot alle opslag.

Functies (ContextHub) functions-contexthub

getAllStores() getallstores

Retourneert alle geregistreerde ContextHub-winkels.

Deze functie heeft geen parameters.

Retourneert returns-

Een voorwerp dat alle opslag ContextHub bevat. Elke winkel is een object met dezelfde naam als de winkel.

Voorbeeld example-

In het volgende voorbeeld worden alle opslagruimten opgehaald en wordt vervolgens de geolocatieopslag opgehaald:

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

getStore(name) getstore-name

Hiermee wordt een winkel opgehaald als een JavaScript-object.

Parameters parameters-

Retourneert returns-getstore-name

Een object dat de winkel vertegenwoordigt.

Voorbeeld example-getstore-name

In het volgende voorbeeld wordt de opslag van de geolocatie opgehaald:

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

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Vertegenwoordigt een segment ContextHub. Gebruik ContextHub.SegmentEngine.SegmentManager om segmenten op te halen.

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

getName() getname

Retourneert de naam van het segment als een tekenreekswaarde.

getPath() getpath

Retourneert het repository pad van de segmentdefinitie als een String-waarde.

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Verleent toegang tot segmenten ContextHub.

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

getResolvedSegments() getresolvedsegments

Retourneert de segmenten die zijn omgezet in de huidige context. Deze functie heeft geen parameters.

Retourneert returns-getresolvedsegments

Een array van ContextHub.SegmentEngine.Segment -objecten.

ContextHub.Store.Core contexthub-store-core

De basisklasse voor opslag ContextHub.

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

voorkomen eventing

Een ContextHub.Utils.Eventing -object. Gebruik dit object voor het binden van functies om gebeurtenissen op te slaan. Zie init(name,config) voor meer informatie over de standaardwaarde en initialisatie.

name name

De naam van de winkel.

volharding persistence

Een ContextHub.Utils.Persistence -object. Zie init(name,config) voor meer informatie over de standaardwaarde en initialisatie.

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

addAllItems(tree, options) addallitems-tree-options

Voegt een gegevensobject of een array samen met de opslaggegevens. Elk sleutelwaardepaar in het object of de array wordt toegevoegd aan de store (via de functie setItem ):

Waarden kunnen objecten zijn.

Parameters parameters-addallitems

Retourneert returns-addallitems

Een boolean -waarde:

addReference(key, anotherKey) addreference-key-anotherkey

Maakt een verwijzing van de ene toets naar de andere. Een sleutel kan niet naar zichzelf verwijzen.

Parameters parameters-addreference

Retourneert returns-addreference

Een boolean -waarde:

noticeReadiness() announcereadiness

De gebeurtenis ready voor deze winkel wordt geactiveerd. Deze functie heeft geen parameters en retourneert geen waarde.

clean() clean

Hiermee verwijdert u alle gegevens uit de winkel. De functie heeft geen parameters en geen geretourneerde waarde.

getItem(key) getitem-key

Retourneert de waarde die aan een toets is gekoppeld.

Parameters parameters-getitem

Retourneert returns-getitem

Een object dat de waarde voor de toets vertegenwoordigt.

getKeys(includeInternal) getkeys-includeinternals

Haalt de sleutels uit de opslag op. Naar keuze kunt u de sleutels terugwinnen die intern door het kader ContextHub worden gebruikt.

Parameters parameters-getkeys

Retourneert returns-getkeys

Een array met sleutelnamen ( string waarden).

getReferences() getreferences

Haalt de verwijzingen uit de opslag op.

Retourneert returns-getreferences

Een array die naar toetsen verwijst als indexen voor de toetsen waarnaar wordt verwezen:

getTree(includeInternal) gettree-includeinternals

Hiermee wordt de gegevensstructuur uit de opslagruimte opgehaald. Naar keuze kunt u de sleutel/waardeparen omvatten die intern door het kader ContextHub worden gebruikt.

Parameters parameters-gettree

Retourneert returns-gettree

Een object dat de gegevensstructuur vertegenwoordigt. De sleutels zijn de bezitsnamen van het voorwerp.

init(name, config) init-name-config

Initialiseert de winkel.

Parameters parameters-init

isEventPaused() iseventingpaused

Bepaalt of de gebeurtenis voor deze opslag wordt gepauzeerd.

Retourneert returns-iseventingpaused

Een Booleaanse waarde:

pauseEvent() pauseeventing

Pauzeert het voorkomen voor de opslag zodat geen gebeurtenissen worden teweeggebracht. Deze functie vereist geen parameters en retourneert geen waarde.

removeItem(sleutel, opties) removeitem-key-options

Hiermee verwijdert u een sleutel-/waardepaar uit de winkel.

Wanneer een toets wordt verwijderd, activeert de functie de gebeurtenis data . De gebeurtenisgegevens omvatten de opslagnaam, de naam van de sleutel die is verwijderd, de waarde die is verwijderd, de nieuwe waarde voor de sleutel (null) en het actietype "remove".

U kunt desgewenst het activeren van de gebeurtenis data voorkomen.

Parameters parameters-removeitem

Retourneert returns-removeitem

Een boolean -waarde:

removeReference(key) removereference-key

Hiermee verwijdert u een verwijzing uit de winkel.

Parameters parameters-removereference

Retourneert returns-removereference

Een boolean -waarde:

reset(keepRestatingData) reset-keepremainingdata

Herstelt de aanvankelijke waarden van de blijvende gegevens van de opslag. U kunt desgewenst alle andere gegevens uit de winkel verwijderen. De gebeurtenis wordt gepauzeerd voor deze opslag terwijl de opslag wordt teruggesteld. Deze functie retourneert geen waarde.

De aanvankelijke waarden worden verstrekt in het initialValues bezit van het config voorwerp dat wordt gebruikt om het archiefvoorwerp te concretiseren.

Parameters parameters-reset

resolveReference(key, retry) resolvereference-key-retry

Hiermee wordt een toets waarnaar wordt verwezen, opgehaald. U kunt desgewenst het aantal herhalingen opgeven dat moet worden gebruikt om de beste overeenkomst op te lossen.

Parameters parameters-resolvereference

Retourneert returns-resolvereference

Een string -waarde die de toets waarnaar wordt verwezen vertegenwoordigt. Wanneer geen verwijzing wordt opgelost, wordt de waarde van de parameter key geretourneerd.

resumeEvent() resumeeventing

Hervat de gebeurtenis voor deze opslag zodat de gebeurtenissen worden teweeggebracht. Deze functie definieert geen parameters en retourneert geen waarde.

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

Voegt een sleutel/waardepaar aan de opslag toe.

De gebeurtenis data wordt alleen geactiveerd als de waarde voor de toets afwijkt van de waarde die momenteel voor de toets is opgeslagen. U kunt desgewenst voorkomen dat de gebeurtenis data wordt geactiveerd.

Tot de gebeurtenisgegevens behoren de opslagnaam, de sleutel, de vorige waarde, de nieuwe waarde en het actietype set .

Parameters parameters-setitem

Retourneert returns-setitem

Een boolean -waarde:

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Een opslag die JSON-gegevens bevat. De gegevens worden teruggewonnen van de externe dienst JSONP, of naar keuze van de dienst die JSON- gegevens terugkeert. Geef de servicedetails op met de functie init wanneer u een instantie van deze klasse maakt.

De opslag gebruikt in-geheugenpersistentie (variabele JavaScript). De gegevens van de opslag zijn beschikbaar slechts tijdens het leven van de pagina.

ContextHub.Store.JSONPStore breidt ContextHub.Store.Coreuit en erft de functies van die klasse.

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

configureService(serviceConfig, override) configureservice-serviceconfig-override

Vormt de details voor het verbinden met de dienst JSONP die dit voorwerp gebruikt. U kunt de bestaande configuratie bijwerken of vervangen. De functie retourneert geen waarde.

Parameters parameters-configureservice

getRawResponse() getrawresponse

Keert de ruwe reactie terug die sinds de laatste vraag aan de dienst JSONP in het voorgeheugen ondergebracht is. De functie vereist geen parameters.

Retourneert returns-getrawresponse

Een object dat de onbewerkte reactie vertegenwoordigt.

getServiceDetails() getservicedetails

Hiermee wordt het serviceobject voor dit ContextHub.Store.JSONPStore-object opgehaald. Het serviceobject bevat de informatie die nodig is om de service-URL te maken.

Retourneert returns-getservicedetails

Een object met de volgende eigenschappen:

getServiceURL(resolve) getserviceurl-resolve

Haalt URL van de dienst JSONP op.

Parameters parameters-getserviceurl

Retourneert returns-getserviceurl

Een string -waarde die de service-URL vertegenwoordigt.

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

initialiseert het ContextHub.Store.JSONPStore -object.

Parameters parameters-init-1

queryService(reload) queryservice-reload

Zoekt de verre dienst JSONP en caches de reactie. Als de tijd sinds de vorige aanroep van deze functie kleiner is dan de waarde van config.service.ttl , wordt de service niet aangeroepen en wordt de reactie in de cache niet gewijzigd. Naar keuze, kunt u de dienst dwingen om worden geroepen. Het config.service.ttl bezit wordt geplaatst wanneer het roepen van de initfunctie om de opslag te initialiseren.

De gebeurtenis ready wordt geactiveerd wanneer de query is voltooid. Wanneer de URL van de JSONP-service niet is ingesteld, doet de functie niets.

Parameters parameters-queryservice

reset reset

Herstelt de aanvankelijke waarden van de opslag persisted gegevens en roept dan de dienst JSONP. U kunt desgewenst alle andere gegevens uit de winkel verwijderen. De gebeurtenis wordt gepauzeerd voor deze opslag terwijl de aanvankelijke waarden worden teruggesteld. Deze functie retourneert geen waarde.

De aanvankelijke waarden worden verstrekt in het initialValues bezit van het config voorwerp dat wordt gebruikt om het archiefvoorwerp te concretiseren.

Parameters parameters-reset-1

resolveParameter(f) resolveparameter-f

Hiermee wordt de opgegeven parameter omgezet.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore breidt ContextHub.Store.JSONPStoreuit zodat erft het alle functies van die klasse. Nochtans, worden de gegevens die van de dienst JSONP worden teruggewonnen voortgeduurd volgens de configuratie van persistentie ContextHub. (Zie Persistentie wijzen:)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore breidt ContextHub.Store.Coreuit zodat erft het alle functies van die klasse. De gegevens in deze opslag worden voortgeduurd volgens de configuratie van persistentie ContextHub.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore breidt ContextHub.Store.Coreuit zodat erft het alle functies van die klasse. De gegevens in deze opslag blijven behouden met in-memory persistance (JavaScript-object).

ContextHub.UI contexthub-ui

Beheert UI-modules en UI-moduleurs.

Functies (ContextHub.UI) functions-contexthub-ui

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

Registreert een UI modulerenderer met ContextHub. Nadat renderer wordt geregistreerd, kan het worden gebruikt om modules tot stand te brengen UI. Gebruik deze functie wanneer u uitbreidt ContextHub.UI.BaseModuleRenderer om een renderer van de Module van de douaneUI tot stand te brengen.

Parameters parameters-registerrenderer

Voorbeeld example-registerrenderer

In het volgende voorbeeld wordt een renderer geregistreerd als het moduletype contexthub.browserinfo .

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

ContextHub.Utils.Cookie contexthub-utils-cookie

Een hulpprogrammaklasse voor interactie met cookies.

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

exists(key) exists-key

Hiermee wordt bepaald of een cookie bestaat.

Parameters parameters-exists

Retourneert returns-exists

De boolean -waarde true geeft aan dat het cookie bestaat.

Voorbeeld example-exists

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

getAllItems(filter) getallitems-filter

Retourneert alle cookies met sleutels die overeenkomen met een filter.

Parameters parameters-getallitems

Retourneert returns-getallitems

Een object van cookies. Objecteigenschappen zijn cookie sleutels en sleutelwaarden zijn cookie waarden.

Voorbeeld example-getallitems

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

getItem(key) getitem-key-1

Retourneert een cookiewaarde.

Parameters parameters-getitem-1

Retourneert returns-getitem-1

De waarde van het cookie of null als er geen cookie is gevonden voor de toets.

Voorbeeld example-getitem-1

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

getKeys (filter) getkeys-filter

Retourneert een array met de sleutels van bestaande cookies die overeenkomen met een filter.

Parameters parameters-getkeys-1

Retourneert returns-getkeys-1

Een array van tekenreeksen waarbij elke tekenreeks de sleutel is van een cookie die overeenkomt met het filter.

Voorbeeld example-getkeys-1

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

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

Hiermee verwijdert u een cookie. Als u het cookie wilt verwijderen, wordt de waarde ingesteld op een lege tekenreeks en wordt de vervaldatum ingesteld op de dag vóór de huidige datum.

Parameters parameters-removeitem-1

Retourneert returns-removeitem-1

Deze functie retourneert geen waarde.

Voorbeeld example-removeitem-1

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

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

Hiermee maakt u een cookie van de opgegeven sleutel en waarde en voegt u het cookie toe aan het huidige document. U kunt desgewenst opties opgeven waarmee de kenmerken van het cookie worden geconfigureerd.

Parameters parameters-setitem-1

Retourneert returns-setitem-1

Het cookie met de ingestelde waarde.

Voorbeeld example-setitem-1

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

verdwijnt(filter, opties) vanish-filter-options

Hiermee verwijdert u alle cookies die overeenkomen met een opgegeven filter. Cookies worden met behulp van de functie getKeys overeenkomend en met behulp van de functie removeItem verwijderd.

Parameters parameters-vanish

Retourneert returns-vanish

Deze functie retourneert geen waarde.

ContextHub.Utils.Eventing contexthub-utils-eventing

Laat u toe om functies aan ContextHub archiefgebeurtenissen te binden en los te maken. De voorwerpen van de toegang ContextHub.Utils.Eventing voor een opslag die het gebeurtenisbezit van de opslag gebruiken.

Functies (ContextHub.Utils.Event) functions-contexthub-utils-eventing

off (naam, kiezer) off-name-selector

Hiermee wordt de binding van een functie met een gebeurtenis opgeheven.

Parameters parameters-off

Retourneert returns-off

Deze functie retourneert geen waarde.

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

Bindt een functie aan een gebeurtenis. De functie wordt aangeroepen telkens wanneer de gebeurtenis plaatsvindt. De functie kan optioneel worden aangeroepen voor gebeurtenissen die zich in het verleden hebben voorgedaan, voordat de binding wordt ingesteld.

Parameters parameters-on

Retourneert returns-on

Wanneer het argument triggerForPastEvents true is, retourneert deze functie een boolean -waarde die aangeeft of de gebeurtenis in het verleden heeft plaatsgevonden:

Als triggerForPastEvents false is, retourneert deze functie geen waarde.

Voorbeeld example-on

In het volgende voorbeeld wordt een functie gebonden aan de gebeurtenis data van de geolocation store. De functie vult een element op de pagina met de waarde voor het latitude-gegevensitem uit de winkel.

<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(naam, handler, kiezer, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

Bindt een functie aan een gebeurtenis. De functie wordt slechts eenmaal aangeroepen voor het eerste exemplaar van de gebeurtenis. De functie kan optioneel worden aangeroepen voor de gebeurtenis die in het verleden heeft plaatsgevonden, voordat de binding wordt ingesteld.

Parameters parameters-once

Retourneert returns-once

Wanneer het argument triggerForPastEvents true is, retourneert deze functie een boolean -waarde die aangeeft of de gebeurtenis in het verleden heeft plaatsgevonden:

Als triggerForPastEvents false is, retourneert deze functie geen waarde.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Een hulpprogrammaklasse waarmee een object de eigenschappen en methoden van een ander object kan overnemen.

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

inherit (child, parent) inherit-child-parent

Causes an object to inherit the properties and methods of another object.

Parameters parameters-inherit

ContextHub.Utils.JSON contexthub-utils-json

Biedt functies voor het serialiseren van objecten in JSON-indeling en het deserialiseren van JSON-tekenreeksen in objecten.

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

parse(data) parse-data

Parseert een tekenreekswaarde als JSON en zet deze om in een javascript-object.

Parameters parameters-parse

Retourneert returns-parse

Een JavaScript-object.

Voorbeeld example-parse

De code:

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

Retourneert het volgende object:

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

stringify(data) stringify-data

Hiermee serialiseert u JavaScript-waarden en -objecten in tekenreekswaarden in JSON-indeling.

Parameters parameters-stringify

Retourneert returns-stringify

De geserialiseerde tekenreekswaarde Wanneer data een R egExp -waarde is, retourneert deze functie een leeg object. Wanneer data een functie is, wordt undefined geretourneerd.

Voorbeeld example-stringify

De volgende code:

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

Retourneert:

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

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

Deze klasse vergemakkelijkt de manipulatie van gegevensvoorwerpen die moeten worden opgeslagen of van opslag ContextHub worden teruggewonnen.

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

addAllItems() addallitems

Maakt een kopie van een gegevensobject en voegt er vanuit een tweede object de gegevensstructuur aan toe. De functie retourneert de kopie en wijzigt geen van de oorspronkelijke objecten. Wanneer de gegevensstructuren van de twee objecten identieke sleutels bevatten, overschrijft de waarde van het tweede object de waarde van het eerste object.

Parameters parameters-addallitems-1

Retourneert returns-addallitems-1

Een object dat de samengevoegde gegevens bevat.

Cleup() cleanup

Maakt een kopie van een object, zoekt en verwijdert items in de gegevensstructuur die geen waarden, null-waarden of ongedefinieerde waarden bevatten en retourneert de kopie.

Parameters parameters-cleanup

Retourneert returns-cleanup

Een kopie van de boom die is schoongemaakt.

getItem() getitem

Hiermee wordt de waarde opgehaald van een object voor de toets.

Parameters parameters-getitem-2

Retourneert returns-getitem-2

De waarde die overeenkomt met de toets. Wanneer de toets onderliggende toetsen heeft, retourneert deze functie een complex object. Wanneer het type van de waarde voor de toets undefined is, wordt null geretourneerd.

Voorbeeld example-getitem-2

Bekijk het volgende JavaScript-object:

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

De volgende voorbeeldcode retourneert de waarde 260 :

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

De volgende voorbeeldcode wint de waarde voor een sleutel terug die kindsleutels heeft:

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

De functie retourneert het volgende object:

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

getKeys() getkeys

Hiermee worden alle sleutels opgehaald uit de gegevensstructuur van een object. U kunt desgewenst alleen de toetsen van de onderliggende toetsen van een specifieke toets ophalen. U kunt desgewenst ook een sorteervolgorde van de opgehaalde toetsen opgeven.

Parameters parameters-getkeys-2

Retourneert returns-getkeys-2

Een array met sleutels.

Voorbeeld example-getkeys-2

Bekijk het volgende object:

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

Het ContextHub.Utils.JSON.tree.getKeys(myObject); -script retourneert de volgende array:

["/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

Maakt een kopie van een bepaald object, verwijdert de opgegeven vertakking uit de gegevensstructuur en retourneert de gewijzigde kopie.

Parameters parameters-removeitem-2

Retourneert returns-removeitem-2

Een kopie van het oorspronkelijke gegevensobject waarbij de toets is verwijderd.

Voorbeeld example-removeitem-2

Bekijk het volgende object:

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

Het volgende voorbeeldmanuscript verwijdert /one/two/three/four tak uit de gegevensboom:

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

De functie retourneert het volgende object:

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

sanitizeKey(key) sanitizekey-key

Hiermee worden tekenreekswaarden gesimuleerd zodat deze als toetsen kunnen worden gebruikt. Om een tekenreeks te ontsmetten, voert deze functie de volgende handelingen uit:

Gebruik de resulterende array om een bruikbare sleutel te maken.

Parameters parameters-sanitizekey

Retourneert returns-sanitizekey

Een array van string waarden waarbij elke tekenreeks het deel is van de key die door slashes is afgebakend. vertegenwoordigt de geanimeerde sleutel. Wanneer de geanimeerde array een lengte van nul heeft, retourneert deze functie null .

Voorbeeld example-sanitizekey

Met de volgende code wordt een tekenreeks geanimeerd om de array ["this", "is", "a", "path"] te maken en wordt vervolgens de sleutel "/this/is/a/path" uit de array gegenereerd:

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

Voegt een sleutel/waardepaar aan de gegevensboom van een exemplaar van een voorwerp toe. Voor informatie over gegevensbomen, zie Persistence.

Parameters parameters-setitem-2

Retourneert returns-setitem-2

Een kopie van het object tree dat het paar key/ value bevat.

Voorbeeld example-setitem-2

Bekijk de volgende 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

Hiermee kunt u winkelkandidaten registreren en geregistreerde winkelkandidaten aanvragen.

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

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Retourneert de winkeltypen die zijn geregistreerd als opslagkandidaten. Of wint de geregistreerde kandidaten van een specifiek archieftype of van alle archieftypes terug.

Parameters parameters-getregisteredcandidates

Retourneert returns-getregisteredcandidates

Een object van winkeltypen. De objecteigenschappen zijn de namen van opslagtypen en de eigenschapswaarden zijn een array van geregistreerde opslagkandidaten.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Retourneert een winkeltype van de geregistreerde kandidaten. Als meer dan één opslagtype van de zelfde naam wordt geregistreerd, keert de functie het archieftype met de hoogste prioriteit terug.

Parameters parameters-getstorefromcandidates

Retourneert returns-getstorefromcandidates

Een object dat de geregistreerde opslagkandidaat vertegenwoordigt. Als het gewenste opslagtype niet is geregistreerd, wordt een fout gegenereerd.

getSupportedStoreTypes() getsupportedstoretypes

Retourneert de namen van de winkeltypen die als opslagkandidaten zijn geregistreerd. Deze functie vereist geen parameters.

Retourneert returns-getsupportedstoretypes

Een array van tekenreekswaarden, waarbij elke tekenreeks het opslagtype is waarmee een opslagkandidaat is geregistreerd. Zie de parameter storeType van de functie ContextHub.Utils.storeCandidates.registerStoreCandidate .

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

Registreert een opslagvoorwerp als opslagkandidaat gebruikend een naam en een prioriteit.

De prioriteit is een aantal dat op het belang van de zelfde-genoemde opslag wijst. Wanneer een opslagkandidaat met dezelfde naam als een reeds geregistreerde opslagkandidaat wordt geregistreerd, wordt de kandidaat met de hogere prioriteit gebruikt. Wanneer het registreren van een opslagkandidaat, wordt de opslag geregistreerd slechts als de prioriteit hoger is dan de zelfde-genoemde geregistreerde opslagkandidaten.

Parameters parameters-registerstorecandidate

Voorbeeld example-registerstorecandidate

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