ContextHub Javascript API-referens

Senast uppdaterad: 4 maj 2023

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.

ContextHub Javascript API är tillgängligt för skript när ContextHub-komponenten har lagts till på sidan.

ContextHub-konstanter

Konstantvärden som definieras av ContextHub Javascript-API:t.

Händelsekonstanter

I följande tabell visas namnen på händelser som inträffar för ContextHub Stores. Se även ContextHub.Utils.Eventing.

KonstantBeskrivningVärde
ContextHub.Constants.EVENT_NAMESPACEContextHub's event namespacech
ContextHub.Constants.EVENT_ALL_STORES_READYAnger att alla nödvändiga butiker är registrerade, initierade och klara att användasall-stores-ready
ContextHub.Constants.EVENT_STORES_PARTIALLY_READYAnger att inte alla butiker initierades inom en angiven tidsgränsstores-delvis-ready
ContextHub.Constants.EVENT_STORE_REGISTEREDUtlöses när en butik registrerasbutiksregistrerad
ContextHub.Constants.EVENT_STORE_READYAnger att butikerna är redo att arbeta. Den aktiveras omedelbart efter registreringen, förutom JSONP-arkiv, där den aktiveras när data hämtas).butiksklar
ContextHub.Constants.EVENT_STORE_UPDATEDUtlöses när en butik uppdaterar sin beständighetbutiksuppdaterad
ContextHub.Constants.PERSISTENCE_CONTAINER_NAMENamn på beständiga behållareContextHubPersistence
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEYLagrar ett särskilt namn på en beständig nyckel där JSON-resultatet i Raw-format lagras/_/raw-response
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEYLagrar en specifik tidsstämpel som anger när JSON-data hämtades/_svarstid
ContextHub.Constants.SERVICE_LAST_URL_KEYLagrar en specifik URL för JSON-tjänsten som användes under det senaste anropet/_/url
ContextHub.Constants.IS_CONTAINER_EXPANDEDAnger om användargränssnittet för ContextHub är expanderat/_/container-expanded

Konstanter för gränssnittshändelser

I följande tabell visas namnen på händelser som inträffar för användargränssnittet för ContextHub.

KonstantBeskrivningVärde
ContextHub.Constants.EVENT_UI_MODE_REGISTEREDUtlöses när ett läge registrerasui-mode-registered
ContextHub.Constants.EVENT_UI_MODE_UNREGISTEREDUtlöses när ett läge avregistrerasui-mode-unregistered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTEREDUtlöses när en lägesåtergivare registrerasui-mode-renderer-registered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTEREDUtlöses när en lägesåtergivare avregistrerasui-mode-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODE_ADDEDUtlöses när ett nytt läge läggs tillUi-mode-added
ContextHub.Constants.EVENT_UI_MODE_REMOVEDUtlöses när ett läge tas bortui-mode-removed
ContextHub.Constants.EVENT_UI_MODE_SELECTEDUtlöses när ett läge väljs av användarenui-mode-selected
ContextHub.Constants.EVENT_UI_MODULE_REGISTEREDUtlöses när en ny modul registrerasui-module-registered
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTEREDUtlöses när en modul avregistrerasui-module-unregistered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTEREDUtlöses när en modulåtergivare registrerasui-module-renderer-registered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTEREDUtlöses när en modulåtergivare avregistrerasui-module-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODULE_ADDEDUtlöses när en ny modul läggs tillui-module-added
ContextHub.Constants.EVENT_UI_MODULE_REMOVEDUtlöses när en modul tas bortui-module-removed
ContextHub.Constants.EVENT_UI_CONTAINER_ADDEDUtlöses när gränssnittsbehållaren läggs till på sidanui-container-added
ContextHub.Constants.EVENT_UI_CONTAINER_OPENEDUtlöses när ContextHub-gränssnittet öppnasui-container-opened
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSEDUtlöses när gränssnittet för ContextHub är komprimeratui-container-closed
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIEDUtlöses när en egenskap ändrasui-property-modified
ContextHub.Constants.EVENT_UI_RENDEREDUtlöses varje gång ContextHub-gränssnittet återges (t.ex. efter en egenskapsändring)ui-renderad
ContextHub.Constants.EVENT_UI_INITIALIZEDUtlöses när gränssnittsbehållaren initierasui-initierad
ContextHub.Constants.ACTIVE_UI_MODEAnger aktivt användargränssnittsläge/_/active-ui-mode

ContextHub Javascript API-referens

ContextHub-objektet ger åtkomst till alla arkiv.

Funktioner (ContextHub)

getAllStores()

Returnerar alla registrerade ContextHub-butiker.

Den här funktionen har inga parametrar.

Returnerar

Ett objekt som innehåller alla ContextHub-arkiv. Varje butik är ett objekt som använder samma namn som butiken.

Exempel

I följande exempel hämtas alla butiker och sedan hämtas geopositioneringsarkivet:

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

getStore(name)

Hämtar en butik som ett JavaScript-objekt.

Parametrar

  • namn: Namnet som butiken registrerades med.

Returnerar

Ett objekt som representerar butiken.

Exempel

I följande exempel hämtas geopositioneringsarkivet:

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

ContextHub.SegmentEngine.Segment

Representerar ett ContextHub-segment. Använd ContextHub.SegmentEngine.SegmentManager för att hämta segment.

Funktioner (ContextHub.ContextEngine.Segment)

getName()

Returnerar segmentets namn som ett strängvärde.

getPath()

Returnerar databassökvägen för segmentdefinitionen som ett strängvärde.

ContextHub.SegmentEngine.SegmentManager

Ger åtkomst till ContextHub-segment.

Funktioner (ContextHub.SegmentEngine.SegmentManager)

getResolvedSegments()

Returnerar de segment som matchas i den aktuella kontexten. Den här funktionen har inga parametrar.

Returnerar

En array med ContextHub.SegmentEngine.Segment-objekt.

ContextHub.Store.Core

Basklassen för ContextHub-butiker.

Egenskaper (ContextHub.Store.Core)

eventera

A ContextHub.Utils.Eventing -objekt. Använd det här objektet för bindningsfunktioner för att lagra händelser. Mer information om standardvärde och initiering finns i init(name,config).

name

Butikens namn.

beständighet

Ett ContextHub.Utils.Persistence-objekt. Mer information om standardvärde och initiering finns i init(name,config).

Funktioner (ContextHub.Store.Core)

addAllItems(träd, alternativ)

Sammanfogar ett dataobjekt eller en array med lagringsdata. Varje nyckel/värde-par i objektet eller arrayen läggs till i arkivet (via setItem function):

  • Objekt: Tangenter är egenskapsnamnen.
  • Array: Tangenter är matrisindex.

Observera att värden kan vara objekt.

Parametrar

  • träd: (Objekt eller array) De data som ska läggas till i arkivet.
  • alternativ: (Object) Ett valfritt objekt med alternativ som skickas till funktionen setItem. Mer information finns i options parameter för setItem(key,value,options).

Returnerar

A boolean värde:

  • Värdet för true anger att dataobjektet har lagrats.
  • Värdet för false anger att datalagret inte ändras.

addReference(key, anotherKey)

Skapar en referens från en tangent till en annan. En nyckel kan inte referera till sig själv.

Parametrar

  • nyckel: Nyckeln som refererar anotherKey.

  • annan nyckel: Nyckeln som refereras av key.

Returnerar

A boolean värde:

  • Värdet för true anger att referensen har lagts till.
  • Värdet för false anger att ingen referens har lagts till.

announReadiness()

Utlöser ready händelse för den här butiken. Den här funktionen har inga parametrar och returnerar inget värde.

clear()

Tar bort alla data från arkivet. Funktionen har inga parametrar och inget returvärde.

getItem(key)

Returnerar värdet som är associerat med en nyckel.

Parametrar

  • nyckel: (String) Nyckeln som värdet ska returneras för.

Returnerar

Ett objekt som representerar värdet för nyckeln.

getKeys(includeInternals)

Hämtar nycklarna från butiken. Du kan också hämta nycklar som används internt av ContextHub-ramverket.

Parametrar

  • includeInternals: Värdet för true innehåller internt använda nycklar i resultatet. Dessa tangenter börjar med understrecket ("_"). Standardvärdet är false.

Returnerar

En array med nyckelnamn ( string värden).

getReferences()

Hämtar referenserna från butiken.

Returnerar

En array som använder refererande nycklar som index för refererade nycklar:

  • Referensnycklar motsvarar key parametern för addReference funktion.

  • Refererade nycklar motsvarar anotherKey parametern för addReference funktion.

getTree(includeInternals)

Hämtar dataträdet från butiken. Du kan också inkludera nyckel/värde-par som används internt av ContextHub-ramverket.

Parametrar

  • includeInternals: Värdet för true innehåller nyckelvärdepar som används internt i resultatet. Nycklarna för dessa data börjar med understrecket ("_"). Standardvärdet är false.

Returnerar

Ett objekt som representerar dataträdet. Nycklarna är objektets egenskapsnamn.

init(name, config)

Initierar butiken.

  • Ställer in lagringsdata till ett tomt objekt.

  • Ställer in butiksreferenserna till ett tomt objekt.

  • eventChannel är data:name, där name är butiksnamnet.

  • storeDataKey är /store/name, där name är butiksnamnet.

Parametrar

  • namn: Butikens namn.

  • config: Ett objekt som innehåller konfigurationsegenskaper:

    • eventDeferring: Standardvärdet är 32.
    • händelser: The ContextHub.Utils.Eventing objekt för den här butiken. Standardvärdet är det ContextHub.eventing-objekt som används.
    • beständighet: ContextHub.Utils.Persistence-objektet för det här arkivet. Standardvärdet är ContextHub.persistence-objektet.

isEventingPaused()

Avgör om händelser pausas för det här arkivet.

Returnerar

Ett booleskt värde:

  • true: Händelsen pausas så att inga händelser aktiveras för den här butiken.
  • false: Händelsen pausas inte så att händelser aktiveras för den här butiken.

pauseEventing()

Pausar händelser för arkivet så att inga händelser utlöses. Den här funktionen kräver inga parametrar och returnerar inget värde.

removeItem(key, options)

Tar bort ett nyckel/värde-par från arkivet.

När en tangent tas bort utlöser funktionen data -händelse. Händelsedata innehåller arkivnamnet, namnet på den nyckel som togs bort, det värde som togs bort, det nya värdet för nyckeln (null) och åtgärdstypen "remove".

Du kan även förhindra att data -händelse.

Parametrar

  • nyckel: (String) Namnet på nyckeln som ska tas bort.

  • alternativ: (Objekt) Ett objekt med alternativ. Följande objektegenskaper är giltiga:

    • tyst: Värdet för true förhindrar att data -händelse. Standardvärdet är false.

Returnerar

A boolean värde:

  • Värdet för true anger att nyckel/värde-paret har tagits bort.
  • Värdet för false anger att datalagret inte ändras eftersom nyckeln inte hittades i arkivet.

removeReference(key)

Tar bort en referens från arkivet.

Parametrar

  • nyckel: Nyckelreferensen som ska tas bort. Den här parametern motsvarar key parametern för addReference funktion.

Returnerar

A boolean värde:

  • Värdet för true anger att referensen har tagits bort.
  • Värdet för false anger att nyckeln inte var giltig och att arkivet är oförändrat.

reset(keepRemainingData)

Återställer de ursprungliga värdena för butikens beständiga data. Du kan också ta bort alla andra data från arkivet. Händelser pausas för det här arkivet när arkivet återställs. Den här funktionen returnerar inget värde.

Initialvärden anges i egenskapen initialValues för det config-objekt som används för att instansiera lagringsobjektet.

Parametrar

  • keepRemainingData: (Boolean) Värdet true gör att icke-initiala data bevaras. Värdet false medför att alla data tas bort utom de ursprungliga värdena.

Återställer de ursprungliga värdena för butikens beständiga data. Du kan också ta bort alla andra data från arkivet. Händelser pausas för det här arkivet när arkivet återställs. Den här funktionen returnerar inget värde.

Initialvärden anges i egenskapen initialValues för det config-objekt som används för att instansiera lagringsobjektet.

Parametrar

  • keepRemainingData: (Boolean) Värdet true gör att icke-initiala data bevaras. Värdet false medför att alla data tas bort utom de ursprungliga värdena.

resolveReference(key, retry)

Hämtar en refererad nyckel. Du kan också ange antalet iterationer som ska användas för att matcha den bästa matchningen.

Parametrar

  • nyckel: (String) Nyckeln som referensen ska matchas för. Detta key parametern motsvarar key parametern för addReference funktion.

  • försök igen: (Number) Antalet iterationer som ska användas.

Returnerar

A string värdet som representerar den refererade nyckeln. Om ingen referens är löst, är värdet för key parametern returneras.

resumeEventing()

Återupptar händelser för den här butiken så att händelser utlöses. Den här funktionen definierar inga parametrar och returnerar inget värde.

setItem(key, value, options)

Lägger till ett nyckel/värde-par i butiken.

Utlöser data bara om värdet för nyckeln skiljer sig från värdet som för närvarande lagras för nyckeln. Du kan även förhindra att data -händelse.

Händelsedata innehåller butiksnamnet, nyckeln, det föregående värdet, det nya värdet och åtgärdstypen för set.

Parametrar

  • nyckel: (String) Namnet på nyckeln.

  • alternativ: (Objekt) Ett objekt med alternativ. Följande objektegenskaper är giltiga:

    • tyst: Värdet för true förhindrar att data -händelse. Standardvärdet är false.

  • värde: (Objekt) Värdet som ska associeras med nyckeln.

Returnerar

A boolean värde:

  • Värdet för true anger att dataobjektet har lagrats.
  • Värdet för false anger att datalagret inte ändras.

ContextHub.Store.JSONPStore

Ett arkiv som innehåller JSON-data. Data hämtas från en extern JSONP-tjänst, eller eventuellt från en tjänst som returnerar JSON-data. Ange tjänstinformationen med init när du skapar en instans av den här klassen.

Butiken använder beständighet i minnet (Javascript-variabel). Lagringsdata är bara tillgängliga under sidans livstid.

ContextHub.Store.JSONPStore extends ContextHub.Store.Core och ärver funktionerna i den klassen.

Funktioner (ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

Konfigurerar informationen för anslutning till den JSONP-tjänst som det här objektet använder. Du kan antingen uppdatera eller ersätta den befintliga konfigurationen. Funktionen returnerar inget värde.

Parametrar

  • serviceConfig: Ett objekt som innehåller följande egenskaper:

    • värd: (String) Servernamnet eller IP-adressen.

    • jsonp: (Boolean) Värdet true anger att tjänsten är en JSONP-tjänst, i annat fall false. När true är {callback: "ContextHub.Callbacks.Object.name}-objektet läggs till i service.params-objektet.

    • parametrar: (Objekt) URL-parametrar representeras som objektegenskaper. Parameternamn är egenskapsnamn och parametervärden är egenskapsvärden.

    • sökväg: (String) Sökvägen till tjänsten.

    • port: (Nummer) Tjänstens portnummer.

    • säker: (Sträng eller Boolean) Anger vilket protokoll som ska användas för tjänstens URL:

      • auto: //
      • true: https://
      • false: https://

  • åsidosätt: (Boolean). Värdet för true gör att den befintliga tjänstkonfigurationen ersätts med egenskaperna för serviceConfig. Värdet för false gör att befintliga tjänstkonfigurationsegenskaper sammanfogas med egenskaperna för serviceConfig.

getRawResponse()

Returnerar det obearbetade svar som har cachelagrats sedan det senaste anropet till JSONP-tjänsten. Funktionen kräver inga parametrar.

Returnerar

Ett objekt som representerar råsvaret.

getServiceDetails()

Hämtar tjänstobjektet för det här ContextHub.Store.JSONPStore-objektet. Tjänsteobjektet innehåller all information som krävs för att skapa tjänstens URL.

Returnerar

Ett objekt med följande egenskaper:

  • värd: (String) Servernamnet eller IP-adressen.

  • jsonp: (Boolean) Värdet true anger att tjänsten är en JSONP-tjänst, i annat fall false. När true är {callback: "ContextHub.Callbacks.Object.name}-objektet läggs till i service.params-objektet.

  • parametrar: (Objekt) URL-parametrar representeras som objektegenskaper. Parameternamn är egenskapsnamn och parametervärden är egenskapsvärden.

  • sökväg: (String) Sökvägen till tjänsten.

  • port: (Nummer) Tjänstens portnummer.

  • säker: (Sträng eller Boolean) Anger vilket protokoll som ska användas för tjänstens URL:

    • auto: //
    • true: https://
    • false: https://

getServiceURL(resolve)

Hämtar URL:en för JSONP-tjänsten.

Parametrar

  • lös: (Boolean) Avgör om lösta parametrar ska tas med i URL:en. Värdet för true löser parametrar, och false inte.

Returnerar

A string värde som representerar tjänst-URL:en.

init(name, config)

initierar ContextHub.Store.JSONPStore-objektet.

Parametrar

  • namn: (String) Butikens namn.

  • config: (Objekt) Ett objekt som innehåller egenskapen service. JSONPStore-objektet använder egenskaperna för service objekt för att skapa URL:en för JSONP-tjänsten:

    • eventDeferring: 32.

    • händelser: Objektet ContextHub.Utils.Eventing för det här arkivet. Standardvärdet är ContextHub.eventing -objekt.

    • beständighet: ContextHub.Utils.Persistence-objektet för det här arkivet. Som standard används minnesbeständighet (Javascript-objekt).

    • tjänst: (Objekt)

      • värd: (String) Servernamnet eller IP-adressen.

      • jsonp: (Boolean) Värdet true anger att tjänsten är en JSONP-tjänst, i annat fall false. När true är {callback: "ContextHub.Callbacks.*Object.name*}objekt läggs till i service.params.

      • parametrar: (Objekt) URL-parametrar representeras som objektegenskaper. Parameternamn och värden är objektegenskapsnamnen och -värdena.

      • sökväg: (String) Sökvägen till tjänsten.

      • port: (Nummer) Tjänstens portnummer.

      • säker: (Sträng eller Boolean) Anger vilket protokoll som ska användas för tjänstens URL:

        • auto: //
        • true: https://
        • false: https://

      • timeout: (Nummer) Hur lång tid det tar att vänta på att JSONP-tjänsten ska svara före timeout, i millisekunder.

      • ttl: Den kortaste tiden i millisekunder som går mellan anrop till JSONP-tjänsten. (Se queryService funktion).

queryService(reload)

Frågar fjärrtjänsten JSONP och cachelagrar svaret. Om tiden sedan föregående anrop till den här funktionen är mindre än värdet för config.service.ttl, anropas inte tjänsten och det cachelagrade svaret ändras inte. Du kan också tvinga tjänsten att anropas. The config.service.ttlegenskapen anges när anropet av init funktion för att initiera arkivet.

Startar ready-händelsen när frågan är klar. Om JSONP-tjänstens URL inte är inställd händer ingenting.

Parametrar

  • ladda om: (Boolean) Värdet true tar bort det cachelagrade svaret och tvingar JSONP-tjänsten att anropas.

återställ

Återställer de ursprungliga värdena för butikens beständiga data och anropar sedan JSONP-tjänsten. Du kan också ta bort alla andra data från arkivet. Händelser pausas för det här arkivet medan de ursprungliga värdena återställs. Den här funktionen returnerar inget värde.

Initialvärden anges i egenskapen initialValues för det config-objekt som används för att instansiera lagringsobjektet.

Parametrar

  • keepRemainingData: (Boolean) Värdet true gör att icke-initiala data bevaras. Värdet false medför att alla data tas bort utom de ursprungliga värdena.

resolveParameter(f)

Matchar den angivna parametern.

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedJSONPStore extends ContextHub.Store.JSONPStore så den ärver alla funktioner i den klassen. Data som hämtas från JSONP-tjänsten sparas dock enligt konfigurationen för ContextHub-beständighet. (Se Beständiga lägen.)

ContextHub.Store.PersistedStore

ContextHub.Store.PersistedStore extends ContextHub.Store.Core så den ärver alla funktioner i den klassen. Data i det här arkivet bevaras enligt konfigurationen för ContextHub-beständighet.

ContextHub.Store.SessionStore

ContextHub.Store.SessionStore extends ContextHub.Store.Core så den ärver alla funktioner i den klassen. Data i det här arkivet bevaras med beständighet i minnet (Javascript-objekt).

ContextHub.UI

Hanterar gränssnittsmoduler och gränssnittsmodulrenderare.

Funktioner (ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

Registrerar en gränssnittsmodulrenderare med ContextHub. När återgivaren har registrerats kan den användas för att skapa gränssnittsmoduler. Använd den här funktionen när du är utöka ContextHub.UI.BaseModuleRenderer för att skapa en anpassad renderare för användargränssnittsmodul.

Parametrar

  • moduleType: (String) Identifieraren för gränssnittsmodulens renderare. Om en renderare redan är registrerad med det angivna värdet avregistreras den befintliga renderaren innan den registreras.
  • renderare: (String) Namnet på den klass som återger gränssnittsmodulen.
  • dontRender: (Boolean) Ange som true för att förhindra att ContextHub-gränssnittet återges efter att återgivaren har registrerats. Standardvärdet är false.

Exempel

I följande exempel registreras en renderare som modultypen contexthub.browserinfo.

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

En verktygsklass för interaktion med cookies.

exists(key)

Avgör om det finns en cookie.

Parametrar

  • nyckel: A String som innehåller nyckeln till den cookie som du testar för.

Returnerar

A boolean värdet true anger att cookien finns.

Exempel

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

getAllItems(filter)

Returnerar alla cookies som har nycklar som matchar ett filter.

Parametrar

  • (Valfritt) filter: Kriterier för matchning av cookie-nycklar. Om du vill returnera alla cookies anger du inget värde. Följande typer stöds:

    • Sträng: Strängen jämförs med cookie-nyckeln.
    • Array: Varje objekt i arrayen är ett filter.
    • Ett RegExp-objekt: Objektets testfunktion används för att matcha cookie-nycklar.
    • En funktion: En funktion som testar en cookie-nyckel för en matchning. Funktionen måste ta cookie-nyckeln som parameter och returnera true om testet bekräftar en matchning.

Returnerar

Ett objekt med cookies. Objektegenskaper är cookie-nycklar och nyckelvärden är cookie-värden.

Exempel

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

getItem(key)

Returnerar ett cookie-värde.

Parametrar

  • nyckel: Nyckeln till den cookie som du vill ha värdet för.

Returnerar

cookie-värdet, eller null om ingen cookie hittades för nyckeln.

Exempel

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

getKeys(filter)

Returnerar en array med nycklarna för befintliga cookies som matchar ett filter.

Parametrar

  • filter: Kriterier för matchning av cookie-nycklar. Följande typer stöds:

    • Sträng: Strängen jämförs med cookie-nyckeln.
    • Array: Varje objekt i arrayen är ett filter.
    • Ett RegExp-objekt: Objektets testfunktion används för att matcha cookie-nycklar.
    • En funktion: En funktion som testar en cookie-nyckel för en matchning. Funktionen måste ta cookie-nyckeln som parameter och returnera true om testet bekräftar en matchning.

Returnerar

En array med strängar där varje sträng är nyckeln till en cookie som matchar filtret.

Exempel

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

removeItem(key, options)

Tar bort en cookie. Om du vill ta bort cookien anges värdet till en tom sträng och förfallodatumet anges till dagen före det aktuella datumet.

Parametrar

  • nyckel: A String värdet som representerar nyckeln till den cookie som ska tas bort.

  • alternativ: Ett objekt som innehåller egenskapsvärden för konfiguration av cookie-attributen. Se [setItem](https://experienceleague.adobe.com/docs/experience-manager-64/developing/personlization/contexthub-api.html?lang=sv#setitem-key-value-options) funktion för information. The expires -egenskapen har ingen effekt.

Returnerar

Den här funktionen returnerar inget värde.

Exempel

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

setItem(key, value, options)

Skapar en cookie med den angivna nyckeln och det angivna värdet och lägger till cookien i det aktuella dokumentet. Du kan också ange alternativ som konfigurerar attributen för cookien.

Parametrar

  • nyckel: En sträng som innehåller nyckeln till cookien.

  • värde: En sträng som innehåller cookie-värdet.

  • alternativ: (Valfritt) Ett objekt som innehåller någon av följande egenskaper som konfigurerar cookie-attributen:

    • upphör: A date eller number värdet som anger när cookien förfaller. Ett datumvärde anger den absoluta förfallotiden. Ett tal (i dagar) anger förfallotiden till den aktuella tiden plus talet. Standardvärdet är undefined.
    • säker: A boolean värde som anger Secure cookie-attributet. Standardvärdet är false.
    • sökväg: A String värde som ska användas som Path cookie-attributet. Standardvärdet är undefined.

Returnerar

Cookien med det angivna värdet.

Exempel

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

vDanish(filter, options)

Tar bort alla cookies som matchar ett visst filter. Cookies matchas med funktionen getKeys och tas bort med funktionen removeItem.

Parametrar

  • filter: The filter argument som ska användas i anropet till [getKeys](/docs/experience-manager-64/developing/personlization/contexthub-api.md#getkeys-filter) funktion.

  • alternativ: The options argument som ska användas i anropet till [removeItem](/docs/experience-manager-64/developing/personlization/contexthub-api.md#removeitem-key-options) funktion.

Returnerar

Den här funktionen returnerar inget värde.

ContextHub.Utils.Eventing

Gör att du kan binda och koppla upp funktioner till ContextHub-butikshändelser. Få åtkomst till ContextHub.Utils.Eventing-objekt för en butik med eventera butikens egenskap.

Funktioner (ContextHub.Utils.Eventing)

off(name, selector)

Avbinder en funktion från en händelse.

Parametrar

  • namn: The händelsens namn som du avbinder funktionen för.

  • väljare: Väljaren som identifierar bindningen. (Se selector parametern för på och en funktioner).

Returnerar

Den här funktionen returnerar inget värde.

on(name, handler, selector, triggerForPastEvents)

Bindar en funktion till en händelse. Funktionen anropas varje gång händelsen inträffar. Funktionen kan också anropas för händelser som har inträffat tidigare, innan bindningen har upprättats.

Parametrar

  • namn: (String) händelsens namn som du binder funktionen till.

  • hanterare: (Funktion) Funktionen som ska bindas till händelsen.

  • väljare: (String) En unik identifierare för bindningen. Du behöver väljaren för att identifiera bindningen om du vill använda off funktionen för att ta bort bindningen.

  • triggerForPastEvents: (Boolean) Anger om hanteraren ska köras för händelser som har inträffat tidigare. Värdet för true anropar hanteraren för tidigare händelser. Värdet för false anropar hanteraren för framtida evenemang. Standardvärdet är true.

Returnerar

När triggerForPastEvents argument truereturnerar den här funktionen boolean värde som anger om händelsen har inträffat tidigare:

  • true: Händelsen inträffade tidigare och hanteraren anropas.
  • false: Händelsen har inte inträffat tidigare.

If triggerForPastEvents är falsereturnerar den här funktionen inget värde.

Exempel

I följande exempel binds en funktion till händelsen data i geolocation-arkivet. Funktionen fyller i ett element på sidan med värdet för latituddataobjektet från butiken.

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

Bindar en funktion till en händelse. Funktionen anropas bara en gång för den första förekomsten av händelsen. Funktionen kan också anropas för den händelse som har inträffat tidigare, innan bindningen har upprättats.

Parametrar

  • namn: (String) händelsens namn som du binder funktionen till.

  • hanterare: (Funktion) Funktionen som ska bindas till händelsen.

  • väljare: (String) En unik identifierare för bindningen. Du behöver väljaren för att identifiera bindningen om du vill använda off funktionen för att ta bort bindningen.

  • triggerForPastEvents: (Boolean) Anger om hanteraren ska köras för händelser som har inträffat tidigare. Värdet för true anropar hanteraren för tidigare händelser. Värdet för false anropar hanteraren för framtida evenemang. Standardvärdet är true.

Returnerar

När triggerForPastEvents argument truereturnerar den här funktionen boolean värde som anger om händelsen har inträffat tidigare:

  • true: Händelsen inträffade tidigare och hanteraren anropas.
  • false: Händelsen har inte inträffat tidigare.

If triggerForPastEvents är falsereturnerar den här funktionen inget värde.

ContextHub.Utils.inheritance

En verktygsklass som gör att ett objekt kan ärva egenskaper och metoder för ett annat objekt.

Funktioner (ContextHub.Utils.arv)

inherit(child, parent)

Gör att ett objekt ärver egenskaper och metoder för ett annat objekt.

Parametrar

  • underordnad: (Objekt) Det objekt som ärver.
  • överordnad: (Object) Det objekt som definierar de egenskaper och metoder som ärvs.

ContextHub.Utils.JSON

Tillhandahåller funktioner för att serialisera objekt till JSON-format och deserialisera JSON-strängar till objekt.

Funktioner (ContextHub.Utils.JSON)

parse(data)

Tolkar ett strängvärde som JSON och konverterar det till ett javascript-objekt.

Parametrar

  • data: Ett strängvärde i JSON-format.

Returnerar

Ett JavaScript-objekt.

Exempel

Koden ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); returnerar följande objekt:

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

stringify(data)

Serialiserar JavaScript-värden och -objekt till strängvärden i JSON-format.

Parametrar

  • data: Värdet eller objektet som ska serialiseras. Den här funktionen stöder värden för booleskt värde, matris, tal, sträng och datum.

Returnerar

Det serialiserade strängvärdet. När data är ett R egExp returnerar den här funktionen ett tomt objekt. När data är en funktion, returnerar undefined.

Exempel

Följande kod returnerar "{'city':'Basel','country':'Switzerland','population':'173330'}":

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

ContextHub.Utils.JSON.tree

Den här klassen underlättar manipuleringen av dataobjekt som ska lagras eller hämtas från ContextHub-arkiv.

Funktioner (ContextHub.Utils.JSON.tree)

addAllItems()

Skapar en kopia av ett dataobjekt och lägger till dataträdet från ett andra objekt. Funktionen returnerar kopian och ändrar inte något av de ursprungliga objekten. När dataträden för de två objekten innehåller identiska nycklar skriver värdet för det andra objektet över värdet för det första objektet.

Parametrar

  • träd: Det objekt som kopieras.
  • secondTree: Det objekt som sammanfogas med kopian av tree -objekt.

Returnerar

Ett objekt som innehåller sammanfogade data.

cleanup()

Skapar en kopia av ett objekt, söker efter och tar bort objekt i dataträdet som inte innehåller några värden, null-värden eller odefinierade värden och returnerar kopian.

Parametrar

  • träd: Det objekt som ska rensas.

Returnerar

En kopia av trädet som är städat.

getItem()

Hämtar värdet från ett objekt för nyckeln.

Parametrar

  • träd: Dataobjektet.
  • nyckel: Nyckeln för värdet som du vill hämta.

Returnerar

Värdet som motsvarar nyckeln. När nyckeln har underordnade nycklar returnerar den här funktionen ett komplext objekt. När värdetypen för nyckeln är undefined, null returneras.

Exempel

Tänk på följande JavaScript-objekt:

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

Följande exempelkod returnerar värdet 260:

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

Följande exempelkod hämtar värdet för en nyckel som har underordnade nycklar:

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

Funktionen returnerar följande objekt:

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

getKeys()

Hämtar alla nycklar från ett objekts dataträd. Om du vill kan du bara hämta nycklarna för de underordnade nycklarna för en viss nyckel. Du kan också ange en sorteringsordning för de hämtade nycklarna.

Parametrar

  • träd: Det objekt som nycklarna för dataträdet ska hämtas från.
  • överordnad: (Valfritt) Nyckeln till ett objekt i dataträdet som du vill hämta nycklarna för de underordnade objekten för.
  • beställning: (Valfritt) En funktion som bestämmer sorteringsordningen för de returnerade tangenterna. (Se Array.prototype.sort på Mozilla Developer Network.)

Returnerar

En array med nycklar.

Exempel

Tänk på följande objekt:

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

The ContextHub.Utils.JSON.tree.getKeys(myObject); skriptet returnerar följande 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()

Skapar en kopia av ett givet objekt, tar bort den angivna grenen från dataträdet och returnerar den ändrade kopian.

Parametrar

  • träd: Ett dataobjekt.
  • nyckel: Nyckeln som ska tas bort.

Returnerar

En kopia av det ursprungliga dataobjektet där tangenten har tagits bort.

Exempel

Tänk på följande objekt:

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

Följande exempelskript tar bort grenen /en/två/tre/fyra från dataträdet:

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

Funktionen returnerar följande objekt:

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

sanitizeKey(key)

Ändrar strängvärden så att de kan användas som nycklar. Om du vill sanera en sträng utför den här funktionen följande åtgärder:

  • Minskar flera på varandra följande snedstreck till ett enda snedstreck.
  • Tar bort mellanrum från början och slutet av strängen.
  • Delar upp resultatet i en array med strängar som avgränsas av snedstreck.

Använd den resulterande arrayen för att skapa en användbar nyckel. Parametrar

  • nyckel: The string för att sanera.

Returnerar

En array med string värden där varje sträng är den del av key som avgränsades av snedstreck. representerar den sanerade nyckeln. Om den sanerade arrayen har längden noll returneras den här funktionen null.

Exempel

Följande kod sanerar en sträng för att skapa arrayen ["this", "is", "a", "path"]och sedan genererar nyckeln "/this/is/a/path" från arrayen:

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

setItem(tree, key, value)

Lägger till ett nyckel/värde-par i dataträdet för en kopia av ett objekt. Mer information om dataträd finns i Persistence.

Parametrar

  • träd: Ett dataobjekt.
  • nyckel: Den tangent som ska kopplas till värdet som du lägger till. Nyckeln är sökvägen till objektet i dataträdet. Detta funktionsanrop ContextHub.Utils.JSON.tree.sanitize om du vill rensa nyckeln innan du lägger till den.
  • värde: Värdet som ska läggas till i dataträdet.

Returnerar

En kopia av tree objekt som innehåller key/ value par.

Exempel

Tänk på följande JavaScript-kod:

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

Objektet myObject har följande värde:

ContextHub.Utils.storeCandidates

Här kan du registrera butikskandidater och få registrerade butikskandidater.

Funktioner (ContextHub.Utils.storeCandidates)

getRegisteredCandidates(storeType)

Returnerar de butikstyper som är registrerade som butikskandidater. Hämta antingen registrerade annulleringar av en viss butikstyp eller alla butikstyper.

Parametrar

Returnerar

Ett objekt av lagringstyper. Objektegenskaperna är lagringstypsnamnen och egenskapsvärdena är en array med registrerade lagringskandidater.

getStoreFromCandidates(storeType)

Returnerar en butikstyp från de registrerade anbudssökandena. Om mer än en lagringstyp med samma namn återställs returnerar funktionen den lagringstyp som har högst prioritet.

Parametrar

Returnerar

Ett objekt som representerar den registrerade butikskandidaten. Om den begärda lagringstypen inte har registrerats genereras ett fel.

getSupportedStoreTypes()

Returnerar namnen på de butikstyper som är registrerade som butikskandidater. Den här funktionen kräver inga parametrar.

Returnerar

En array med strängvärden, där varje sträng är den storetype som en lagringskandidat registrerades med. Se storeType parametern för ContextHub.Utils.storeCandidates.registerStoreCandidate funktion.

registerStoreCandidate(store, storeType, priority, apply)

Registrerar ett lagringsobjekt som ett arkivkandidat med ett namn och en prioritet.

Prioriteten är ett tal som anger vikten av butiker med samma namn. När en butikskandidat registreras med samma namn som en redan registrerad butikskandidat, används den som har den högre prioriteten. När du registrerar en butikskandidater registreras butiken endast om prioriteten är högre än de registrerade butikskandidaterna med samma namn.

Parametrar

  • butik: (Objekt) Det lagringsobjekt som ska registreras som lagringskandidater.
  • storeType: (String) Namnet på lagringskandidaten. Det här värdet krävs när du skapar en instans av lagringskandidaten.
  • prioritet: (Number) Prioriteten för butikskandidaten.
  • gäller: (Funktion) Funktionen som ska anropas som utvärderar butikens tillämplighet i den aktuella miljön. Funktionen måste returnera true om butiken är tillämplig, och false i annat fall. Standardvärdet är en funktion som returnerar true: function() {return true;}

Exempel

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);
Föregående sida
Nästa sida

Experience Manager