ContextHub JavaScript API-naslaggids contexthub-javascript-api-reference
De JavaScript-API van ContextHub is beschikbaar voor uw scripts wanneer de De component ContextHub is toegevoegd aan de pagina.
ContextHub-constanten contexthub-constants
Constante waarden die door de JavaScript-API van ContextHub 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
Een voorwerp dat alle opslag ContextHub bevat. Elke opslag is een voorwerp dat de zelfde naam zoals de opslag gebruikt.
Voorbeeld
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
- naam: De naam waarmee de winkel is geregistreerd.
Retourneert
Een object dat de winkel vertegenwoordigt.
Voorbeeld
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 te verkrijgen.
Functies (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment
getName() getname
Retourneert de naam van het segment als een tekenreekswaarde.
getPath() getpath
Retourneert het pad van de opslagplaats van de segmentdefinitie als een tekenreekswaarde.
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
Een array van objecten ContextHub.SegmentEngine.Segment.
ContextHub.Store.Core contexthub-store-core
De basisklasse voor opslag ContextHub.
Eigenschappen (ContextHub.Store.Core) properties-contexthub-store-core
voorkomen eventing
A ContextHub.Utils.Event object. Gebruik dit object voor het binden van functies om gebeurtenissen op te slaan. Voor informatie over de standaardwaarde en initialisatie raadpleegt u init(name,config).
name name
De naam van de winkel.
volharding persistence
Een ContextHub.Utils.Persistence-object. Voor informatie over de standaardwaarde en initialisatie raadpleegt u init(name,config)
.
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 aan de winkel toegevoegd (via de setItem
functie):
- Object: Toetsen zijn de eigenschapnamen.
- Array: Toetsen zijn de arrayindexen.
Waarden kunnen objecten zijn.
Parameters
- boom: (Object of array) De gegevens die aan de winkel moeten worden toegevoegd.
- opties: (Object) Een optioneel object met opties dat wordt doorgegeven aan de functie setItem. Zie voor meer informatie de
options
parameter van setItem(key,value,options).
Retourneert
A boolean
waarde:
- Een waarde van
true
Hiermee wordt aangegeven dat het gegevensobject is opgeslagen. - Een waarde van
false
Hiermee wordt aangegeven dat de gegevensopslag ongewijzigd blijft.
addReference(key, anotherKey) addreference-key-anotherkey
Maakt een verwijzing van de ene toets naar de andere. Een sleutel kan niet naar zichzelf verwijzen.
Parameters
-
toets: De sleutel waarnaar wordt verwezen
anotherKey
. -
andere sleutel: De sleutel waarnaar wordt verwezen door
key
.
Retourneert
A boolean
waarde:
- Een waarde van
true
geeft aan dat de verwijzing is toegevoegd. - Een waarde van
false
geeft aan dat er geen verwijzing is toegevoegd.
noticeReadiness() announcereadiness
Hiermee wordt het dialoogvenster ready
voor deze winkel. 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
- toets: (String) De sleutel waarvoor de waarde moet worden geretourneerd.
Retourneert
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
- includeInternal: Een waarde van
true
neemt intern gebruikte sleutels in de resultaten op. Deze toetsen beginnen met het onderstrepingsteken ("_"). De standaardwaarde isfalse
.
Retourneert
Een array met sleutelnamen ( string
waarden).
getReferences() getreferences
Haalt de verwijzingen uit de opslag op.
Retourneert
Een array die naar toetsen verwijst als indexen voor de toetsen waarnaar wordt verwezen:
-
Verwijzen naar sleutels komt overeen met de
key
parameter van deaddReference
functie. -
Sleutels waarnaar wordt verwezen, komen overeen met de
anotherKey
parameter van deaddReference
functie.
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
includeInternals:
Een waarde vantrue
neemt intern-gebruikte sleutel/waardeparen in de resultaten op. De sleutels van deze gegevens beginnen met het onderstrepingsteken ("_") karakter. De standaardwaarde isfalse
.
Retourneert
Een object dat de gegevensstructuur vertegenwoordigt. De sleutels zijn de bezitsnamen van het voorwerp.
init(name, config) init-name-config
Initialiseert de winkel.
-
Stelt de opslaggegevens in op een leeg object.
-
Hiermee stelt u de opslagverwijzingen in naar een leeg object.
-
Het gebeurteniskanaal is gegevens:name, waarbij name is de naam van de winkel.
-
De storeDataKey is /store/name, waarbij name is de naam van de winkel.
Parameters
-
naam: De naam van de winkel.
-
config: Een object dat configuratie-eigenschappen bevat:
- eventDeferring: De standaardwaarde is 32.
- gebeurtenis: De ContextHub.Utils.Event object voor deze winkel. De standaardwaarde is het voorwerp ContextHub.eventing gebruikt.
- persistentie: Het object ContextHub.Utils.Persistence voor deze winkel. De standaardwaarde is het voorwerp ContextHub.persistence.
isEventPaused() iseventingpaused
Bepaalt of de gebeurtenis voor deze opslag wordt gepauzeerd.
Retourneert
Een Booleaanse waarde:
true
: De gebeurtenis wordt gepauzeerd zodat geen gebeurtenissen voor deze opslag worden teweeggebracht.false
: De gebeurtenis wordt niet gepauzeerd zodat de gebeurtenissen voor deze opslag worden teweeggebracht.
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 het data
gebeurtenis. 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 data
gebeurtenis.
Parameters
-
toets: (String) De naam van de toets die moet worden verwijderd.
-
opties: (Object) Een object met opties. De volgende objecteigenschappen zijn geldig:
- stil: Een waarde van
true
voorkomt dat dedata
gebeurtenis. De standaardwaarde isfalse
.
- stil: Een waarde van
Retourneert
A boolean
waarde:
- Een waarde van
true
Geeft aan dat het sleutelwaardepaar is verwijderd. - Een waarde van
false
Hiermee wordt aangegeven dat de gegevensopslag ongewijzigd blijft omdat de sleutel niet in de opslag is gevonden.
removeReference(key) removereference-key
Hiermee verwijdert u een verwijzing uit de winkel.
Parameters
- toets: De belangrijkste verwijzing om te verwijderen. Deze parameter komt overeen met
key
parameter van deaddReference
functie.
Retourneert
A boolean
waarde:
- Een waarde van
true
Geeft aan dat de verwijzing is verwijderd. - Een waarde van
false
geeft aan dat de sleutel niet geldig was en dat de winkel ongewijzigd is.
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
- keepRestatingData: (Boolean) Bij de waarde true blijven niet-initiële gegevens behouden. Bij de waarde false worden alle gegevens verwijderd, behalve de beginwaarden.
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
- keepRestatingData: (Boolean) Bij de waarde true blijven niet-initiële gegevens behouden. Bij de waarde false worden alle gegevens verwijderd, behalve de beginwaarden.
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
-
toets: (String) De sleutel waarvoor de verwijzing moet worden opgelost. Dit
key
parameter komt overeen metkey
parameter van deaddReference
functie. -
opnieuw proberen: (Number) Het aantal herhalingen dat moet worden gebruikt.
Retourneert
A string
waarde die de referenced sleutel vertegenwoordigt. Als er geen verwijzing wordt gevonden, wordt de waarde van de optie key
parameter wordt 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.
Hiermee wordt het dialoogvenster data
alleen als de waarde voor de toets anders is dan de waarde die momenteel voor de toets is opgeslagen. U kunt desgewenst voorkomen dat het data
gebeurtenis.
De gebeurtenisgegevens omvatten de opslagnaam, de sleutel, de vorige waarde, de nieuwe waarde en het actietype van set
.
Parameters
-
toets: (String) De naam van de toets.
-
opties: (Object) Een object met opties. De volgende objecteigenschappen zijn geldig:
- stil: Een waarde van
true
voorkomt dat dedata
gebeurtenis. De standaardwaarde isfalse
.
- stil: Een waarde van
-
waarde: (Object) De waarde die aan de sleutel moet worden gekoppeld.
Retourneert
A boolean
waarde:
- Een waarde van
true
Hiermee wordt aangegeven dat het gegevensobject is opgeslagen. - Een waarde van
false
Hiermee wordt aangegeven dat de gegevensopslag ongewijzigd blijft.
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 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 extends ContextHub.Store.Core en neemt de functies van die klasse over.
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
-
serviceConfig: Een object dat de volgende eigenschappen bevat:
-
host: (Tekenreeks) De servernaam of het IP-adres.
-
jsonp: (Boolean) De waarde true geeft aan dat de service een JSONP-service is, anders false. Indien waar (true), wordt de callback: "ContextHub.Callbacks.Object.name}-object wordt toegevoegd aan het object service.params.
-
param: (Object) URL-parameters vertegenwoordigd als objecteigenschappen. Parameternamen zijn eigenschapnamen en parameterwaarden zijn eigenschapswaarden.
-
pad: (Tekenreeks) Het pad naar de service.
-
poort: (Aantal) het havenaantal van de dienst.
-
veilig: (String of Boolean) Bepaalt het protocol dat voor de service-URL moet worden gebruikt:
- auto: //
- true: https://
- false: https://
-
-
overschrijven: (Booleaans). Een waarde van
true
veroorzaakt de bestaande de dienstconfiguratie om door de eigenschappen van te worden vervangenserviceConfig
. Een waarde vanfalse
veroorzaakt de bestaande eigenschappen van de de dienstconfiguratie om met de eigenschappen van worden samengevoegd:serviceConfig
.
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
Een object dat de onbewerkte reactie vertegenwoordigt.
getServiceDetails() getservicedetails
Hiermee wordt het serviceobject voor dit ContextHub.Store.JSONPStore-object opgehaald. Het serviceobject bevat alle informatie die nodig is om de service-URL te maken.
Retourneert
Een object met de volgende eigenschappen:
-
host: (Tekenreeks) De servernaam of het IP-adres.
-
jsonp: (Boolean) De waarde true geeft aan dat de service een JSONP-service is, anders false. Indien waar (true), wordt de callback: "ContextHub.Callbacks.Object.name}-object wordt toegevoegd aan het object service.params.
-
param: (Object) URL-parameters vertegenwoordigd als objecteigenschappen. Parameternamen zijn eigenschapnamen en parameterwaarden zijn eigenschapswaarden.
-
pad: (Tekenreeks) Het pad naar de service.
-
poort: (Aantal) het havenaantal van de dienst.
-
veilig: (String of Boolean) Bepaalt het protocol dat voor de service-URL moet worden gebruikt:
- auto: //
- true: https://
- false: https://
getServiceURL(resolve) getserviceurl-resolve
Haalt URL van de dienst JSONP op.
Parameters
- oplossen: (Boolean) Hiermee wordt bepaald of omgezette parameters in de URL moeten worden opgenomen. Een waarde van
true
stelt parameters op, enfalse
niet.
Retourneert
A string
waarde die de service-URL vertegenwoordigt.
init(name, config) init-name-config-1
initialiseert het object ContextHub.Store.JSONPStore.
Parameters
-
naam: (Tekenreeks) De naam van de winkel.
-
config: (Object) Een object dat de eigenschap service bevat. Het JSONPStore-object gebruikt de eigenschappen van de
service
object voor het samenstellen van de URL van de JSONP-service:-
eventDeferring: 32.
-
gebeurtenis: Het object ContextHub.Utils.Event voor deze winkel. De standaardwaarde is
ContextHub.eventing
object. -
persistentie: Het object ContextHub.Utils.Persistence voor deze winkel. Standaard wordt geheugenpersistentie gebruikt (Javascript-object).
-
service: (Object)
-
host: (Tekenreeks) De servernaam of het IP-adres.
-
jsonp: (Boolean) De waarde true geeft aan dat de service een JSONP-service is, anders false. Indien waar (true), wordt
{callback: "ContextHub.Callbacks.*Object.name*}
object wordt toegevoegd aanservice.params
. -
param: (Object) URL-parameters vertegenwoordigd als objecteigenschappen. Parameternamen en -waarden zijn respectievelijk namen en waarden van objecteigenschappen.
-
pad: (Tekenreeks) Het pad naar de service.
-
poort: (Aantal) het havenaantal van de dienst.
-
veilig: (String of Boolean) Bepaalt het protocol dat voor de service-URL moet worden gebruikt:
- auto: //
- true: https://
- false: https://
-
timeout: (Aantal) de hoeveelheid tijd op de dienst JSONP te wachten om vóór timing uit, in milliseconden te antwoorden.
-
ttl: De minimumhoeveelheid tijd in milliseconden die tussen vraag tot de dienst JSONP overgaat. (Zie de queryService functie).
-
-
queryService(reload) queryservice-reload
Zoekt de verre dienst JSONP en caches de reactie. Als de hoeveelheid tijd sinds de vorige aanroep van deze functie kleiner is dan de waarde van config.service.ttl
, wordt de dienst niet geroepen en de caching reactie wordt niet veranderd. Naar keuze, kunt u de dienst dwingen om worden geroepen. De config.service.ttl
eigenschap wordt ingesteld wanneer het aanroepen van de init om de winkel 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
- opnieuw laden: (Boolean) De waarde true verwijdert de reactie in de cache en dwingt de JSONP-service aan te roepen.
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
- keepRestatingData: (Boolean) Bij de waarde true blijven niet-initiële gegevens behouden. Bij de waarde false worden alle gegevens verwijderd, behalve de beginwaarden.
resolveParameter(f) resolveparameter-f
Hiermee wordt de opgegeven parameter omgezet.
ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore
ContextHub.Store.PersistedJSONPStore extends ContextHub.Store.JSONPStore dus neemt het alle functies van die klasse over. Nochtans, worden de gegevens die van de dienst JSONP worden teruggewonnen voortgeduurd volgens de configuratie van persistentie ContextHub. (Zie Persistentiemodi.)
ContextHub.Store.PersistedStore contexthub-store-persistedstore
ContextHub.Store.PersistedStore extends ContextHub.Store.Core dus neemt het alle functies van die klasse over. De gegevens in deze opslag worden voortgeduurd volgens de configuratie van persistentie ContextHub.
ContextHub.Store.SessionStore contexthub-store-sessionstore
ContextHub.Store.SessionStore is uitgebreid ContextHub.Store.Core dus neemt het alle functies van die klasse over. 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 de renderer is geregistreerd, kan deze worden gebruikt om UI-modules maken. Gebruik deze functie wanneer u ContextHub.UI.BaseModuleRenderer uitbreiden om een aangepaste UI Module-renderer te maken.
Parameters
- moduleType: (Tekenreeks) De id voor de renderer van de module UI. Als een renderer al is geregistreerd met de opgegeven waarde, is de bestaande renderer niet geregistreerd voordat deze renderer is geregistreerd.
- renderer: (String) De naam van de klasse die de module UI rendert.
- dontRender: (Boolean) Ingesteld op
true
om ContextHub UI te verhinderen worden teruggegeven nadat renderer wordt geregistreerd. De standaardwaarde isfalse
.
Voorbeeld
In het volgende voorbeeld wordt een renderer geregistreerd als het type van de module 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
- toets: A
String
die de sleutel bevat van het cookie waarvoor u test.
Retourneert
A boolean
De waarde true geeft aan dat het cookie bestaat.
Voorbeeld
if (ContextHub.Utils.Cookie.exists("name")) {
// conditionally-executed code
}
getAllItems(filter) getallitems-filter
Retourneert alle cookies met sleutels die overeenkomen met een filter.
Parameters
-
(Optioneel) filter: Criteria voor het afstemmen van cookies. Geef geen waarde op om alle cookies te retourneren. De volgende typen worden ondersteund:
- Tekenreeks: De tekenreeks wordt vergeleken met de cookie-toets.
- Array: Elk item in de array is een filter.
- Een RegExp-object: De testfunctie van het object wordt gebruikt om cookies aan te passen.
- Een functie: Een functie die een koekjessleutel voor een gelijke test. De functie moet de koekjessleutel als parameter nemen en waar terugkeren als de test een gelijke bevestigt.
Retourneert
Een object van cookies. Objecteigenschappen zijn cookie sleutels en sleutelwaarden zijn cookie waarden.
Voorbeeld
ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])
getItem(key) getitem-key-1
Retourneert een cookiewaarde.
Parameters
- toets: De sleutel van het koekje waarvoor u de waarde wilt.
Retourneert
De waarde van het cookie, of null
als er geen cookie is gevonden voor de toets.
Voorbeeld
ContextHub.Utils.Cookie.getItem("name");
getKeys (filter) getkeys-filter
Retourneert een array met de sleutels van bestaande cookies die overeenkomen met een filter.
Parameters
-
filter: Criteria voor het afstemmen van cookies. De volgende typen worden ondersteund:
- Tekenreeks: De tekenreeks wordt vergeleken met de cookie-toets.
- Array: Elk item in de array is een filter.
- Een RegExp-object: De testfunctie van het object wordt gebruikt om cookies aan te passen.
- Een functie: Een functie die een koekjessleutel voor een gelijke test. De functie moet de cookiesleutel als parameter nemen en terugkeren
true
als de test een gelijke bevestigt.
Retourneert
Een array van tekenreeksen waarbij elke tekenreeks de sleutel is van een cookie die overeenkomt met het filter.
Voorbeeld
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 tekenreeks en wordt de vervaldatum ingesteld op de dag vóór de huidige datum.
Parameters
-
toets: A
String
waarde die staat voor de sleutel van het cookie dat moet worden verwijderd. -
opties: Een object dat eigenschapwaarden bevat voor het configureren van de cookie-kenmerken. Zie de
[setItem](https://experienceleague.adobe.com/docs/experience-manager-64/developing/personlization/contexthub-api.html?lang=nl#setitem-key-value-options)
functie voor informatie. Deexpires
eigenschap heeft geen effect.
Retourneert
Deze functie retourneert geen waarde.
Voorbeeld
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
-
toets: Een tekenreeks die de sleutel van het cookie bevat.
-
waarde: Een tekenreeks die de cookiewaarde bevat.
-
opties: (Optioneel) Een object dat een van de volgende eigenschappen bevat waarmee de cookie-kenmerken worden geconfigureerd:
- verloopt: A
date
ofnumber
waarde die aangeeft wanneer het cookie vervalt. Een datumwaarde geeft de absolute vervaltijd aan. Een getal (in dagen) stelt de vervaltijd in op de huidige tijd plus het getal. De standaardwaarde isundefined
. - veilig: A
boolean
waarde die deSecure
kenmerk van de cookie. De standaardwaarde isfalse
. - pad: A
String
te gebruiken waarde als dePath
kenmerk van de cookie. De standaardwaarde isundefined
.
- verloopt: A
Retourneert
Het cookie met de ingestelde waarde.
Voorbeeld
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 gevonden met behulp van de functie getKeys en verwijderd met behulp van de functie removeItem.
Parameters
-
filter: De
filter
in de oproep tot[getKeys](/docs/experience-manager-64/developing/personlization/contexthub-api.md#getkeys-filter)
functie. -
opties: De
options
in de oproep tot[removeItem](/docs/experience-manager-64/developing/personlization/contexthub-api.md#removeitem-key-options)
functie.
Retourneert
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. Toegang krijgen tot objecten ContextHub.Utils.Event voor een winkel die de voorkomen eigenschap van de winkel.
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
-
naam: De naam van de gebeurtenis waarvoor u de binding van de functie ongedaan maakt.
-
kiezer: De kiezer die de binding aangeeft. (Zie de
selector
parameter voor de op en eenmaal functies).
Retourneert
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
-
naam: (String) De naam van de gebeurtenis waaraan u de functie bindt.
-
handler: (Functie) De functie die aan de gebeurtenis wordt gebonden.
-
kiezer: (Tekenreeks) Een unieke id voor de binding. U hebt de kiezer nodig om de binding te identificeren als u de
off
functie om de binding te verwijderen. -
triggerForPastEvents: (Boolean) Geeft aan of de handler moet worden uitgevoerd voor gebeurtenissen die zich in het verleden hebben voorgedaan. Een waarde van
true
roept de manager voor vroegere gebeurtenissen aan. Een waarde vanfalse
roept de manager voor toekomstige gebeurtenissen. De standaardwaarde istrue
.
Retourneert
Wanneer de triggerForPastEvents
argument is true
Deze functie retourneert een boolean
waarde die aangeeft of de gebeurtenis in het verleden heeft plaatsgevonden:
true
: De gebeurtenis vond in het verleden plaats en de handler wordt aangeroepen.false
: De gebeurtenis heeft zich in het verleden niet voorgedaan.
Indien triggerForPastEvents
is false
, retourneert deze functie geen waarde.
Voorbeeld
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
-
naam: (String) De naam van de gebeurtenis waaraan u de functie bindt.
-
handler: (Functie) De functie die aan de gebeurtenis wordt gebonden.
-
kiezer: (Tekenreeks) Een unieke id voor de binding. U hebt de kiezer nodig om de binding te identificeren als u de
off
functie om de binding te verwijderen. -
triggerForPastEvents: (Boolean) Geeft aan of de handler moet worden uitgevoerd voor gebeurtenissen die zich in het verleden hebben voorgedaan. Een waarde van
true
roept de manager voor vroegere gebeurtenissen aan. Een waarde vanfalse
roept de manager voor toekomstige gebeurtenissen. De standaardwaarde istrue
.
Retourneert
Wanneer de triggerForPastEvents
argument is true
Deze functie retourneert een boolean
waarde die aangeeft of de gebeurtenis in het verleden heeft plaatsgevonden:
true
: De gebeurtenis vond in het verleden plaats en de handler wordt aangeroepen.false
: De gebeurtenis heeft zich in het verleden niet voorgedaan.
Indien triggerForPastEvents
is false
, 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
- kind: (Object) Het object dat overerft.
- bovenliggend element: (Object) Het object dat de eigenschappen en methoden definieert die worden overgeërfd.
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
- gegevens: Een tekenreekswaarde in JSON-indeling.
Retourneert
Een JavaScript-object.
Voorbeeld
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
Serializes Javascript-waarden en -objecten in tekenreekswaarden in de JSON-indeling.
Parameters
- gegevens: De waarde of het object waarop serienummering moet worden toegepast. Deze functie ondersteunt booleaanse waarden, arrays, getallen, tekenreeksen en datumwaarden.
Retourneert
De geserialiseerde tekenreekswaarde. Wanneer data
is een R egExp
waarde, retourneert deze functie een leeg object. Wanneer data
is een functie, retourneert undefined
.
Voorbeeld
De volgende code retourneert "{'city':'Basel','country':'Switzerland','population':'173330'}":
ContextHub.Utils.JSON.stringify({
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
- boom: Het object dat wordt gekopieerd.
- secondTree: Het object dat wordt samengevoegd met de kopie van het dialoogvenster
tree
object.
Retourneert
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
- boom: Het object dat moet worden gewist.
Retourneert
Een kopie van de boom die is schoongemaakt.
getItem() getitem
Hiermee wordt de waarde opgehaald van een object voor de toets A.
Parameters
- boom: Het gegevensobject.
- toets: De sleutel voor de waarde die u wilt terugwinnen.
Retourneert
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
, null
wordt geretourneerd.
Voorbeeld
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
- boom: Het object waarvan de sleutels van de gegevensstructuur moeten worden opgehaald.
- bovenliggend element: (Optioneel) De sleutel van een item in de gegevensstructuur waarvoor u de sleutels van de onderliggende items wilt ophalen.
- bestelling: (Optioneel) Een functie die de sorteervolgorde van de geretourneerde toetsen bepaalt. (Zie Array.prototype.sort op het Mozilla Developer Network.)
Retourneert
Een array met sleutels.
Voorbeeld
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
}
}
De 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
- boom: Een gegevensobject.
- toets: De toets die moet worden verwijderd.
Retourneert
Een kopie van het oorspronkelijke gegevensobject waarbij de toets is verwijderd.
Voorbeeld
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:
- Hiermee worden meerdere opeenvolgende slashes tot één schuine streep verkleind.
- Verwijdert witruimte aan het begin en einde van de tekenreeks.
- Splitst het resultaat in een array van tekenreeksen die worden afgebakend door slashes.
Gebruik de resulterende array om een bruikbare sleutel te maken. Parameters
- toets: De
string
om te ontsmetten.
Retourneert
Een array van string
waarden waarbij elke tekenreeks het deel van de key
dat werd afgebakend door slashes . vertegenwoordigt de geanimeerde sleutel. Als de geanimeerde array een lengte van nul heeft, retourneert deze functie null
.
Voorbeeld
Met de volgende code wordt een tekenreeks gesimuleerd om de array te produceren ["this", "is", "a", "path"]
en genereert vervolgens de toets "/this/is/a/path"
uit de 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
Hiermee voegt u een sleutel-/waardepaar toe aan de gegevensstructuur van een kopie van een object. Voor informatie over gegevensbomen raadpleegt u Persistentie.
Parameters
- boom: Een gegevensobject.
- toets: De sleutel die moet worden gekoppeld aan de waarde die u toevoegt. De sleutel is het pad naar het item in de gegevensstructuur. Deze functie roept
ContextHub.Utils.JSON.tree.sanitize
om de toets te ontsmetten voordat u deze toevoegt. - waarde: De waarde die aan de gegevensstructuur moet worden toegevoegd.
Retourneert
Een kopie van de tree
object dat het key
/ value
paar.
Voorbeeld
Overweeg 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);
Het object myObject heeft de volgende waarde:
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 candicates van een specifiek archieftype of van alle archieftypes terug.
Parameters
- storeType: (String) De naam van het winkeltype. Zie de
storeType
parameter van deContextHub.Utils.storeCandidates.registerStoreCandidate
functie.
Retourneert
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 opslagtype met de hoogste prioriteit terug.
Parameters
- storeType: (String) De naam van de opslagkandidaat. Zie de
storeType
parameter van deContextHub.Utils.storeCandidates.registerStoreCandidate
functie.
Retourneert
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
Een array van tekenreekswaarden, waarbij elke tekenreeks het opslagtype is waarmee een opslagkandidaat is geregistreerd. Zie de storeType
parameter van de ContextHub.Utils.storeCandidates.registerStoreCandidate
functie.
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
- opslag: (Object) Het opslagobject dat moet worden geregistreerd als opslagkandidaat.
- storeType: (String) De naam van de opslagkandidaat. Deze waarde wordt vereist wanneer het creëren van een geval van de opslagkandidaat.
- prioriteit: (Aantal) De prioriteit van de opslagkandidaat.
- van toepassing: (Functie) De functie die moet worden aangeroepen die de toepasselijkheid van de opslag in de huidige omgeving evalueert. De functie moet worden geretourneerd
true
indien de opslagplaats van toepassing is, enfalse
anders. De standaardwaarde is een functie die waar retourneert:function() {return true;}
Voorbeeld
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);