API JavaScript per il contesto client

CQ_Analytics.ClientContextMgr

L'oggetto CQ_Analytics.ClientContextMgr è un singleton che contiene un set di archivi di sessione registrati automaticamente e fornisce metodi per la registrazione, la persistenza e la gestione degli archivi di sessione.

Estende CQ_Analytics.PersistedSessionStore.

Metodi

getRegisteredStore(name)

Restituisce un archivio di sessione con un nome specificato. Vedere anche Accesso a un archivio sessioni.

Parametri

nome: Stringa. Nome dell'archivio sessioni.

Valore restituito

Un oggetto CQ_Analytics.SessionStore che rappresenta l'archivio delle sessioni del nome specificato. Restituisce null se non esiste alcun archivio del nome specificato.

register(sessionstore)

Registra un archivio sessioni con ClientContext. Attiva gli eventi di registrazione e aggiornamento dello storage al termine del processo.

Parametri

sessionstore: CQ_Analytics.SessionStore. Oggetto dell'archivio sessioni da registrare.

Valore restituito

Nessun valore restituito.

CQ_Analytics.ClientContextUtils

Fornisce metodi per ascoltare l'attivazione e la registrazione dell'archivio sessioni. Vedere anche Controllo della definizione e dell'inizializzazione di un archivio sessioni.

Metodi

onStoreInitialized(storeName, callback, delay)

Registra una funzione di callback chiamata quando viene inizializzato un archivio di sessione. Per gli archivi inizializzati più volte, specifica un ritardo di callback in modo che la funzione di callback venga chiamata una sola volta:

Quando l'archivio viene inizializzato durante il periodo di ritardo di un'inizializzazione precedente, la chiamata della funzione precedente viene annullata e la funzione viene richiamata nuovamente per l'inizializzazione corrente.
Se il periodo di ritardo scade prima di un'inizializzazione successiva, la funzione di callback viene eseguita due volte.

Ad esempio, un archivio sessioni si basa su un oggetto JSON e viene recuperato tramite una richiesta JSON. Sono possibili i seguenti scenari di inizializzazione:

La richiesta viene completata, i dati recuperati e caricati nell'archivio. In questo caso, l'inizializzazione viene eseguita una volta.
La richiesta non riesce (timeout). In questo caso l'inizializzazione non viene eseguita e non sono presenti dati nell'archivio.
L’archivio è precompilato con valori predefiniti (proprietà init), ma la richiesta non riesce (timeout). Esiste una sola inizializzazione con valori predefiniti.
Lo store è prepopolato.

Quando il ritardo è impostato su true o su un numero di millisecondi, il metodo attende prima di richiamare il metodo di callback. Se un altro evento di inizializzazione viene attivato prima del passaggio del ritardo, attenderà che venga superato il tempo di ritardo senza alcun evento di inizializzazione. Questo consente di attendere l'attivazione di un secondo evento di inizializzazione e chiama la funzione di callback nel caso più ottimale.

Parametri

storeName: Stringa. Nome dell'archivio sessioni da aggiungere al listener.
callback: Funzione. La funzione da chiamare all'inizializzazione dello store.
ritardo: Valore booleano o numerico. Il tempo in millisecondi impiegato per ritardare la chiamata alla funzione di callback. Un valore booleano di true utilizza il ritardo predefinito di 200 ms. Un valore booleano di false o un numero negativo non causa alcun ritardo.

Valore restituito

Nessun valore restituito.

onStoreRegistered(storeName, callback)

Registra una funzione di callback chiamata quando viene registrato un archivio di sessione. L'evento di registrazione si verifica quando un archivio viene registrato in CQ_Analytics.ClientContextMgr.

Parametri

storeName: Stringa. Nome dell'archivio sessioni da aggiungere al listener.
callback: Funzione. La funzione da chiamare all'inizializzazione dello store.

Valore restituito

Nessun valore restituito.

CQ_Analytics.JSONPStore

Archivio di sessione non persistente contenente dati JSON. I dati vengono recuperati da un servizio JSONP esterno. Utilizza il metodo getInstance o getRegisteredInstance per creare un'istanza di questa classe.

Estende CQ_Analytics.JSONStore.

Proprietà

Per le proprietà ereditate, consulta CQ_Analytics.JSONStore e CQ_Analytics.SessonStore .

Metodi

Consulta anche CQ_Analytics.JSONStore e CQ_Analytics.SessonStore per i metodi ereditati.

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

Crea un oggetto CQ_Analytics.JSONPStore.

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli. Se non viene fornito alcun valore storeName, il metodo restituisce null.
serviceURL: Stringa. URL del servizio JSONP
dynamicData: (Facoltativo) Oggetto. Dati JSON da aggiungere ai dati di inizializzazione dell'archivio prima della chiamata della funzione di callback.
deferLoading: (Facoltativo) Booleano. Il valore true impedisce la chiamata del servizio JSONP alla creazione di oggetti. Se si imposta il valore false, viene richiamato il servizio JSONP.
loadingCallback: (Facoltativo) Stringa. Nome della funzione da chiamare per l'elaborazione dell'oggetto JSONP restituito dal servizio JSONP. La funzione di callback deve definire un singolo parametro che è un oggetto CQ_Analytics.JSONPStore.

Valore restituito

Il nuovo oggetto CQ_Analytics.JSONPStore o null se storeName è null.

getServiceURL()

Recupera l’URL del servizio JSONP utilizzato da questo oggetto per recuperare i dati JSON.

Parametri

Nessuna.

Valore restituito

Stringa che rappresenta l'URL del servizio o null se non è stato configurato alcun URL del servizio.

load(serviceURL, dynamicData, callback)

Chiama il servizio JSONP. L'URL JSONP è l'URL del servizio con suffisso con un nome della funzione di callback di ritorno.

Parametri

serviceURL: (Facoltativo) Stringa. Il servizio JSONP da chiamare. Se si imposta il valore null, verrà utilizzato l'URL di servizio già configurato. Un valore non nullo imposta il servizio JSONP da utilizzare per questo oggetto. (Vedi setServiceURL.)
dynamicData: (Facoltativo) Oggetto. Dati JSON da aggiungere ai dati di inizializzazione dell'archivio prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Nome della funzione da chiamare per l'elaborazione dell'oggetto JSONP restituito dal servizio JSONP. La funzione di callback deve definire un singolo parametro che è un oggetto CQ_Analytics.JSONPStore.

Valore restituito

Nessun valore restituito.

registerNewInstance(storeName, serviceURL, dynamicData, callback)

Crea un oggetto CQ_Analytics.JSONPStore e registra l'archivio con Client Context.

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli. Se non viene fornito alcun valore storeName, il metodo restituisce null.
serviceURL: (Facoltativo) Stringa. URL del servizio JSONP.
dynamicData: (Facoltativo) Oggetto. Dati JSON da aggiungere ai dati di inizializzazione dell'archivio prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Nome della funzione da chiamare per l'elaborazione dell'oggetto JSONP restituito dal servizio JSONP. La funzione di callback deve definire un singolo parametro che è un oggetto CQ_Analytics.JSONPStore.

Valore restituito

L'oggetto CQ_Analytics.JSONPStore registrato.

setServiceURL(serviceURL)

Imposta l’URL del servizio JSONP da utilizzare per il recupero dei dati JSON.

Parametri

serviceURL: Stringa. URL del servizio JSONP che fornisce dati JSON

Valore restituito

Nessun valore restituito.

CQ_Analytics.JSONStore

Un contenitore per un oggetto JSON. Crea un'istanza di questa classe per creare un archivio di sessione non persistente che contiene dati JSON:

myjsonstore = new CQ_Analytics.JSONStore

Puoi definire un set di dati che popola l'archivio al momento dell'inizializzazione.

Estende CQ_Analytics.SessionStore.

Proprietà

STOREKEY

Chiave che identifica lo store. Utilizza il metodo getInstance per recuperare questo valore.

STORENAME

Nome del negozio. Utilizza il metodo getInstance per recuperare questo valore.

Metodi

Consulta anche CQ_Analytics.SessionStore per i metodi ereditati.

cancella()

Rimuove i dati dell’archivio sessioni e rimuove tutte le proprietà di inizializzazione.

Parametri

Nessuna.

Valore restituito

Nessun valore restituito.

getInstance(storeName, jsonData)

Crea un oggetto CQ_Analytics.JSONStore con un nome specificato e inizializzato con i dati JSON specificati (chiama il metodo initJSON ).

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli.
jsonData: Oggetto. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.JSONStore.

getJSON()

Recupera i dati della sessione archiviata in formato JSON.

Parametri

Nessuna.

Valore restituito

Un oggetto che rappresenta i dati archiviati in formato JSON.

init()

Cancella l'archivio delle sessioni e lo inizializza con la proprietà di inizializzazione. Imposta il flag di inizializzazione su true, quindi genera gli eventi initialize e update.

Parametri

Nessuna.

Valore restituito

Nessun dato restituito.

initJSON(jsonData, doNotClear)

Crea proprietà di inizializzazione dai dati in un oggetto JSON. Facoltativamente, puoi rimuovere tutte le proprietà di inizializzazione esistenti.

I nomi delle proprietà sono derivati dalla gerarchia dei dati nell’oggetto JSON. Il codice di esempio seguente rappresenta un oggetto JSON:

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

Per questo esempio, nell'archivio vengono create le seguenti proprietà:

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

Parametri

jsonData: Un oggetto JSON contenente i dati da memorizzare.
doNotClear: Il valore true mantiene le proprietà di inizializzazione esistenti e aggiunge quelle derivate dall'oggetto JSON. Il valore false rimuove le proprietà di inizializzazione esistenti prima di aggiungere quelle derivate dall'oggetto JSON.

Valore restituito

Nessun valore restituito.

registerNewInstance(storeName, jsonData)

Crea un oggetto CQ_Analytics.JSONStore con un nome specificato e inizializzato con i dati JSON specificati (chiama il metodo initJSON ). Il nuovo oggetto viene registrato automaticamente con Clickstream Cloud Manager.

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli.
jsonData: Oggetto. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.JSONStore.

CQ_Analytics.Observable

Attiva eventi e consente ad altri oggetti di ascoltare questi eventi e reagire. Le classi che estendono questa classe possono attivare eventi che causano la chiamata di listener.

Metodi

addListener(event, fct, scope)

Registra un listener per un evento. Vedi anche Creazione di un listener per reagire a un aggiornamento dello store di sessione.

Parametri

evento: Stringa. Nome dell'evento da ascoltare.
fct: Funzione. La funzione che viene chiamata quando si verifica l'evento.
ambito di applicazione: (Facoltativo) Oggetto. Ambito in cui eseguire la funzione del gestore. Il contesto "this" della funzione di gestione.

Valore restituito

Nessun valore restituito.

removeListener(event, fct)

Rimuove il gestore eventi specificato per un evento.

Parametri

evento: Stringa. Nome dell'evento.
fct: Funzione. Il gestore eventi.

Valore restituito

Nessun valore restituito.

CQ_Analytics.PersistedJSONPStore

Contenitore persistente di un oggetto JSON recuperato da un servizio JSONP remoto.

Estende CQ_Analytics.PersistedJSONStore.

Metodi

Consulta anche CQ_Analytics.PersistedJSONStore per i metodi ereditati.

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

Crea un oggetto CQ_Analytics.PersistedJSONPStore.

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli. Se non viene fornito alcun valore storeName, il metodo restituisce null.
serviceURL: Stringa. URL del servizio JSONP
dynamicData: (Facoltativo) Oggetto. Dati JSON da aggiungere ai dati di inizializzazione dell'archivio prima della chiamata della funzione di callback.
deferLoading: (Facoltativo) Booleano. Il valore true impedisce la chiamata del servizio JSONP alla creazione di oggetti. Se si imposta il valore false, viene richiamato il servizio JSONP.
loadingCallback: (Facoltativo) Stringa. Nome della funzione da chiamare per l'elaborazione dell'oggetto JSONP restituito dal servizio JSONP. La funzione di callback deve definire un singolo parametro che è un oggetto CQ_Analytics.JSONPStore.

Valore restituito

Il nuovo oggetto CQ_Analytics.PersistedJSONPStore o null se storeName è null.

getServiceURL()

Recupera l’URL del servizio JSONP utilizzato da questo oggetto per recuperare i dati JSON.

Parametri

Nessuna.

Valore restituito

Stringa che rappresenta l'URL del servizio o null se non è stato configurato alcun URL del servizio.

load(serviceURL, dynamicData, callback)

Chiama il servizio JSONP. L'URL JSONP è l'URL del servizio con suffisso con un nome della funzione di callback di ritorno.

Parametri

serviceURL: (Facoltativo) Stringa. Il servizio JSONP da chiamare. Se si imposta il valore null, verrà utilizzato l'URL di servizio già configurato. Un valore non nullo imposta il servizio JSONP da utilizzare per questo oggetto. (Vedi setServiceURL.)
dynamicData: (Facoltativo) Oggetto. Dati JSON da aggiungere ai dati di inizializzazione dell'archivio prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Nome della funzione da chiamare per l'elaborazione dell'oggetto JSONP restituito dal servizio JSONP. La funzione di callback deve definire un singolo parametro che è un oggetto CQ_Analytics.JSONPStore.

Valore restituito

Nessun valore restituito.

registerNewInstance(storeName, serviceURL, dynamicData, callback)

Crea un oggetto CQ_Analytics.PersistedJSONPStore e registra l'archivio con Client Context.

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli. Se non viene fornito alcun valore storeName, il metodo restituisce null.
serviceURL: (Facoltativo) Stringa. URL del servizio JSONP.
dynamicData: (Facoltativo) Oggetto. Dati JSON da aggiungere ai dati di inizializzazione dell'archivio prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Nome della funzione da chiamare per l'elaborazione dell'oggetto JSONP restituito dal servizio JSONP. La funzione di callback deve definire un singolo parametro che è un oggetto CQ_Analytics.JSONPStore.

Valore restituito

L'oggetto CQ_Analytics.PersistedJSONPStore registrato.

setServiceURL(serviceURL)

Imposta l’URL del servizio JSONP da utilizzare per il recupero dei dati JSON.

Parametri

serviceURL: Stringa. URL del servizio JSONP che fornisce dati JSON

Valore restituito

Nessun valore restituito.

CQ_Analytics.PersistedJSONStore

Contenitore persistente di un oggetto JSON.

Estende CQ_Analytics.PersistedSessionStore.

Proprietà

STOREKEY

Chiave che identifica lo store. Utilizza il metodo getInstance per recuperare questo valore.

STORENAME

Nome del negozio. Utilizza il metodo getInstance per recuperare questo valore.

Metodi

Consulta anche CQ_Analytics.PersistedSessionStore per i metodi ereditati.

getInstance(storeName, jsonData)

Crea un oggetto CQ_Analytics.PersistedJSONStore con un nome specificato e inizializzato con i dati JSON specificati (chiama il metodo initJSON ).

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli.
jsonData: Oggetto. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.PersistedJSONStore.

getJSON()

Recupera i dati della sessione archiviata in formato JSON.

Parametri

Nessuna.

Valore restituito

Un oggetto che rappresenta i dati archiviati in formato JSON.

initJSON(jsonData, doNotClear)

Crea proprietà di inizializzazione dai dati in un oggetto JSON. Facoltativamente, puoi rimuovere tutte le proprietà di inizializzazione esistenti.

I nomi delle proprietà sono derivati dalla gerarchia dei dati nell’oggetto JSON. Il codice di esempio seguente rappresenta un oggetto JSON:

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

Per questo esempio, nell'archivio vengono create le seguenti proprietà:

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

Parametri

jsonData: Un oggetto JSON contenente i dati da memorizzare.
doNotClear: Il valore true mantiene le proprietà di inizializzazione esistenti e aggiunge quelle derivate dall'oggetto JSON. Il valore false rimuove le proprietà di inizializzazione esistenti prima di aggiungere quelle derivate dall'oggetto JSON.

Valore restituito

Nessun valore restituito.

registerNewInstance(storeName, jsonData)

Crea un oggetto CQ_Analytics.PersistedJSONStore con un nome specificato e inizializzato con i dati JSON specificati (chiama il metodo initJSON ). Il nuovo oggetto viene registrato automaticamente con Client Context Manager.

Parametri

storeName: Stringa. Nome da utilizzare come proprietà STORENAME. Il valore della proprietà STOREKEY è impostato su storeName con tutti i caratteri maiuscoli.
jsonData: Oggetto. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.PersistedJSONStore.

CQ_Analytics.PersistedSessionStore

Contenitore di proprietà e valori. I dati vengono memorizzati utilizzando CQ_Analytics.SessionPersistence. Crea un'istanza di questa classe per creare un archivio di sessione persistente:

mypersistedstore = new CQ_Analytics.PersistedSessionStore

Estende CQ_Analytics.SessionStore.

Proprietà

STOREKEY

Il valore predefinito è key.

Metodi

Per i metodi ereditati, consulta CQ_Analytics.SessionStore .

Quando i metodi ereditati clear, setProperty, setProperties, removeProperty vengono utilizzati per modificare i dati dell'archivio, le modifiche vengono mantenute automaticamente, a meno che le proprietà modificate non siano contrassegnate come non persistenti.

getStoreKey()

Recupera la proprietà STOREKEY .

Parametri

Nessuna

Valore restituito

Il valore della proprietà STOREKEY.

isPersisted(name)

Determina se una proprietà dati è persistente.

Parametri

nome: Stringa. Nome della proprietà.

Valore restituito

Un valore booleano true se la proprietà è persistente e un valore false se il valore non è una proprietà persistente.

persist()

Persiste l’archivio delle sessioni. La modalità di persistenza predefinita utilizza il browser localStorage utilizzando ClientSidePersistence come nome ( window.localStorage.set("ClientSidePersistance", store);)

Se localStorage non è disponibile o scrivibile, l'archivio viene mantenuto come proprietà della finestra.

Attiva l'evento persist al termine.

Parametri

Nessuna

Valore restituito

Nessun valore restituito.

reset(deferEvent)

Rimuove tutte le proprietà dei dati dall’archivio e persiste l’archivio. Facoltativamente, non attiva l'evento udpate al termine.

Parametri

deferEvent: Il valore true impedisce l’attivazione dell’evento update . Il valore di false causa l'attivazione dell'evento di aggiornamento.

Valore restituito

Nessun valore restituito.

setNonPersisted(name)

Contrassegna una proprietà dati come non persistente.

Parametri

nome: Stringa. Nome della proprietà che non deve essere persistente.

Valore restituito

Nessun valore restituito.

CQ_Analytics.SessionStore

CQ_Analytics.SessionStore rappresenta un archivio di sessioni. Crea un'istanza di questa classe per creare un archivio sessioni:

mystore = new CQ_Analytics.SessionStore

Estende CQ_Analytics.Observable.

Proprietà

STORENAME

Nome dell'archivio sessioni. Utilizzare getName per recuperare il valore di questa proprietà.

Metodi

addInitProperty(name, value)

Aggiunge una proprietà e un valore ai dati di inizializzazione dell'archivio sessioni.

Utilizza loadInitProperties per popolare i dati dell'archivio sessioni con i valori di inizializzazione.

Parametri

nome: Stringa. Nome della proprietà da aggiungere.
valore: Stringa. Il valore della proprietà da aggiungere.

Valore restituito

Nessun valore restituito.

setProperties(properties)

Imposta i valori di più proprietà. Attiva l'evento update al termine. Chiama il metodo init se la proprietà dati dell'archivio non esiste.

Parametri

Proprietà: Oggetto. Un oggetto che contiene proprietà enumerabili. Ogni nome e valore della proprietà viene aggiunto all'archivio.

Valore restituito

Nessun valore restituito.

setProperty(name, value)

Imposta il valore di una proprietà. Attiva l'evento update al termine. Chiama il metodo init se la proprietà dati dell'archivio non esiste.

Parametri

nome: Stringa. Nome della proprietà.
valore: Stringa. Valore proprietà.

Valore restituito

Nessun valore restituito.

Risorse Business.Adobe.com

Automated Onboarding Auto Form Fill Personalized Communications Theme Editor Web Content Management Dynamic Media

API JavaScript per il contesto client

CQ_Analytics.ClientContextMgr

Metodi

getRegisteredStore(name)

register(sessionstore)

CQ_Analytics.ClientContextUtils

Metodi

onStoreInitialized(storeName, callback, delay)

onStoreRegistered(storeName, callback)

CQ_Analytics.JSONPStore

Proprietà

Metodi

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

getServiceURL()

load(serviceURL, dynamicData, callback)

registerNewInstance(storeName, serviceURL, dynamicData, callback)

setServiceURL(serviceURL)

CQ_Analytics.JSONStore

Proprietà

STOREKEY

STORENAME

Metodi

cancella()

getInstance(storeName, jsonData)

getJSON()

init()

initJSON(jsonData, doNotClear)

registerNewInstance(storeName, jsonData)

CQ_Analytics.Observable

Metodi

addListener(event, fct, scope)

removeListener(event, fct)

CQ_Analytics.PersistedJSONPStore

Metodi

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

getServiceURL()

load(serviceURL, dynamicData, callback)

registerNewInstance(storeName, serviceURL, dynamicData, callback)

setServiceURL(serviceURL)

CQ_Analytics.PersistedJSONStore

Proprietà

STOREKEY

STORENAME

Metodi

getInstance(storeName, jsonData)

getJSON()

initJSON(jsonData, doNotClear)

registerNewInstance(storeName, jsonData)

CQ_Analytics.PersistedSessionStore

Proprietà

STOREKEY

Metodi

getStoreKey()

isPersisted(name)

persist()

reset(deferEvent)

setNonPersisted(name)

CQ_Analytics.SessionStore

Proprietà

STORENAME

Metodi

addInitProperty(name, value)

cancella()

getData(excluded)

getInitProperty(name)

getName()

getProperty(name, raw)

getPropertyNames(excluded)

getSessionStore()

init()

isInitialized()

loadInitProperties(obj, setValues)

removeProperty(name)

reset()

setProperties(properties)

setProperty(name, value)

Risorse Business.Adobe.com

In questa pagina

Visualizza successivo:

Scopri