JavaScript-API för klientkontext

CQ_Analytics.ClientContextMgr

Objektet CQ_Analytics.ClientContextMgr är en singleton som innehåller en uppsättning självregistrerade sessionsarkiv och innehåller metoder för att registrera, behålla och hantera sessionsarkiv.

Utökar CQ_Analytics.PersistedSessionStore.

Metoder

getRegisteredStore(name)

Returnerar ett sessionsarkiv med ett angivet namn. Se även Åtkomst till ett sessionsarkiv.

Parametrar

  • namn: Sträng. Namnet på sessionsarkivet.

Returnerar

Ett CQ_Analytics.SessionStore-objekt som representerar sessionsarkivet för det angivna namnet. Returnerar null när det inte finns något arkiv med det angivna namnet.

register(sessionstore)

Registrerar ett sessionsarkiv med klientkontext. Aktiverar händelserna storeregister och storeupdate när de är klara.

Parametrar

  • sessionstore: CQ_Analytics.SessionStore. Det sessionsarkivobjekt som ska registreras.

Returnerar

Inget returvärde.

CQ_Analytics.ClientContextUtils

Innehåller metoder för avlyssning av aktivering och registrering av sessionsarkiv. Se även Kontrollera att ett sessionsarkiv är definierat och initierat.

Metoder

onStoreInitialized(storeName, callback, delay)

Registrerar en callback-funktion som anropas när ett sessionsarkiv initieras. För butiker som initieras flera gånger anger du en återkopplingsfördröjning så att återanropsfunktionen bara anropas en gång:

  • När arkivet initieras under fördröjningsperioden för en tidigare initiering avbryts det föregående funktionsanropet och funktionen anropas igen för den aktuella initieringen.
  • Om fördröjningsperioden utgår innan en efterföljande initiering inträffar, körs callback-funktionen två gånger.

Ett sessionsarkiv är till exempel baserat på ett JSON-objekt och hämtas via en JSON-begäran. Följande initieringsscenarier är möjliga:

  • Begäran har slutförts, data har hämtats och lästs in i arkivet. I det här fallet sker initieringen en gång.
  • Begäran misslyckas (timeout). I det här fallet sker ingen initiering och det finns inga data i arkivet.
  • Butiken är förifylld med standardvärden (init-egenskaper), men begäran misslyckas (timeout). Det finns bara en initiering med standardvärden.
  • Butiken är förifylld.

När fördröjningen är inställd på true eller ett antal millisekunder väntar metoden innan callback-metoden anropas. Om en annan initieringshändelse utlöses innan fördröjningen skickas, väntar den tills fördröjningstiden överskrids utan någon initieringshändelse. Detta gör att det går att vänta på att en andra initieringshändelse ska utlösas och anropar callback-funktionen i det mest optimala fallet.

Parametrar

  • storeName: Sträng. Namnet på det sessionsarkiv som avlyssnaren ska läggas till i.
  • callback: Funktion. Funktionen som ska anropas vid arkivinitiering.
  • fördröjning: Boolean eller Number. Den tid i millisekunder som anropet till återanropsfunktionen ska fördröjas. Ett booleskt värde på true använder standardfördröjningen 200 ms. Ett booleskt värde på false eller ett negativt tal orsakar ingen fördröjning.

Returnerar

Inget returvärde.

onStoreRegistered(storeName, callback)

Registrerar en callback-funktion som anropas när ett sessionsarkiv registreras. Registreringshändelsen inträffar när ett arkiv registreras för CQ_Analytics.ClientContextMgr.

Parametrar

  • storeName: Sträng. Namnet på det sessionsarkiv som avlyssnaren ska läggas till i.
  • callback: Funktion. Funktionen som ska anropas vid arkivinitiering.

Returnerar

Inget returvärde.

CQ_Analytics.JSONPStore

Ett icke-beständigt sessionsarkiv som innehåller JSON-data. Data hämtas från en extern JSONP-tjänst. Använd metoden getInstance eller getRegisteredInstance för att skapa en instans av den här klassen.

Utökar CQ_Analytics.JSONStore.

Egenskaper

Se CQ_Analytics.JSONStore och CQ_Analytics.SessionStore för ärvda egenskaper.

Metoder

Se även CQ_Analytics.JSONStore och CQ_Analytics.SessionStore för ärvda metoder.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback)

Skapar ett CQ_Analytics.JSONPStore-objekt.

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler. Om inget storeName anges returnerar metoden null.
  • serviceURL: Sträng. URL:en för JSONP-tjänsten
  • dynamicData: (Valfritt) Objekt. JSON-data som ska läggas till i butikens initieringsdata innan callback-funktionen anropas.
  • deferLoading: (Valfritt) Boolean. Värdet true förhindrar att JSONP-tjänsten anropas när objekt skapas. Värdet false gör att JSONP-tjänsten anropas.
  • loadingCallback: (Valfritt) Sträng. Namnet på den funktion som ska anropas för bearbetning av JSONP-objektet som JSONP-tjänsten returnerar. Callback-funktionen måste definiera en enda parameter som är ett CQ_Analytics.JSONPStore-objekt.

Returnerar

Det nya CQ_Analytics.JSONPStore-objektet eller null om storeName är null.

getServiceURL()

Hämtar URL:en för den JSONP-tjänst som det här objektet använder för att hämta JSON-data.

Parametrar

Inget.

Returnerar

En sträng som representerar tjänst-URL:en, eller null om ingen tjänst-URL har konfigurerats.

load(serviceURL, dynamicData, callback)

Anropar JSONP-tjänsten. JSONP-URL:en är den tjänst-URL som har suffixet ett namn på en återanropsfunktion.

Parametrar

  • serviceURL: (Valfritt) Sträng. JSONP-tjänsten att ringa. Värdet null gör att den redan konfigurerade tjänst-URL:en används. Ett värde som inte är null anger JSONP-tjänsten som ska användas för det här objektet. (Se setServiceURL.)
  • dynamicData: (Valfritt) Objekt. JSON-data som ska läggas till i butikens initieringsdata innan callback-funktionen anropas.
  • callback: (Valfritt) Sträng. Namnet på den funktion som ska anropas för bearbetning av JSONP-objektet som JSONP-tjänsten returnerar. Callback-funktionen måste definiera en enda parameter som är ett CQ_Analytics.JSONPStore-objekt.

Returnerar

Inget returvärde.

registerNewInstance(storeName, serviceURL, dynamicData, callback)

Skapar ett CQ_Analytics.JSONPStore-objekt och registrerar arkivet med Client Context.

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler. Om inget storeName anges returnerar metoden null.
  • serviceURL: (Valfritt) Sträng. URL:en för JSONP-tjänsten.
  • dynamicData: (Valfritt) Objekt. JSON-data som ska läggas till i butikens initieringsdata innan callback-funktionen anropas.
  • callback: (Valfritt) Sträng. Namnet på den funktion som ska anropas för bearbetning av JSONP-objektet som JSONP-tjänsten returnerar. Callback-funktionen måste definiera en enda parameter som är ett CQ_Analytics.JSONPStore-objekt.

Returnerar

Det registrerade CQ_Analytics.JSONPStore-objektet.

setServiceURL(serviceURL)

Anger URL:en för JSONP-tjänsten som ska användas för att hämta JSON-data.

Parametrar

  • serviceURL: Sträng. URL:en för JSONP-tjänsten som tillhandahåller JSON-data

Returnerar

Inget returvärde.

CQ_Analytics.JSONStore

En behållare för ett JSON-objekt. Skapa en instans av den här klassen för att skapa ett icke-beständigt sessionsarkiv som innehåller JSON-data:

myjsonstore = new CQ_Analytics.JSONStore

Du kan definiera en uppsättning data som fyller i arkivet vid initieringen.

Utökar CQ_Analytics.SessionStore.

Egenskaper

STOREKEY

Nyckeln som identifierar butiken. Använd metoden getInstance för att hämta det här värdet.

STORENAME

Butikens namn. Använd metoden getInstance för att hämta det här värdet.

Metoder

Se även CQ_Analytics.SessionStore för ärvda metoder.

clear()

Tar bort sessionsarkivdata och tar bort alla initieringsegenskaper.

Parametrar

Inget.

Returnerar

Inget returvärde.

getInstance(storeName, jsonData)

Skapar ett CQ_Analytics.JSONStore-objekt med ett angivet namn och initieras med angivna JSON-data (anropar metoden initJSON).

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler.
  • jsonData: Objekt. Ett objekt som innehåller JSON-data.

Returnerar

CQ_Analytics.JSONStore-objektet.

getJSON()

Hämtar data för sessionsarkivet i JSON-format.

Parametrar

Inget.

Returnerar

Ett objekt som representerar lagringsdata i JSON-format.

init()

Rensar sessionsarkivet och initierar det med initieringsegenskapen. Anger initieringsflaggan som true och utlöser sedan händelserna initialize och update.

Parametrar

Inget.

Returnerar

Inga returnerade data.

initJSON(jsonData, doNotClear)

Skapar initieringsegenskaper från data i ett JSON-objekt. Du kan också ta bort alla befintliga initieringsegenskaper.

Egenskapernas namn härleds från datahierarkin i JSON-objektet. Följande exempelkod representerar ett JSON-objekt:

{
A: "valueA",
B: {
     B1: "valueBB1"
    }
}

I det här exemplet skapas följande egenskaper i arkivet:

A: "valueA"
B/B1: "valueBB1"

Parametrar

  • jsonData: Ett JSON-objekt som innehåller de data som ska lagras.
  • doNotClear: Värdet true bevarar de befintliga initieringsegenskaperna och lägger till dem som härletts från JSON-objektet. Värdet false tar bort befintliga initieringsegenskaper innan de som härletts från JSON-objektet läggs till.

Returnerar

Inget returvärde.

registerNewInstance(storeName, jsonData)

Skapar ett CQ_Analytics.JSONStore-objekt med ett angivet namn och initieras med angivna JSON-data (anropar metoden initJSON). Det nya objektet registreras automatiskt med Clickstream Cloud Manager.

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler.
  • jsonData: Objekt. Ett objekt som innehåller JSON-data.

Returnerar

CQ_Analytics.JSONStore-objektet.

CQ_Analytics.Observable

Utlöser händelser och tillåter andra objekt att lyssna på dessa händelser och reagera. Klasser som utökar den här klassen kan utlösa händelser som gör att avlyssnare anropas.

Metoder

addListener(event, fct, scope)

Registrerar en avlyssnare för en händelse. Se även Skapa en avlyssnare för att reagera på en sessionsarkivuppdatering.

Parametrar

  • händelse: Sträng. Namnet på händelsen som ska avlyssnas.
  • fct: Funktion. Den funktion som anropas när händelsen inträffar.
  • omfång: (Valfritt) Objekt. Det omfång som hanterarfunktionen ska köras i. Hanterarfunktionens kontext "this".

Returnerar

Inget returvärde.

removeListener(event, fct)

Tar bort den angivna händelsehanteraren för en händelse.

Parametrar

  • händelse: Sträng. Namnet på händelsen.
  • fct: Funktion. Händelsehanteraren.

Returnerar

Inget returvärde.

CQ_Analyics.PersistedJSONPStore

En beständig behållare för ett JSON-objekt som hämtats från en fjärr-JSONP-tjänst.

Utökar CQ_Analytics.PersistedJSONStore.

Metoder

Se även CQ_Analytics.PersistedJSONStore för ärvda metoder.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback)

Skapar ett CQ_Analytics.PersistedJSONPStore-objekt.

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler. Om inget storeName anges returnerar metoden null.
  • serviceURL: Sträng. URL:en för JSONP-tjänsten
  • dynamicData: (Valfritt) Objekt. JSON-data som ska läggas till i butikens initieringsdata innan callback-funktionen anropas.
  • deferLoading: (Valfritt) Boolean. Värdet true förhindrar att JSONP-tjänsten anropas när objekt skapas. Värdet false gör att JSONP-tjänsten anropas.
  • loadingCallback: (Valfritt) Sträng. Namnet på den funktion som ska anropas för bearbetning av JSONP-objektet som JSONP-tjänsten returnerar. Callback-funktionen måste definiera en enda parameter som är ett CQ_Analytics.JSONPStore-objekt.

Returnerar

Det nya CQ_Analytics.PersistedJSONPStore-objektet eller null om storeName är null.

getServiceURL()

Hämtar URL:en för den JSONP-tjänst som det här objektet använder för att hämta JSON-data.

Parametrar

Inget.

Returnerar

En sträng som representerar tjänst-URL:en, eller null om ingen tjänst-URL har konfigurerats.

load(serviceURL, dynamicData, callback)

Anropar JSONP-tjänsten. JSONP-URL:en är den tjänst-URL som har suffixet ett namn på en återanropsfunktion.

Parametrar

  • serviceURL: (Valfritt) Sträng. JSONP-tjänsten att ringa. Värdet null gör att den redan konfigurerade tjänst-URL:en används. Ett värde som inte är null anger JSONP-tjänsten som ska användas för det här objektet. (Se setServiceURL.)
  • dynamicData: (Valfritt) Objekt. JSON-data som ska läggas till i butikens initieringsdata innan callback-funktionen anropas.
  • callback: (Valfritt) Sträng. Namnet på den funktion som ska anropas för bearbetning av JSONP-objektet som JSONP-tjänsten returnerar. Callback-funktionen måste definiera en enda parameter som är ett CQ_Analytics.JSONPStore-objekt.

Returnerar

Inget returvärde.

registerNewInstance(storeName, serviceURL, dynamicData, callback)

Skapar ett CQ_Analytics.PersistedJSONPStore-objekt och registrerar arkivet med Client Context.

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler. Om inget storeName anges returnerar metoden null.
  • serviceURL: (Valfritt) Sträng. URL:en för JSONP-tjänsten.
  • dynamicData: (Valfritt) Objekt. JSON-data som ska läggas till i butikens initieringsdata innan callback-funktionen anropas.
  • callback: (Valfritt) Sträng. Namnet på den funktion som ska anropas för bearbetning av JSONP-objektet som JSONP-tjänsten returnerar. Callback-funktionen måste definiera en enda parameter som är ett CQ_Analytics.JSONPStore-objekt.

Returnerar

Det registrerade CQ_Analytics.PersistedJSONPStore-objektet.

setServiceURL(serviceURL)

Anger URL:en för JSONP-tjänsten som ska användas för att hämta JSON-data.

Parametrar

  • serviceURL: Sträng. URL:en för JSONP-tjänsten som tillhandahåller JSON-data

Returnerar

Inget returvärde.

CQ_Analytics.PersistedJSONStore

En beständig behållare för ett JSON-objekt.

Utökar CQ_Analytics.PersistedSessionStore.

Egenskaper

STOREKEY

Nyckeln som identifierar butiken. Använd metoden getInstance för att hämta det här värdet.

STORENAME

Butikens namn. Använd metoden getInstance för att hämta det här värdet.

Metoder

Se även CQ_Analytics.PersistedSessionStore för ärvda metoder.

getInstance(storeName, jsonData)

Skapar ett CQ_Analytics.PersistedJSONStore-objekt med ett givet namn och initieras med angivna JSON-data (anropar metoden initJSON).

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler.
  • jsonData: Objekt. Ett objekt som innehåller JSON-data.

Returnerar

CQ_Analytics.PersistedJSONStore-objektet.

getJSON()

Hämtar data för sessionsarkivet i JSON-format.

Parametrar

Inget.

Returnerar

Ett objekt som representerar lagringsdata i JSON-format.

initJSON(jsonData, doNotClear)

Skapar initieringsegenskaper från data i ett JSON-objekt. Du kan också ta bort alla befintliga initieringsegenskaper.

Egenskapernas namn härleds från datahierarkin i JSON-objektet. Följande exempelkod representerar ett JSON-objekt:

{
A: "valueA",
B: {
     B1: "valueBB1"
    }
}

I det här exemplet skapas följande egenskaper i arkivet:

A: "valueA"
B/B1: "valueBB1"

Parametrar

  • jsonData: Ett JSON-objekt som innehåller de data som ska lagras.
  • doNotClear: Värdet true bevarar de befintliga initieringsegenskaperna och lägger till dem som härletts från JSON-objektet. Värdet false tar bort befintliga initieringsegenskaper innan de som härletts från JSON-objektet läggs till.

Returnerar

Inget returvärde.

registerNewInstance(storeName, jsonData)

Skapar ett CQ_Analytics.PersistedJSONStore-objekt med ett givet namn och initieras med angivna JSON-data (anropar metoden initJSON). Det nya objektet registreras automatiskt med Client Context Manager.

Parametrar

  • storeName: Sträng. Namnet som ska användas som STORENAME-egenskap. Värdet för egenskapen STOREKEY anges till storeName med alla versaler.
  • jsonData: Objekt. Ett objekt som innehåller JSON-data.

Returnerar

CQ_Analytics.PersistedJSONStore-objektet.

CQ_Analytics.PersistedSessionStore

En behållare med egenskaper och värden. Data sparas med CQ_Analytics.SessionPersistence. Skapa en instans av den här klassen för att skapa ett beständigt sessionsarkiv:

mypersistedstore = new CQ_Analytics.PersistedSessionStore

Utökar CQ_Analytics.SessionStore.

Egenskaper

STOREKEY

Standardvärdet är key.

Metoder

Se CQ_Analytics.SessionStore för ärvda metoder.

När de ärvda metoderna clear, setProperty, setProperties, removeProperty används för att ändra lagringsdata, sparas ändringarna automatiskt om inte de ändrade egenskaperna flaggas som notPersisted.

getStoreKey()

Hämtar egenskapen STOREKEY.

Parametrar

Inget

Returnerar

Värdet för egenskapen STOREKEY.

isPersisted(name)

Avgör om en dataegenskap är beständig.

Parametrar

  • namn: Sträng. Egenskapens namn.

Returnerar

Ett booleskt värde på true om egenskapen är beständig och värdet false om värdet inte är en beständig egenskap.

persist()

Innehåller sessionsarkivet. Standardbeständighetsläget använder webbläsaren localStorage med ClientSidePersistence som namn ( window.localStorage.set("ClientSidePersistance", store);)

Om localStorage inte är tillgängligt eller skrivbart sparas arkivet som en egenskap i fönstret.

Utlöser händelsen persist när den har slutförts.

Parametrar

Inget

Returnerar

Inget returvärde.

reset(deferEvent)

Tar bort alla dataegenskaper från arkivet och sparar arkivet. Alternativt utlöses inte händelsen udpate när den har slutförts.

Parametrar

  • deferEvent: Värdet true förhindrar att update-händelsen utlöses. Värdet false utlöser update-händelsen.

Returnerar

Inget returvärde.

setNonPersisted(name)

Flaggar en dataegenskap som inte beständig.

Parametrar

  • namn: Sträng. Namnet på den egenskap som inte ska bevaras.

Returnerar

Inget returvärde.

CQ_Analytics.SessionStore

CQ_Analytics.SessionStore representerar ett sessionsarkiv. Skapa en instans av den här klassen för att skapa ett sessionsarkiv:

mystore = new CQ_Analytics.SessionStore

Utökar CQ_Analytics.Observable.

Egenskaper

STORENAME

Namnet på sessionsarkivet. Använd getName för att hämta värdet för den här egenskapen.

Metoder

addInitProperty(name, value)

Lägger till en egenskap och ett värde i initieringsdata för sessionsarkivet.

Använd loadInitProperties för att fylla i sessionsarkivdata med initieringsvärden.

Parametrar

  • namn: Sträng. Namnet på egenskapen som ska läggas till.
  • värde: Sträng. Värdet på egenskapen som ska läggas till.

Returnerar

Inget returvärde.

clear()

Tar bort alla dataegenskaper från arkivet.

Parametrar

Inget.

Returnerar

Inget returvärde.

getData(exclude)

Returnerar lagringsdata. Namnegenskaperna kan också utelämnas från data. Anropar metoden init om egenskapen data för arkivet inte finns.

Parametrar

exkluderade: (Valfritt) En array med egenskapsnamn som ska uteslutas från returnerade data.

Returnerar

Ett objekt med egenskaper och deras värden.

getInitProperty(name)

Hämtar värdet för en data-egenskap.

Parametrar

  • namn: Sträng. Namnet på den dataegenskap som ska hämtas.

Returnerar

Värdet för egenskapen data. Returnerar null om sessionsarkivet inte innehåller någon egenskap med det angivna namnet.

getName()

Returnerar namnet på sessionsarkivet.

Parametrar

Inget.

Returnerar

Ett String-värde som representerar butiksnamnet.

getProperty(name, raw)

Returnerar värdet för en egenskap. Värdet returneras som raw-egenskapen eller det XSS-filtrerade värdet. Anropar metoden init om egenskapen data för arkivet inte finns.

Parametrar

  • namn: Sträng. Namnet på den dataegenskap som ska hämtas.
  • råformat: Boolean. Värdet true gör att raw-egenskapsvärdet returneras. Värdet false gör att det returnerade värdet XSS-filtreras.

Returnerar

Värdet för egenskapen data.

getPropertyNames(exclude)

Returnerar namnen på de egenskaper som sessionsarkivet innehåller. Anropar metoden init om egenskapen data för arkivet inte finns.

Parametrar

exkluderade: (Valfritt) En array med egenskapsnamn som ska utelämnas från resultatet.

Returnerar

En array med strängvärden som representerar sessionsegenskapsnamnen.

getSessionStore()

Returnerar det sessionsarkiv som är kopplat till det aktuella objektet.

Parametrar

Inget.

Returnerar

this

init()

Markerar arkivet som initierat och utlöser händelsen initialize.

Parametrar

Inget.

Returnerar

Inget returvärde.

isInitialized()

Anger om sessionslagringen har initierats.

Parametrar

Inget.

Returnerar

Värdet true om arkivet har initierats och värdet false om arkivet inte har initierats.

loadInitProperties(obj, setValues)

Lägger till egenskaperna för ett givet objekt i sessionsarkivets initieringsdata. Om du vill kan du även lägga till objektdata i lagringsdata.

Parametrar

  • obj: Ett objekt som innehåller uppräkningsbara egenskaper.
  • setValues: Om värdet är true läggs obj-egenskaperna till i sessionsarkivets data om arkivdata inte redan innehåller en egenskap med samma namn. Om värdet är false läggs inga data till i sessionsarkivdata.

Returnerar

Inget returvärde.

removeProperty(name)

Tar bort en egenskap från sessionsarkivet. Utlöser händelsen update när den har slutförts. Anropar metoden init om egenskapen data för arkivet inte finns.

Parametrar

  • namn: Sträng. Namnet på egenskapen som ska tas bort.

Returnerar

Inget returvärde.

reset()

Återställer de ursprungliga värdena för datalagret. Standardimplementeringen tar helt enkelt bort alla data. Utlöser händelsen update när den har slutförts.

Parametrar

Inget.

Returnerar

Inget returvärde.

setProperties(properties)

Anger värden för flera egenskaper. Utlöser händelsen update när den har slutförts. Anropar metoden init om egenskapen data för arkivet inte finns.

Parametrar

  • Egenskaper: Objekt. Ett objekt som innehåller uppräkningsbara egenskaper. Varje egenskapsnamn och värde läggs till i arkivet.

Returnerar

Inget returvärde.

setProperty(name, value)

Anger värdet för en egenskap. Utlöser händelsen update när den har slutförts. Anropar metoden init om egenskapen data för arkivet inte finns.

Parametrar

  • namn: Sträng. Egenskapens namn.
  • värde: Sträng. Egenskapsvärde.

Returnerar

Inget returvärde.

På denna sida