ContextHub JavaScript API Reference contexthub-javascript-api-reference

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

ContextHub-konstanter contexthub-constants

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

Händelsekonstanter event-constants

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

Konstanter för gränssnittshändelser ui-event-constants

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

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

ContextHub-objektet ger åtkomst till alla arkiv.

Funktioner (ContextHub) functions-contexthub

getAllStores() 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) getstore-name

Hämtar en butik som ett JavaScript-objekt.

Parametrar

Returnerar

Ett objekt som representerar butiken.

Exempel

I följande exempel hämtas geopositioneringsarkivet:

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

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

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

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

getName() getname

Returnerar segmentets namn som ett strängvärde.

getPath() getpath

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

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Ger åtkomst till ContextHub-segment.

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

getResolvedSegments() 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 contexthub-store-core

Basklassen för ContextHub-butiker.

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

eventera eventing

Ett 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 name

Butikens namn.

beständighet persistence

Ett ContextHub.Utils.Persistence-objekt. Mer information om standardvärde och initiering finns i [init(name,config)](https://experienceleague.adobe.com/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.html?lang=sv#init-name-config).

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

addAllItems(träd, alternativ) addallitems-tree-options

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

Observera att värden kan vara objekt.

Parametrar

Returnerar

Värdet boolean:

addReference(key, anotherKey) addreference-key-anotherkey

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

Parametrar

Returnerar

Värdet boolean:

announReadiness() announcereadiness

Startar ready-händelsen för den här butiken. Den här funktionen har inga parametrar och returnerar inget värde.

clear() clean

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

getItem(key) getitem-key

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

Parametrar

Returnerar

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

getKeys(includeInternals) getkeys-includeinternals

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

Parametrar

Returnerar

En array med nyckelnamn ( string värden).

getReferences() getreferences

Hämtar referenserna från butiken.

Returnerar

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

getTree(includeInternals) 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

Returnerar

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

init(name, config) init-name-config

Initierar butiken.

Parametrar

isEventingPaused() iseventingpaused

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

Returnerar

Boolesk:

pauseEventing() 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) removeitem-key-options

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

När en tangent tas bort utlöser funktionen händelsen data. 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 också förhindra att händelsen data aktiveras.

Parametrar

Returnerar

Värdet boolean:

removeReference(key) removereference-key

Tar bort en referens från arkivet.

Parametrar

Returnerar

Värdet boolean:

reset(keepRemainingData) 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

Å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

resolveReference(key, retry) 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

Returnerar

Ett string-värde som representerar den refererade nyckeln. Om ingen referens matchas returneras värdet för parametern key.

resumeEventing() 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) setitem-key-value-options

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

Startar bara data-händelsen om värdet för nyckeln skiljer sig från värdet som för närvarande lagras för nyckeln. Du kan också förhindra utlösaren av data-händelsen.

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

Parametrar

Returnerar

Värdet boolean:

ContextHub.Store.JSONPStore 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 funktionen init när du skapar en instans av den här klassen.

Butiken använder In-Memory Persiststance (JavaScript variable). Lagringsdata är bara tillgängliga under sidans livstid.

ContextHub.Store.JSONPStore utökar ContextHub.Store.Core och ärver funktionerna för den klassen.

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

configureService(serviceConfig, override) 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

getRawResponse() 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() 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änst-URL:en.

Returnerar

Ett objekt med följande egenskaper:

getServiceURL(resolve) getserviceurl-resolve

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

Parametrar

Returnerar

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

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

initierar ContextHub.Store.JSONPStore-objektet.

Parametrar

queryService(reload) queryservice-reload

Frågar fjärrtjänsten JSONP och cachelagrar svaret. Om tiden sedan det föregående anropet till den här funktionen är mindre än värdet config.service.ttl anropas inte tjänsten och det cachelagrade svaret ändras inte. Du kan också tvinga tjänsten att anropas. Egenskapen config.service.ttl anges när funktionen init anropas 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

återställ reset

Å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

resolveParameter(f) resolveparameter-f

Matchar den angivna parametern.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore utökar ContextHub.Store.JSONPStore så att 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 Persistenslägen.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore utökar ContextHub.Store.Core så att 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

ContextHub.Store.SessionStore utökar ContextHub.Store.Core så att den ärver alla funktioner i den klassen. Data i det här arkivet sparas med InMemory Perstance (JavaScript-objekt).

ContextHub.UI contexthub-ui

Hanterar gränssnittsmoduler och gränssnittsmodulrenderare.

Funktioner (ContextHub.UI) functions-contexthub-ui

registerRenderer(moduleType, renderer, dontRender) 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 utökar ContextHub.UI.BaseModuleRenderer för att skapa en anpassad renderare för användargränssnittsmodul.

Parametrar

Exempel

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

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

ContextHub.Utils.Cookie contexthub-utils-cookie

En verktygsklass för interaktion med cookies.

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

exists(key) exists-key

Avgör om det finns en cookie.

Parametrar

Returnerar

Värdet boolean är true och anger att cookien finns.

Exempel

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

getAllItems(filter) getallitems-filter

Returnerar alla cookies som har nycklar som matchar ett filter.

Parametrar

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) getitem-key-1

Returnerar ett cookie-värde.

Parametrar

Returnerar

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

Exempel

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

getKeys(filter) getkeys-filter

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

Parametrar

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) removeitem-key-options-1

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

Returnerar

Den här funktionen returnerar inget värde.

Exempel

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

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

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

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) vanish-filter-options

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

Parametrar

Returnerar

Den här funktionen returnerar inget värde.

ContextHub.Utils.Eventing 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 egenskapen eventing för arkivet.

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

off(name, selector) off-name-selector

Avbinder en funktion från en händelse.

Parametrar

Returnerar

Den här funktionen returnerar inget värde.

on(name, handler, selector, triggerForPastEvents) 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

Returnerar

När argumentet triggerForPastEvents är true returnerar den här funktionen ett boolean-värde som anger om händelsen har inträffat tidigare:

Om triggerForPastEvents är false returnerar 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) 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

Returnerar

När argumentet triggerForPastEvents är true returnerar den här funktionen ett boolean-värde som anger om händelsen har inträffat tidigare:

Om triggerForPastEvents är false returnerar den här funktionen inget värde.

ContextHub.Utils.inheritance 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) functions-contexthub-utils-inheritance

inherit(child, parent) inherit-child-parent

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

Parametrar

ContextHub.Utils.JSON 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) functions-contexthub-utils-json

parse(data) parse-data

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

Parametrar

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

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

Parametrar

Returnerar

Det serialiserade strängvärdet. När data är ett R egExp-värde returnerar den här funktionen ett tomt objekt. Returnerar undefined när data är en funktion.

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 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) functions-contexthub-utils-json-tree

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

Returnerar

Ett objekt som innehåller sammanfogade data.

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

Returnerar

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

getItem() getitem

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

Parametrar

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 returneras null.

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

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

Skriptet ContextHub.Utils.JSON.tree.getKeys(myObject); 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() removeitem

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

Parametrar

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

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

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 returnerar funktionen null.

Exempel

Följande kod sanerar en sträng för att skapa arrayen ["this", "is", "a", "path"] och genererar sedan 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) 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

Returnerar

En kopia av objektet tree som innehåller paret key/ value.

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 contexthub-utils-storecandidates

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

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

getRegisteredCandidates(storeType) 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) getstorefromcandidates-storetype

Returnerar en butikstyp från de registrerade anbudssökande. 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() 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 parametern storeType för funktionen ContextHub.Utils.storeCandidates.registerStoreCandidate.

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

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

Exempel

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