JavaScript-API voor clientcontext client-context-javascript-api

CQ_Analytics.ClientContextMgr cq-analytics-clientcontextmgr

Het object CQ_Analytics.ClientContextMgr is een singleton dat een set zelfgeregistreerde sessiewinkels bevat en methoden biedt voor het registreren, voortzetten en beheren van de sessiewinkels.

Breidt CQ_Analytics.PersistedSessionStore uit.

Methoden methods

getRegisteredStore(name) getregisteredstore-name

Retourneert een sessiearchief met een opgegeven naam. Zie ook Een sessiewinkel openen.

Parameters

Retourneert

Een CQ_Analytics.SessionStore-object dat de zittingsopslag van de opgegeven naam vertegenwoordigt. Retourneert null als er geen opslagplaats met de opgegeven naam bestaat.

register(sessionstore) register-sessionstore

Registreert een zittingsopslag met de Context van de Cliënt. Hiermee worden gebeurtenissen in het opslagregister en de opslagperiode na voltooiing geactiveerd.

Parameters

Retourneert

Geen geretourneerde waarde.

CQ_Analytics.ClientContextUtils cq-analytics-clientcontextutils

Verstrekt methodes om op de activering en registratie van de zittingsopslag te luisteren. Zie ook Controleren of een Sessiewinkel is gedefinieerd en geïnitialiseerd.

Methoden methods-1

onStoreInitialized(storeName, callback, delay) onstoreinitialized-storename-callback-delay

Registreert een callback functie die wordt geroepen wanneer een zittingsopslag wordt geïnitialiseerd. Voor opslag die verscheidene tijden worden geïnitialiseerd, specificeer een callback vertraging zodat de callback functie slechts eenmaal wordt geroepen:

Een sessiewinkel is bijvoorbeeld gebaseerd op een JSON-object en opgehaald via een JSON-aanvraag. De volgende initialisatiescenario's zijn mogelijk:

Wanneer de vertraging is ingesteld op true Voor een aantal milliseconden, wacht de methode alvorens de callback methode te roepen. Als een andere initialisatiegebeurtenis wordt geactiveerd voordat de vertraging wordt doorgegeven, wordt gewacht totdat de vertragingstijd is overschreden zonder initialisatiegebeurtenis. Dit laat het wachten op een tweede initialiseringsgebeurtenis toe om worden teweeggebracht en roept de callback functie in het meest optimale geval.

Parameters

Retourneert

Geen geretourneerde waarde.

onStoreRegistered(storeName, callback) onstoreregistered-storename-callback

Registreert een callback functie die wordt geroepen wanneer een zittingsopslag wordt geregistreerd. De gebeurtenis register vindt plaats wanneer een winkel is geregistreerd bij CQ_Analytics.ClientContextMgr.

Parameters

Retourneert

Geen geretourneerde waarde.

CQ_Analytics.JSONPStore cq-analytics-jsonpstore

Een niet-voortgezette sessiewinkel die JSON-gegevens bevat. De gegevens worden teruggewonnen van de externe dienst JSONP. Gebruik de getInstance of getRegisteredInstance methode om een instantie van deze klasse te maken.

Breidt CQ_Analytics.JSONStore uit.

Eigenschappen properties

Zie CQ_Analytics.JSONStore en CQ_Analytics.SessonStore voor geërfte eigenschappen.

Methoden methods-2

Zie ook CQ_Analytics.JSONStore en CQ_Analytics.SessonStore voor geërfte methodes.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback) getinstance-storename-serviceurl-dynamicdata-deferloading-loadingcallback

Maakt een CQ_Analytics.JSONPStore-object.

Parameters

Retourneert

Het nieuwe object CQ_Analytics.JSONPStore of null als storeName null is.

getServiceURL() getserviceurl

Hiermee wordt de URL opgehaald van de JSONP-service die dit object gebruikt om JSON-gegevens op te halen.

Parameters

Geen.

Retourneert

Een tekenreeks die de service-URL vertegenwoordigt, of null als er geen service-URL is geconfigureerd.

load(serviceURL, dynamicData, callback) load-serviceurl-dynamicdata-callback

Roept de dienst JSONP aan. JSONP URL is de dienst URL die met een bepaalde callback functienaam wordt achtervoegd.

Parameters

Retourneert

Geen geretourneerde waarde.

registerNewInstance(storeName, serviceURL, dynamicData, callback) registernewinstance-storename-serviceurl-dynamicdata-callback

Maakt een CQ_Analytics.JSONPStore-object en registreert de winkel met Client-context.

Parameters

Retourneert

Het geregistreerde object CQ_Analytics.JSONPStore.

setServiceURL(serviceURL) setserviceurl-serviceurl

Plaatst URL van de dienst JSONP voor het terugwinnen van JSON- gegevens te gebruiken.

Parameters

Retourneert

Geen geretourneerde waarde.

CQ_Analytics.JSONStore cq-analytics-jsonstore

Een container voor een JSON-object. Maak een instantie van deze klasse om een niet-voortgezette sessiewinkel te maken die JSON-gegevens bevat:

myjsonstore = new CQ_Analytics.JSONStore

U kunt een reeks gegevens bepalen die de opslag bij initialisatie bevolkt.

Breidt CQ_Analytics.SessionStore uit.

Eigenschappen properties-1

STOREKEY storekey

De sleutel die de opslag identificeert. Gebruik de getInstance methode om deze waarde op te halen.

STORENAME storename

De naam van de winkel. Gebruik de getInstance methode om deze waarde op te halen.

Methoden methods-3

Zie ook CQ_Analytics.SessionStore voor overerfde methoden.

clear() clear

Verwijdert de gegevens van de zittingsopslag en verwijdert alle initialiseringseigenschappen.

Parameters

Geen.

Retourneert

Geen geretourneerde waarde.

getInstance(storeName, jsonData) getinstance-storename-jsondata

Maakt een CQ_Analytics.JSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan).

Parameters

Retourneert

Het object CQ_Analytics.JSONStore.

getJSON() getjson

Haalt de gegevens van de sessieopslag op in JSON-indeling.

Parameters

Geen.

Retourneert

Een object dat de opslaggegevens in JSON-indeling vertegenwoordigt.

init() init

Wist de zittingsopslag en initialiseert het met het initialiseringsbezit. Hiermee wordt de initialisatiemarkering ingesteld op true en dan de initialize en update gebeurtenissen.

Parameters

Geen.

Retourneert

Geen geretourneerde gegevens.

initJSON(jsonData, doNotClear) initjson-jsondata-donotclear

Maakt initialisatie-eigenschappen van de gegevens in een JSON-object. U kunt desgewenst alle bestaande initialisatie-eigenschappen verwijderen.

De namen van de eigenschappen worden afgeleid van de hiërarchie van de gegevens in het JSON-object. De volgende voorbeeldcode vertegenwoordigt een JSON-object:

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

In dit voorbeeld worden de volgende eigenschappen gemaakt in de winkel:

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

Parameters

Retourneert

Geen geretourneerde waarde.

registerNewInstance(storeName, jsonData) registernewinstance-storename-jsondata

Maakt een CQ_Analytics.JSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan). Het nieuwe object wordt automatisch geregistreerd bij Clickstream Cloud Manager.

Parameters

Retourneert

Het object CQ_Analytics.JSONStore.

CQ_Analytics.Observable cq-analytics-observable

Hiermee worden gebeurtenissen geactiveerd en kunnen andere objecten naar deze gebeurtenissen luisteren en reageren. Klassen die deze klasse uitbreiden, kunnen gebeurtenissen doorlopen waardoor listeners worden aangeroepen.

Methoden methods-4

addListener (gebeurtenis, effect, bereik) addlistener-event-fct-scope

Registreert een listener voor een gebeurtenis. Zie ook Listener maken om te reageren op een update voor een sessiewinkel.

Parameters

Retourneert

Geen geretourneerde waarde.

removeListener (gebeurtenis, fct) removelistener-event-fct

Verwijdert de opgegeven gebeurtenishandler voor een gebeurtenis.

Parameters

Retourneert

Geen geretourneerde waarde.

CQ_Analyics.PersistedJSONPStore cq-analyics-persistedjsonpstore

Een persistente container van een JSON-object dat is opgehaald van een externe JSONP-service.

Breidt CQ_Analytics.PersistedJSONStore uit.

Methoden methods-5

Zie ook CQ_Analytics.PersistedJSONStore voor geërfte methodes.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback) getinstance-storename-serviceurl-dynamicdata-deferloading-loadingcallback-1

Maakt een CQ_Analytics.PersistedJSONPStore-object.

Parameters

Retourneert

Het nieuwe object CQ_Analytics.PersistedJSONPStore of null als storeName null is.

getServiceURL() getserviceurl-1

Hiermee wordt de URL opgehaald van de JSONP-service die dit object gebruikt om JSON-gegevens op te halen.

Parameters

Geen.

Retourneert

Een tekenreeks die de service-URL vertegenwoordigt, of null als er geen service-URL is geconfigureerd.

load(serviceURL, dynamicData, callback) load-serviceurl-dynamicdata-callback-1

Roept de dienst JSONP aan. JSONP URL is de dienst URL die met een bepaalde callback functienaam wordt achtervoegd.

Parameters

Retourneert

Geen geretourneerde waarde.

registerNewInstance(storeName, serviceURL, dynamicData, callback) registernewinstance-storename-serviceurl-dynamicdata-callback-1

Maakt een CQ_Analytics.PersistedJSONPStore-object en registreert de winkel met Client-context.

Parameters

Retourneert

Het geregistreerde object CQ_Analytics.PersistedJSONPStore.

setServiceURL(serviceURL) setserviceurl-serviceurl-1

Plaatst URL van de dienst JSONP voor het terugwinnen van JSON- gegevens te gebruiken.

Parameters

Retourneert

Geen geretourneerde waarde.

CQ_Analytics.PersistedJSONStore cq-analytics-persistedjsonstore

Een persistente container van een JSON-object.

Uitbreidingen CQ_Analytics.PersistedSessionStore.

Eigenschappen properties-2

STOREKEY storekey-1

De sleutel die de opslag identificeert. Gebruik de getInstance methode om deze waarde op te halen.

STORENAME storename-1

De naam van de winkel. Gebruik de getInstance methode om deze waarde op te halen.

Methoden methods-6

Zie ook CQ_Analytics.PersistedSessionStore voor overerfde methoden.

getInstance(storeName, jsonData) getinstance-storename-jsondata-1

Maakt een CQ_Analytics.PersistedJSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan).

Parameters

Retourneert

Het object CQ_Analytics.PersistedJSONStore.

getJSON() getjson-1

Haalt de gegevens van de sessieopslag op in JSON-indeling.

Parameters

Geen.

Retourneert

Een object dat de opslaggegevens in JSON-indeling vertegenwoordigt.

initJSON(jsonData, doNotClear) initjson-jsondata-donotclear-1

Maakt initialisatie-eigenschappen van de gegevens in een JSON-object. U kunt desgewenst alle bestaande initialisatie-eigenschappen verwijderen.

De namen van de eigenschappen worden afgeleid van de hiërarchie van de gegevens in het JSON-object. De volgende voorbeeldcode vertegenwoordigt een JSON-object:

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

In dit voorbeeld worden de volgende eigenschappen gemaakt in de winkel:

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

Parameters

Retourneert

Geen geretourneerde waarde.

registerNewInstance(storeName, jsonData) registernewinstance-storename-jsondata-1

Maakt een CQ_Analytics.PersistedJSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan). Het nieuwe object wordt automatisch geregistreerd bij Client Context Manager.

Parameters

Retourneert

Het object CQ_Analytics.PersistedJSONStore.

CQ_Analytics.PersistedSessionStore cq-analytics-persistedsessionstore

Een container met eigenschappen en waarden. De gegevens blijven bestaan met CQ_Analytics.SessionPersistence. Maak een instantie van deze klasse om een persisted session store te maken:

mypersistedstore = new CQ_Analytics.PersistedSessionStore

Breidt CQ_Analytics.SessionStore uit.

Eigenschappen properties-3

STOREKEY storekey-2

De standaardwaarde is key.

Methoden methods-7

Zie CQ_Analytics.SessionStore voor overerfde methoden.

Wanneer de overerfde methoden clear, setProperty, setProperties, removeProperty worden gebruikt om de opslaggegevens te wijzigen, worden de wijzigingen automatisch doorgevoerd, tenzij de gewijzigde eigenschappen als notPersisted worden gemarkeerd.

getStoreKey() getstorekey

Hiermee wordt het dialoogvenster STOREKEY eigenschap.

Parameters

Geen

Retourneert

De waarde van de STOREKEY eigenschap.

isPersisted(name) ispersisted-name

Hiermee wordt bepaald of een gegevenseigenschap wordt gepresteerd.

Parameters

Retourneert

Een Booleaanse waarde van true als de eigenschap aanhoudt, en een waarde van false als de waarde geen blijvend bezit is.

persist() persist

Houdt de zittingsopslag voort. De standaardpersistentiemodus gebruikt browser localStorage gebruiken ClientSidePersistence als de naam ( window.localStorage.set("ClientSidePersistance", store);)

Als localStorage niet beschikbaar of schrijfbaar is, dan wordt de opslag voortgeduurd als bezit van het venster.

Hiermee wordt het persist gebeurtenis na voltooiing.

Parameters

Geen

Retourneert

Geen geretourneerde waarde.

reset(delayEvent) reset-deferevent

Hiermee verwijdert u alle gegevenseigenschappen uit de winkel en gaat u door met de winkel. Optioneel wordt het dialoogvenster udpate gebeurtenis na voltooiing.

Parameters

Retourneert

Geen geretourneerde waarde.

setNonPersisted(name) setnonpersisted-name

Hiermee wordt een gegevenseigenschap gemarkeerd als niet voortgezet.

Parameters

Retourneert

Geen retourwaarde.

CQ_Analytics.SessionStore cq-analytics-sessionstore

CQ_Analytics.SessionStore vertegenwoordigt een zittingsopslag. Maak een instantie van deze klasse om een sessiewinkel te maken:

mystore = new CQ_Analytics.SessionStore

Breidt CQ_Analytics.Observable uit.

Eigenschappen properties-4

STORENAME storename-2

De naam van de sessiewinkel. Gebruik getName om de waarde van deze eigenschap op te halen.

Methoden methods-8

addInitProperty(name, value) addinitproperty-name-value

Voegt een bezit en een waarde aan de de initialisatiegegevens van de zittingsopslag toe.

Gebruik loadInitProperties om de gegevens van de zittingsopslag met de initialisatiewaarden te bevolken.

Parameters

Retourneert

Geen geretourneerde waarde.

clear() clear-1

Hiermee verwijdert u alle gegevenseigenschappen uit de opslagruimte.

Parameters

Geen.

Retourneert

Geen retourwaarde.

getData(uitgesloten) getdata-excluded

Retourneert de opslaggegevens. Hiermee worden naameigenschappen eventueel uitgesloten van de gegevens. roept de init methode als het gegevensbezit van de opslag niet bestaat.

Parameters

uitgesloten: (Optioneel) Een array met namen van eigenschappen die worden uitgesloten van de geretourneerde gegevens.

Retourneert

Een object met eigenschappen en hun waarden.

getInitProperty(name) getinitproperty-name

Hiermee wordt de waarde van een eigenschap data opgehaald.

Parameters

Retourneert

De waarde van de eigenschap data. Returns null als de zittingsopslag geen bezit van de bepaalde naam bevat.

getName() getname

Retourneert de naam van de sessiewinkel.

Parameters

Geen.

Retourneert

Een tekenreekswaarde die staat voor de winkelnaam.

getProperty(name, raw) getproperty-name-raw

Retourneert de waarde van een eigenschap. De waarde wordt geretourneerd als de onbewerkte eigenschap of de XSS-gefilterde waarde. roept de init methode als het gegevensbezit van de opslag niet bestaat.

Parameters

Retourneert

De waarde van de eigenschap data.

getPropertyNames(uitgesloten) getpropertynames-excluded

Retourneert de namen van de eigenschappen die de sessieopslag bevat. roept de init methode als het gegevensbezit van de opslag niet bestaat.

Parameters

uitgesloten: (Optioneel) Een array met namen van eigenschappen die uit de resultaten moeten worden weggelaten.

Retourneert

Een array met tekenreekswaarden die staan voor de namen van de sessieeigenschappen.

getSessionStore() getsessionstore

Retourneert de sessiewinkel die aan het huidige object is gekoppeld.

Parameters

Geen.

Retourneert

dit

init() init-1

Hiermee wordt de winkel gemarkeerd als geïnitialiseerd en wordt de knop initialize gebeurtenis.

Parameters

Geen.

Retourneert

Geen geretourneerde waarde.

isInitialized() isinitialized

Geeft aan of de opslag van sessies is geïnitialiseerd.

Parameters

Geen.

Retourneert

Een waarde van true als de winkel is geïnitialiseerd, en een waarde van false als de winkel niet is geïnitialiseerd.

loadInitProperties(obj, setValues) loadinitproperties-obj-setvalues

Voegt de eigenschappen van een bepaald voorwerp aan de initialisatiegegevens van de zittingsopslag toe. Optioneel worden de objectgegevens ook toegevoegd aan de opslaggegevens.

Parameters

Retourneert

Geen geretourneerde waarde.

removeProperty(name) removeproperty-name

Hiermee wordt een eigenschap uit de sessieopslag verwijderd. Hiermee wordt het update gebeurtenis na voltooiing. roept de init methode als het gegevensbezit van de opslag niet bestaat.

Parameters

Retourneert

Geen geretourneerde waarde.

reset() reset

Hiermee herstelt u de oorspronkelijke waarden van de gegevensopslag. De standaardimplementatie verwijdert eenvoudig alle gegevens. Hiermee wordt het update gebeurtenis na voltooiing.

Parameters

Geen.

Retourneert

Geen geretourneerde waarde.

setProperties(eigenschappen) setproperties-properties

Stelt de waarden van meerdere eigenschappen in. Hiermee wordt het update gebeurtenis na voltooiing. roept de init methode als het gegevensbezit van de opslag niet bestaat.

Parameters

Retourneert

Geen geretourneerde waarde.

setProperty(name, value) setproperty-name-value

Hiermee wordt de waarde van een eigenschap ingesteld. Hiermee wordt het update gebeurtenis na voltooiing. roept de init methode als het gegevensbezit van de opslag niet bestaat.

Parameters

Retourneert

Geen geretourneerde waarde.