Experience League

Experience Cloud

Document Cloud

API JavaScript ClientContext

CQ_Analytics.ClientContextMgr

L'oggetto CQ_Analytics.ClientContextMgr è un singleton che contiene un set di store di sessioni autoregistrati e fornisce metodi per la registrazione, la persistenza e la gestione degli store di sessioni.

Estende CQ_Analytics.PersistedSessionStore.

Metodi

getRegisteredStore(name)

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

Parametri

name: Stringa. Nome dello store di sessioni.

Valore restituito

Un oggetto CQ_Analytics.SessionStore che rappresenta lo store di sessioni del nome specificato. Restituisce null se non esiste alcun archivio del nome specificato.

register(sessionstore)

Registra uno store di sessione con ClientContext. Attiva gli eventi storeregister e storeupdate al termine.

Parametri

sessionstore: CQ_Analytics.SessionStore. L'oggetto session store 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 inizializzazione di uno store di sessioni.

Metodi

onStoreInitialized(storeName, callback, delay)

Registra una funzione di callback che viene chiamata quando viene inizializzato uno store di sessioni. Per gli store che sono inizializzati più volte, specificate un ritardo di callback in modo che la funzione di callback venga chiamata una sola volta:

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

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

La richiesta è completata, i dati recuperati e caricati nello store. 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 nello store.
Lo store è precompilato con valori predefiniti (proprietà init), ma la richiesta non riesce (timeout). Esiste una sola inizializzazione con valori predefiniti.
Il negozio è precompilato.

Quando il ritardo è impostato su true o su un numero di millisecondi, il metodo attende prima di richiamare il metodo di callback. Se viene attivato un altro evento di inizializzazione prima del superamento del ritardo, quest'ultimo aspetterà che venga superato il tempo di ritardo senza che si verifichi alcun evento di inizializzazione. Questo consente di attivare un secondo evento di inizializzazione e richiama la funzione di callback nel caso più ottimale.

Parametri

storeName: Stringa. Il nome dell'archivio delle sessioni da cui aggiungere il listener.
callback: Funzione. La funzione da invocare all'inizializzazione dello store.
ritardo: Booleano o Numero. Tempo in millisecondi per il ritardo della 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 che viene chiamata quando viene registrato uno store di sessioni. L'evento di registro si verifica quando uno store viene registrato in CQ_Analytics.ClientContextMgr.

Parametri

storeName: Stringa. Il nome dell'archivio delle sessioni da cui aggiungere il listener.
callback: Funzione. La funzione da invocare all'inizializzazione dello store.

Valore restituito

Nessun valore restituito.

CQ_Analytics.JSONPStore

Un archivio di sessioni non persistente che contiene dati JSON. I dati vengono recuperati da un servizio JSONP esterno. Utilizzare il metodo getInstance o getRegisteredInstance per creare un'istanza di questa classe.

Estende CQ_Analytics.JSONStore.

Proprietà

Per informazioni sulle proprietà ereditate, consultate 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, afterLoading, 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) Object. I dati JSON da aggiungere ai dati di inizializzazione dello store prima della chiamata della funzione di callback.
deferLoading: (Facoltativo) Valore Boolean. Il valore true impedisce il richiamo del servizio JSONP alla creazione di oggetti. Se si imposta il valore false, viene chiamato il servizio JSONP.
loadingCallback: (Facoltativo) Stringa. Il 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 sia un oggetto CQ_Analytics.JSONPStore.

Valore restituito

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

getServiceURL()

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

Parametri

Nessuno.

Valore restituito

Stringa che rappresenta l'URL del servizio, oppure 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 il 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 del servizio già configurato. Un valore non nullo imposta il servizio JSONP da utilizzare per questo oggetto. Consultate setServiceURL.
dynamicData: (Facoltativo) Object. I dati JSON da aggiungere ai dati di inizializzazione dello store prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Il 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 sia un oggetto CQ_Analytics.JSONPStore.

Valore restituito

Nessun valore restituito.

registerNewInstance(storeName, serviceURL, dynamicData, callback)

Crea un oggetto CQ_Analytics.JSONPStore e registra lo store con ClientContext.

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) Object. I dati JSON da aggiungere ai dati di inizializzazione dello store prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Il 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 sia 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. L'URL del servizio JSONP che fornisce dati JSON

Valore restituito

Nessun valore restituito.

CQ_Analytics.JSONStore

Contenitore per un oggetto JSON. Create un'istanza di questa classe per creare un archivio di sessioni non persistente che contenga dati JSON:

myjsonstore = new CQ_Analytics.JSONStore

È possibile definire un set di dati che compili lo store al momento dell'inizializzazione.

Estende CQ_Analytics.SessionStore.

Proprietà

STOREKEY

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

STORENAME

Il nome dello store. Utilizzare 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

Nessuno.

Valore restituito

Nessun valore restituito.

getInstance(storeName, jsonData)

Crea un oggetto CQ_Analytics.JSONStore con un nome specificato e viene 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: Object. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.JSONStore.

getJSON()

Recupera i dati dell'archivio delle sessioni in formato JSON.

Parametri

Nessuno.

Valore restituito

Un oggetto che rappresenta i dati dell'archivio 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 attiva gli eventi initialize e update.

Parametri

Nessuno.

Valore restituito

Nessun dato restituito.

initJSON(jsonData, doNotClear)

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

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

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

Per questo esempio, nello store vengono create le seguenti proprietà:

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

Parametri

jsonData: Un oggetto JSON che contiene 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 viene 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: Object. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.JSONStore.

CQ_Analytics.Osservabile

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

Metodi

addListener(event, fct, scope)

Registra un listener per un evento. Vedere anche Creazione di un listener per reagire a un aggiornamento dello store di sessioni.

Parametri

event: Stringa. Il nome dell’evento da ascoltare.
fct: Funzione. La funzione che viene chiamata quando si verifica l'evento.
ambito: (Facoltativo) Object. Ambito in cui eseguire la funzione del gestore. Contesto "this" della funzione gestore.

Valore restituito

Nessun valore restituito.

removeListener(event, fct)

Rimuove il gestore eventi specificato per un evento.

Parametri

event: Stringa. Il 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, afterLoading, 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) Object. I dati JSON da aggiungere ai dati di inizializzazione dello store prima della chiamata della funzione di callback.
deferLoading: (Facoltativo) Valore Boolean. Il valore true impedisce il richiamo del servizio JSONP alla creazione di oggetti. Se si imposta il valore false, viene chiamato il servizio JSONP.
loadingCallback: (Facoltativo) Stringa. Il 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 sia 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

Nessuno.

Valore restituito

Stringa che rappresenta l'URL del servizio, oppure 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 il 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 del servizio già configurato. Un valore non nullo imposta il servizio JSONP da utilizzare per questo oggetto. Consultate setServiceURL.
dynamicData: (Facoltativo) Object. I dati JSON da aggiungere ai dati di inizializzazione dello store prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Il 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 sia un oggetto CQ_Analytics.JSONPStore.

Valore restituito

Nessun valore restituito.

registerNewInstance(storeName, serviceURL, dynamicData, callback)

Crea un oggetto CQ_Analytics.PersistedJSONPStore e registra lo store con ClientContext.

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) Object. I dati JSON da aggiungere ai dati di inizializzazione dello store prima della chiamata della funzione di callback.
callback: (Facoltativo) Stringa. Il 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 sia 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. L'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. Utilizzare il metodo getInstance per recuperare questo valore.

STORENAME

Il nome dello store. Utilizzare 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 viene 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: Object. Un oggetto che contiene dati JSON.

Valore restituito

L'oggetto CQ_Analytics.PersistedJSONStore.

getJSON()

Recupera i dati dell'archivio delle sessioni in formato JSON.

Parametri

Nessuno.

Valore restituito

Un oggetto che rappresenta i dati dell'archivio in formato JSON.

initJSON(jsonData, doNotClear)

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

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

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

Per questo esempio, nello store vengono create le seguenti proprietà:

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

Parametri

jsonData: Un oggetto JSON che contiene 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 viene 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: Object. 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.SessionPersistenza. Create un'istanza di questa classe per creare uno store di sessioni persistente:

mypersistedstore = new CQ_Analytics.PersistedSessionStore

Estende CQ_Analytics.SessionStore.

Proprietà

STOREKEY

Il valore predefinito è key.

Metodi

Consulta CQ_Analytics.SessionStore per i metodi ereditati.

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

getStoreKey()

Recupera la proprietà STOREKEY.

Parametri

Nessuno

Valore restituito

Il valore della proprietà STOREKEY.

isPersisted(name)

Determina se una proprietà dati è persistente.

Parametri

name: Stringa. Nome della proprietà.

Valore restituito

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

persist()

Persiste lo store sessione. La modalità di persistenza predefinita utilizza il browser localStorage utilizzando ClientSidePersistence come nome ( window.localStorage.set("ClientSidePersistance", store);)

Se localStorage non è disponibile o scrivibile, lo store viene mantenuto come proprietà della finestra.

Attiva l'evento persist al termine.

Parametri

Nessuno

Valore restituito

Nessun valore restituito.

reset(deferEvent)

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

Parametri

deferEvent: Il valore true impedisce l'attivazione dell'evento update. Un valore di false attiva l'evento update.

Valore restituito

Nessun valore restituito.

setNonPersisted(name)

Contrassegna una proprietà dati come non persistente.

Parametri

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

Valore restituito

Nessun valore restituito.

CQ_Analytics.SessionStore

CQ_Analytics.SessionStore rappresenta uno store di sessioni. Create un'istanza di questa classe per creare uno store di sessioni:

mystore = new CQ_Analytics.SessionStore

Estende CQ_Analytics.Observable.

Proprietà

STORENAME

Nome dello store di 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 di sessione.

Utilizzare loadInitProperties per compilare i dati dell'archivio di sessione con i valori di inizializzazione.

Parametri

name: Stringa. Nome della proprietà da aggiungere.
value: 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à data dell'archivio non esiste.

Parametri

Proprietà: Object. Un oggetto che contiene proprietà enumerabili. Ogni nome e valore di proprietà viene aggiunto allo store.

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à data dell'archivio non esiste.

Parametri

name: Stringa. Nome della proprietà.
value: Stringa. Valore proprietà.

Valore restituito

Nessun valore restituito.

Risorse su adobe.com

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

In questa pagina

Visualizza successivo:

Privacy (AGGIORNATO)

Condizioni d’uso