Riferimento API di ContextHub Javascript contexthub-javascript-api-reference
L’API JavaScript di ContextHub è disponibile per gli script quando Il componente ContextHub è stato aggiunto alla pagina.
Costanti ContextHub contexthub-constants
Valori costanti definiti dall’API Javascript di ContextHub.
Costanti evento event-constants
Nella tabella seguente sono elencati i nomi degli eventi che si verificano per gli archivi ContextHub. Vedi anche ContextHub.Utils.Event.
Costanti evento dell’interfaccia utente ui-event-constants
Nella tabella seguente sono elencati i nomi degli eventi che si verificano per l’interfaccia utente di ContextHub.
Riferimento API di ContextHub Javascript contexthub-javascript-api-reference-2
L'oggetto ContextHub fornisce l'accesso a tutti gli archivi.
Funzioni (ContextHub) functions-contexthub
getAllStores() getallstores
Restituisce tutti gli archivi ContextHub registrati.
Questa funzione non dispone di parametri.
Restituisce
Un oggetto che contiene tutti gli archivi ContextHub. Ogni archivio è un oggetto che utilizza lo stesso nome dell'archivio.
Esempio
L'esempio seguente recupera tutti gli archivi e quindi recupera l'archivio di geolocalizzazione:
var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation;
getStore(name) getstore-name
Recupera un archivio come oggetto Javascript.
Parametri
- nome: Nome con cui è stato registrato il negozio.
Restituisce
Oggetto che rappresenta l'archivio.
Esempio
L'esempio seguente recupera l'archivio di geolocalizzazione:
var geoloc = ContextHub.getStore("geolocation");
ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment
Rappresenta un segmento ContextHub. Utilizza ContextHub.SegmentEngine.SegmentManager per ottenere i segmenti.
Funzioni (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment
getName() getname
Restituisce il nome del segmento come valore String.
getPath() getpath
Restituisce il percorso di archivio della definizione del segmento come valore String.
ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager
Consente l’accesso ai segmenti ContextHub.
Funzioni (ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager
getResolvedSegments() getresolvedsegments
Restituisce i segmenti risolti nel contesto corrente. Questa funzione non dispone di parametri.
Restituisce
Matrice di oggetti ContextHub.SegmentEngine.Segment.
ContextHub.Store.Core contexthub-store-core
La classe di base per gli archivi ContextHub.
Proprietà (ContextHub.Store.Core) properties-contexthub-store-core
evento eventing
A ContextHub.Utils.Event oggetto. Utilizzare questo oggetto per eseguire il binding delle funzioni per memorizzare gli eventi. Per informazioni sul valore predefinito e sull'inizializzazione, vedere init(name,config).
name name
Nome del negozio.
persistenza persistence
Un oggetto ContextHub.Utils.Persistence. Per informazioni sul valore predefinito e sull'inizializzazione, vedere init(name,config)
.
Funzioni (ContextHub.Store.Core) functions-contexthub-store-core
addAllItems(tree, options) addallitems-tree-options
Unisce un oggetto dati o una matrice ai dati archiviati. Ogni coppia chiave/valore nell'oggetto o nella matrice viene aggiunta all'archivio (tramite setItem
funzione):
- Oggetto: Le chiavi sono i nomi delle proprietà.
- Matrice: Le chiavi sono gli indici della matrice.
I valori possono essere oggetti.
Parametri
- albero: (Oggetto o matrice) I dati da aggiungere all'archivio.
- opzioni: (Oggetto) Un oggetto facoltativo di opzioni passato alla funzione setItem. Per informazioni, consulta la sezione
options
parametro di setItem(key,value,options).
Restituisce
A boolean
valore:
- Un valore di
true
indica che l’oggetto dati è stato memorizzato. - Un valore di
false
indica che l'archivio dati è invariato.
addReference(key, otherKey) addreference-key-anotherkey
Crea un riferimento da una chiave a un'altra chiave. Una chiave non può fare riferimento a se stessa.
Parametri
-
chiave: Chiave a cui fa riferimento
anotherKey
. -
un'altra chiave: Chiave a cui fa riferimento
key
.
Restituisce
A boolean
valore:
- Un valore di
true
indica che il riferimento è stato aggiunto. - Un valore di
false
indica che non è stato aggiunto alcun riferimento.
annuncioReadiness() announcereadiness
Attiva la ready
evento per questo archivio. Questa funzione non ha parametri e non restituisce alcun valore.
clean() clean
Rimuove tutti i dati dall’archivio. La funzione non dispone di parametri e di valori restituiti.
getItem(key) getitem-key
Restituisce il valore associato a una chiave.
Parametri
- chiave: (Stringa) La chiave per la quale restituire il valore.
Restituisce
Oggetto che rappresenta il valore della chiave.
getKeys(includeInternals) getkeys-includeinternals
Recupera le chiavi dall'archivio. Facoltativamente, puoi recuperare le chiavi utilizzate internamente dal framework ContextHub.
Parametri
- includeInternali: Un valore di
true
include nei risultati le chiavi utilizzate internamente. Queste chiavi iniziano con il carattere di sottolineatura ("_"). Il valore predefinito èfalse
.
Restituisce
Matrice di nomi chiave ( string
).
getReferences() getreferences
Recupera i riferimenti dall'archivio.
Restituisce
Matrice che utilizza le chiavi di riferimento come indici per le chiavi di riferimento:
-
Le chiavi di riferimento corrispondono alle
key
deladdReference
funzione . -
Le chiavi di riferimento corrispondono alle
anotherKey
deladdReference
funzione .
getTree(includeInternals) gettree-includeinternals
Recupera la struttura dati dall'archivio. Facoltativamente, puoi includere le coppie chiave/valore utilizzate internamente dal framework ContextHub.
Parametri
includeInternals:
Un valore ditrue
include nei risultati coppie chiave/valore utilizzate internamente. Le chiavi di questi dati iniziano con il carattere di sottolineatura ("_"). Il valore predefinito èfalse
.
Restituisce
Oggetto che rappresenta la struttura dati. Le chiavi sono i nomi delle proprietà dell'oggetto.
init(name, config) init-name-config
Inizializza l'archivio.
-
Imposta i dati dell'archivio su un oggetto vuoto.
-
Imposta i riferimenti dell'archivio su un oggetto vuoto.
-
EventChannel è data:name, dove name è il nome del negozio.
-
StoreDataKey è /store/name, dove name è il nome del negozio.
Parametri
-
nome: Nome del negozio.
-
config: Un oggetto che contiene le proprietà di configurazione:
- eventDeferring: Il valore predefinito è 32.
- evento: La ContextHub.Utils.Event oggetto per questo archivio. Il valore predefinito è utilizzato dall'oggetto ContextHub.eventing.
- persistenza: L'oggetto ContextHub.Utils.Persistence per questo archivio. Il valore predefinito è l'oggetto ContextHub.persistence.
isEventingPaused() iseventingpaused
Determina se l'evento viene messo in pausa per questo archivio.
Restituisce
Un valore booleano:
true
: L'evento viene messo in pausa in modo che non vengano attivati eventi per questo archivio.false
: L'evento non viene messo in pausa in modo che gli eventi vengano attivati per questo archivio.
pauseEvent() pauseeventing
Sospende l'evento per l'archivio in modo che non vengano attivati eventi. Questa funzione non richiede parametri e non restituisce alcun valore.
removeItem(key, options) removeitem-key-options
Rimuove una coppia chiave/valore dall’archivio.
Quando una chiave viene rimossa, la funzione attiva la funzione data
evento. I dati dell'evento includono il nome dell'archivio, il nome della chiave rimossa, il valore rimosso, il nuovo valore per la chiave (null) e il tipo di azione "remove".
Facoltativamente, puoi impedire l’attivazione del data
evento.
Parametri
-
chiave: (Stringa) Il nome della chiave da rimuovere.
-
opzioni: (Oggetto) Un oggetto di opzioni. Le seguenti proprietà dell'oggetto sono valide:
- silenzioso: Un valore di
true
impedisce l'attivazione deldata
evento. Il valore predefinito èfalse
.
- silenzioso: Un valore di
Restituisce
A boolean
valore:
- Un valore di
true
indica che la coppia chiave/valore è stata rimossa. - Un valore di
false
indica che l'archivio dati è invariato perché la chiave non è stata trovata nell'archivio.
removeReference(key) removereference-key
Rimuove un riferimento dall'archivio.
Parametri
- chiave: Riferimento chiave da rimuovere. Questo parametro corrisponde alla variabile
key
deladdReference
funzione .
Restituisce
A boolean
valore:
- Un valore di
true
indica che il riferimento è stato rimosso. - Un valore di
false
indica che la chiave non era valida e che l'archivio è invariato.
reset(keepRemainData) reset-keepremainingdata
Ripristina i valori iniziali dei dati persistenti dell'archivio. Facoltativamente, puoi rimuovere tutti gli altri dati dall’archivio. L'evento viene messo in pausa per questo negozio mentre lo store viene reimpostato. Questa funzione non restituisce alcun valore.
I valori iniziali vengono forniti nella proprietà initialValues dell'oggetto config utilizzato per creare un'istanza dell'oggetto store.
Parametri
- keepRemainData: (Booleano) Un valore true causa la persistenza dei dati non iniziali. Il valore false causa la rimozione di tutti i dati, ad eccezione dei valori iniziali.
Ripristina i valori iniziali dei dati persistenti dell'archivio. Facoltativamente, puoi rimuovere tutti gli altri dati dall’archivio. L'evento viene messo in pausa per questo negozio mentre lo store viene reimpostato. Questa funzione non restituisce alcun valore.
I valori iniziali vengono forniti nella proprietà initialValues dell'oggetto config utilizzato per creare un'istanza dell'oggetto store.
Parametri
- keepRemainData: (Booleano) Un valore true causa la persistenza dei dati non iniziali. Il valore false causa la rimozione di tutti i dati, ad eccezione dei valori iniziali.
resolveReference(key, try) resolvereference-key-retry
Recupera una chiave di riferimento. Facoltativamente, puoi specificare il numero di iterazioni da utilizzare per risolvere la corrispondenza migliore.
Parametri
-
chiave: (Stringa) La chiave per la quale risolvere il riferimento. Questo
key
corrisponde akey
deladdReference
funzione . -
nuovo tentativo: (Numero) Il numero di iterazioni da utilizzare.
Restituisce
A string
che rappresenta la chiave di riferimento. Se non viene risolto alcun riferimento, il valore del key
viene restituito il parametro .
curriculumEventing() resumeeventing
Riprende gli eventi per questo archivio in modo che gli eventi vengano attivati. Questa funzione non definisce alcun parametro e non restituisce alcun valore.
setItem(key, value, options) setitem-key-value-options
Aggiunge una coppia chiave/valore all’archivio.
Attiva la data
solo se il valore della chiave è diverso dal valore attualmente memorizzato per la chiave. Facoltativamente, puoi impedire l’attivazione del data
evento.
I dati dell’evento includono il nome dell’archivio, la chiave, il valore precedente, il nuovo valore e il tipo di azione di set
.
Parametri
-
chiave: (Stringa) Il nome della chiave.
-
opzioni: (Oggetto) Un oggetto di opzioni. Le seguenti proprietà dell'oggetto sono valide:
- silenzioso: Un valore di
true
impedisce l'attivazione deldata
evento. Il valore predefinito èfalse
.
- silenzioso: Un valore di
-
valore: (Oggetto) Il valore da associare alla chiave.
Restituisce
A boolean
valore:
- Un valore di
true
indica che l’oggetto dati è stato memorizzato. - Un valore di
false
indica che l'archivio dati è invariato.
ContextHub.Store.JSONPStore contexthub-store-jsonpstore
Un archivio che contiene dati JSON. I dati vengono recuperati da un servizio JSONP esterno o facoltativamente da un servizio che restituisce dati JSON. Specifica i dettagli del servizio utilizzando init
quando si crea un'istanza di questa classe.
L'archivio utilizza la persistenza in memoria (variabile Javascript). I dati dell’archivio sono disponibili solo per tutta la durata della pagina.
ContextHub.Store.JSONPStore estende ContextHub.Store.Core e eredita le funzioni di tale classe.
Funzioni (ContextHub.Store.JSONPStore) functions-contexthub-store-jsonpstore
configureService(serviceConfig, override) configureservice-serviceconfig-override
Configura i dettagli della connessione al servizio JSONP utilizzato da questo oggetto. È possibile aggiornare o sostituire la configurazione esistente. La funzione non restituisce alcun valore.
Parametri
-
serviceConfig: Un oggetto che contiene le seguenti proprietà:
-
host: (Stringa) Il nome del server o l'indirizzo IP.
-
jsonp: (Booleano) Il valore true indica che il servizio è un servizio JSONP, false in caso contrario. Se true, il callback {è: "ContextHub.Callback.Object.name} viene aggiunto all'oggetto service.params.
-
parametri: (Oggetto) Parametri URL rappresentati come proprietà dell’oggetto. I nomi dei parametri sono nomi di proprietà e i valori dei parametri sono valori di proprietà.
-
percorso: (Stringa) Il percorso del servizio.
-
porta: (Numero) Il numero di porta del servizio.
-
sicuro: (Stringa o booleana) Determina il protocollo da utilizzare per l'URL del servizio:
- auto: //
- true: https://
- false: https://
-
-
override: (Booleano). Un valore di
true
fa sì che la configurazione del servizio esistente venga sostituita dalle proprietà diserviceConfig
. Un valore difalse
fa sì che le proprietà di configurazione del servizio esistenti vengano unite alle proprietà diserviceConfig
.
getRawResponse() getrawresponse
Restituisce la risposta non elaborata memorizzata nella cache dall'ultima chiamata al servizio JSONP. La funzione non richiede parametri.
Restituisce
Oggetto che rappresenta la risposta non elaborata.
getServiceDetails() getservicedetails
Recupera l'oggetto del servizio per questo oggetto ContextHub.Store.JSONPStore. L'oggetto service contiene tutte le informazioni necessarie per creare l'URL del servizio.
Restituisce
Un oggetto con le seguenti proprietà:
-
host: (Stringa) Il nome del server o l'indirizzo IP.
-
jsonp: (Booleano) Il valore true indica che il servizio è un servizio JSONP, false in caso contrario. Se true, il callback {è: "ContextHub.Callback.Object.name} viene aggiunto all'oggetto service.params.
-
parametri: (Oggetto) Parametri URL rappresentati come proprietà dell’oggetto. I nomi dei parametri sono nomi di proprietà e i valori dei parametri sono valori di proprietà.
-
percorso: (Stringa) Il percorso del servizio.
-
porta: (Numero) Il numero di porta del servizio.
-
sicuro: (Stringa o booleana) Determina il protocollo da utilizzare per l'URL del servizio:
- auto: //
- true: https://
- false: https://
getServiceURL(resolve) getserviceurl-resolve
Recupera l'URL del servizio JSONP.
Parametri
- risolvi: (Booleano) Determina se includere nell'URL i parametri risolti. Un valore di
true
risolve i parametri efalse
No.
Restituisce
A string
che rappresenta l'URL del servizio.
init(name, config) init-name-config-1
inizializza l'oggetto ContextHub.Store.JSONPStore.
Parametri
-
nome: (Stringa) Il nome dell'archivio.
-
config: (Oggetto) Un oggetto contenente la proprietà del servizio. L'oggetto JSONPStore utilizza le proprietà
service
oggetto per creare l'URL del servizio JSONP:-
eventDeferring: 32.
-
evento: L'oggetto ContextHub.Utils.Eventing per questo archivio. Il valore predefinito è il
ContextHub.eventing
oggetto. -
persistenza: L'oggetto ContextHub.Utils.Persistence per questo archivio. Per impostazione predefinita, viene utilizzata la persistenza della memoria (oggetto Javascript).
-
servizio: (Oggetto)
-
host: (Stringa) Il nome del server o l'indirizzo IP.
-
jsonp: (Booleano) Il valore true indica che il servizio è un servizio JSONP, false in caso contrario. Quando è true, il
{callback: "ContextHub.Callbacks.*Object.name*}
viene aggiunto aservice.params
. -
parametri: (Oggetto) Parametri URL rappresentati come proprietà dell’oggetto. I nomi e i valori dei parametri sono rispettivamente i nomi e i valori delle proprietà dell'oggetto.
-
percorso: (Stringa) Il percorso del servizio.
-
porta: (Numero) Il numero di porta del servizio.
-
sicuro: (Stringa o booleana) Determina il protocollo da utilizzare per l'URL del servizio:
- auto: //
- true: https://
- false: https://
-
timeout: (Numero) Il tempo di attesa della risposta del servizio JSONP prima del timeout, in millisecondi.
-
ttl: La quantità minima di tempo in millisecondi che trascorre tra le chiamate al servizio JSONP. (Vedi queryService (funzione).
-
-
queryService(reload) queryservice-reload
Esegue una query sul servizio JSONP remoto e memorizza nella cache la risposta. Se il tempo trascorso dalla chiamata precedente a questa funzione è inferiore al valore di config.service.ttl
, il servizio non viene chiamato e la risposta nella cache non viene modificata. Facoltativamente, puoi forzare la chiamata del servizio. La config.service.ttl
viene impostata quando si chiama il init per inizializzare l'archivio.
Attiva l'evento ready al termine della query. Se l’URL del servizio JSONP non è impostato, la funzione non esegue alcuna operazione.
Parametri
- ricarica: (Booleano) Il valore true rimuove la risposta nella cache e forza la chiamata al servizio JSONP.
ripristina reset
Reimposta i valori iniziali dei dati persistenti dell'archivio e quindi chiama il servizio JSONP. Facoltativamente, puoi rimuovere tutti gli altri dati dall’archivio. L'evento viene messo in pausa per questo archivio mentre i valori iniziali vengono reimpostati. Questa funzione non restituisce alcun valore.
I valori iniziali vengono forniti nella proprietà initialValues dell'oggetto config utilizzato per creare un'istanza dell'oggetto store.
Parametri
- keepRemainData: (Booleano) Un valore true causa la persistenza dei dati non iniziali. Il valore false causa la rimozione di tutti i dati, ad eccezione dei valori iniziali.
resolveParameter(f) resolveparameter-f
Risolve il parametro specificato.
ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore
ContextHub.Store.PersistedJSONPStore estende ContextHub.Store.JSONPStore quindi eredita tutte le funzioni di quella classe. Tuttavia, i dati recuperati dal servizio JSONP vengono mantenuti in base alla configurazione della persistenza ContextHub. (Vedi Modalità di persistenza.)
ContextHub.Store.PersistedStore contexthub-store-persistedstore
ContextHub.Store.PersistedStore estende ContextHub.Store.Core quindi eredita tutte le funzioni di quella classe. I dati in questo archivio vengono mantenuti in base alla configurazione della persistenza ContextHub.
ContextHub.Store.SessionStore contexthub-store-sessionstore
ContextHub.Store.SessionStore estende ContextHub.Store.Core quindi eredita tutte le funzioni di quella classe. I dati in questo archivio vengono mantenuti utilizzando la persistenza in memoria (oggetto Javascript).
ContextHub.UI contexthub-ui
Gestisce i moduli di interfaccia utente e i moduli di rendering dell’interfaccia utente.
Funzioni (ContextHub.UI) functions-contexthub-ui
registerRenderer(moduleType, renderer, dontRender) registerrenderer-moduletype-renderer-dontrender
Registra un modulo di rendering dell'interfaccia utente con ContextHub. Una volta registrato, il renderer può essere utilizzato per creare moduli di interfaccia. Utilizza questa funzione quando estensione ContextHub.UI.BaseModuleRenderer per creare un modulo di rendering dell’interfaccia utente personalizzato.
Parametri
- moduleType: (Stringa) L’identificatore del modulo di rendering dell’interfaccia utente. Se un renderer è già registrato utilizzando il valore specificato, il renderer esistente viene annullato prima della registrazione del renderer.
- renderer: (Stringa) Il nome della classe che esegue il rendering del modulo dell'interfaccia utente.
- dontRender: (Booleano) Imposta su
true
per impedire il rendering dell’interfaccia utente ContextHub dopo la registrazione del renderer. Il valore predefinito èfalse
.
Esempio
L’esempio seguente registra un renderer come tipo di modulo contexthub.browserinfo.
ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());
ContextHub.Utils.Cookie contexthub-utils-cookie
Classe di utilità per l'interazione con i cookie.
Funzioni (ContextHub.Utils.Cookie) functions-contexthub-utils-cookie
exists(key) exists-key
Determina se esiste un cookie.
Parametri
- chiave: A
String
che contiene la chiave del cookie di cui stai eseguendo il test.
Restituisce
A boolean
il valore true indica che il cookie esiste.
Esempio
if (ContextHub.Utils.Cookie.exists("name")) {
// conditionally-executed code
}
getAllItems(filter) getallitems-filter
Restituisce tutti i cookie con chiavi che corrispondono a un filtro.
Parametri
-
(Facoltativo) filtro: Criteri per la corrispondenza delle chiavi dei cookie. Per restituire tutti i cookie, non specificare alcun valore. Sono supportati i seguenti tipi:
- Stringa: La stringa viene confrontata con la chiave cookie.
- Matrice: Ogni elemento della matrice è un filtro.
- Un oggetto RegExp: La funzione di test dell'oggetto viene utilizzata per far corrispondere le chiavi dei cookie.
- Funzione: Funzione che verifica una chiave cookie per una corrispondenza. La funzione deve prendere la chiave cookie come parametro e restituire true se il test conferma una corrispondenza.
Restituisce
Un oggetto di cookie. Le proprietà dell’oggetto sono chiavi cookie e i valori chiave sono valori cookie.
Esempio
ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])
getItem(key) getitem-key-1
Restituisce un valore cookie.
Parametri
- chiave: Chiave del cookie di cui desideri il valore.
Restituisce
Il valore del cookie, oppure null
se non è stato trovato alcun cookie per la chiave.
Esempio
ContextHub.Utils.Cookie.getItem("name");
getKeys(filter) getkeys-filter
Restituisce una matrice delle chiavi dei cookie esistenti che corrispondono a un filtro.
Parametri
-
filtro: Criteri per la corrispondenza delle chiavi dei cookie. Sono supportati i seguenti tipi:
- Stringa: La stringa viene confrontata con la chiave cookie.
- Matrice: Ogni elemento della matrice è un filtro.
- Un oggetto RegExp: La funzione di test dell'oggetto viene utilizzata per far corrispondere le chiavi dei cookie.
- Funzione: Funzione che verifica una chiave cookie per una corrispondenza. La funzione deve prendere la chiave cookie come parametro e restituire
true
se il test conferma una corrispondenza.
Restituisce
Array di stringhe in cui ogni stringa è la chiave di un cookie che corrisponde al filtro.
Esempio
ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])
removeItem(key, options) removeitem-key-options-1
Rimuove un cookie. Per rimuovere il cookie, il valore è impostato su una stringa vuota e la data di scadenza è impostata sul giorno precedente la data corrente.
Parametri
-
chiave: A
String
che rappresenta la chiave del cookie da rimuovere. -
opzioni: Oggetto che contiene i valori delle proprietà per la configurazione degli attributi cookie. Consulta la sezione
[setItem](https://experienceleague.adobe.com/docs/experience-manager-64/developing/personlization/contexthub-api.html?lang=it#setitem-key-value-options)
funzione per informazioni. Laexpires
non ha alcun effetto.
Restituisce
Questa funzione non restituisce un valore.
Esempio
ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);
setItem(key, value, options) setitem-key-value-options-1
Crea un cookie della chiave e del valore specificati e aggiunge il cookie al documento corrente. Facoltativamente, puoi specificare le opzioni che configurano gli attributi del cookie.
Parametri
-
chiave: Una stringa che contiene la chiave del cookie.
-
valore: Una stringa che contiene il valore del cookie.
-
opzioni: (Facoltativo) Un oggetto che contiene una delle seguenti proprietà che configurano gli attributi del cookie:
- scade: A
date
onumber
che specifica quando scade il cookie. Un valore di data specifica l'ora assoluta di scadenza. Un numero (in giorni) imposta l'ora di scadenza all'ora corrente più il numero. Il valore predefinito èundefined
. - sicuro: A
boolean
che specifica il valoreSecure
attributo del cookie. Il valore predefinito èfalse
. - percorso: A
String
valore da utilizzare comePath
attributo del cookie. Il valore predefinito èundefined
.
- scade: A
Restituisce
Il cookie con il valore impostato.
Esempio
ContextHub.Utils.Cookie.setItem("name", "mycookie", {
expires: 3,
domain: 'localhost',
path: '/some/directory',
secure: true
});
vanish(filtro, opzioni) vanish-filter-options
Rimuove tutti i cookie che corrispondono a un determinato filtro. I cookie vengono associati utilizzando la funzione getKeys e rimossi utilizzando la funzione removeItem .
Parametri
-
filtro: La
filter
argomento da utilizzare nella chiamata al[getKeys](/docs/experience-manager-64/developing/personlization/contexthub-api.md#getkeys-filter)
funzione . -
opzioni: La
options
argomento da utilizzare nella chiamata al[removeItem](/docs/experience-manager-64/developing/personlization/contexthub-api.md#removeitem-key-options)
funzione .
Restituisce
Questa funzione non restituisce un valore.
ContextHub.Utils.Eventing contexthub-utils-eventing
Consente di eseguire il binding e il binding delle funzioni agli eventi dell’archivio ContextHub. Accedi agli oggetti ContextHub.Utils.Eventing per un archivio utilizzando evento proprietà dello store.
Funzioni (ContextHub.Utils.Eventing) functions-contexthub-utils-eventing
off(name, selector) off-name-selector
Separa una funzione da un evento.
Parametri
-
nome: La nome dell’evento per cui si sta scollegando la funzione.
-
selettore: Il selettore che identifica il binding. (Vedi
selector
per su e una volta funzioni).
Restituisce
Questa funzione non restituisce alcun valore.
on(name, handler, selector, triggerForPastEvents) on-name-handler-selector-triggerforpastevents
Associa una funzione a un evento. La funzione viene chiamata ogni volta che si verifica l'evento. Facoltativamente, è possibile chiamare la funzione per gli eventi che si sono verificati in passato, prima che venga stabilito il binding.
Parametri
-
nome: (Stringa) nome dell’evento a cui si sta eseguendo il binding della funzione.
-
handler: (Funzione) La funzione da associare all'evento.
-
selettore: (Stringa) Un identificatore univoco per il binding. Per utilizzare il binding, è necessario che il selettore identifichi il binding
off
per rimuovere il binding. -
triggerForPastEvents: (Booleano) Indica se il gestore deve essere eseguito per gli eventi che si sono verificati in passato. Un valore di
true
chiama il gestore per gli eventi passati. Un valore difalse
chiama il gestore per gli eventi futuri. Il valore predefinito ètrue
.
Restituisce
Quando il triggerForPastEvents
argomento true
, questa funzione restituisce un boolean
che indica se l'evento si è verificato in passato:
true
: L'evento si è verificato in passato e verrà chiamato il gestore.false
: L'evento non si è verificato in passato.
Se triggerForPastEvents
è false
, questa funzione non restituisce alcun valore.
Esempio
Nell'esempio seguente viene associata una funzione all'evento dati dell'archivio di geolocalizzazione. La funzione popola un elemento della pagina con il valore dell'elemento dati di latitudine dall'archivio.
<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(nome, gestore, selettore, triggerForPastEvents) once-name-handler-selector-triggerforpastevents
Associa una funzione a un evento. La funzione viene chiamata una sola volta, per la prima occorrenza dell'evento. Facoltativamente, è possibile chiamare la funzione per l'evento che si è verificato in passato, prima che il binding sia stabilito.
Parametri
-
nome: (Stringa) nome dell’evento a cui si sta eseguendo il binding della funzione.
-
handler: (Funzione) La funzione da associare all'evento.
-
selettore: (Stringa) Un identificatore univoco per il binding. Per utilizzare il binding, è necessario che il selettore identifichi il binding
off
per rimuovere il binding. -
triggerForPastEvents: (Booleano) Indica se il gestore deve essere eseguito per gli eventi che si sono verificati in passato. Un valore di
true
chiama il gestore per gli eventi passati. Un valore difalse
chiama il gestore per gli eventi futuri. Il valore predefinito ètrue
.
Restituisce
Quando il triggerForPastEvents
argomento true
, questa funzione restituisce un boolean
che indica se l'evento si è verificato in passato:
true
: L'evento si è verificato in passato e verrà chiamato il gestore.false
: L'evento non si è verificato in passato.
Se triggerForPastEvents
è false
, questa funzione non restituisce alcun valore.
ContextHub.Utils.inheritance contexthub-utils-inheritance
Classe di utilità che consente a un oggetto di ereditare le proprietà e i metodi di un altro oggetto.
Funzioni (ContextHub.Utils.inheritance) functions-contexthub-utils-inheritance
inherit(child, parent) inherit-child-parent
Fa sì che un oggetto erediti le proprietà e i metodi di un altro oggetto.
Parametri
- bambino: (Oggetto) L'oggetto che eredita.
- genitore: (Oggetto) L'oggetto che definisce le proprietà e i metodi ereditati.
ContextHub.Utils.JSON contexthub-utils-json
Fornisce funzioni per serializzare gli oggetti in formato JSON e deserializzare le stringhe JSON negli oggetti.
Funzioni (ContextHub.Utils.JSON) functions-contexthub-utils-json
parse(data) parse-data
Analizza un valore stringa come JSON e lo converte in un oggetto javascript.
Parametri
- dati: Un valore stringa in formato JSON.
Restituisce
Un oggetto Javascript.
Esempio
Il codice ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}");
restituisce l'oggetto seguente:
Object {
city: "Basel",
country: "Switzerland",
population: 173330
}
stringify(data) stringify-data
Serializza i valori e gli oggetti Javascript in valori stringa in formato JSON.
Parametri
- dati: Il valore o l'oggetto da serializzare. Questa funzione supporta valori booleani, array, numero, stringa e data.
Restituisce
Il valore della stringa serializzata. Quando data
è una R egExp
questa funzione restituisce un oggetto vuoto. Quando data
è una funzione, restituisce undefined
.
Esempio
Il codice seguente restituisce "{'city':'Basel','country':'Switzerland','population':'173330'}":
ContextHub.Utils.JSON.stringify({
city: "Basel",
country: "Switzerland",
population: 173330
});
ContextHub.Utils.JSON.tree contexthub-utils-json-tree
Questa classe facilita la manipolazione degli oggetti dati da memorizzare o recuperare dagli archivi ContextHub.
Funzioni (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree
addAllItems() addallitems
Crea una copia di un oggetto dati e gli aggiunge la struttura dati da un secondo oggetto. La funzione restituisce la copia e non modifica nessuno degli oggetti originali. Quando le strutture ad albero dati dei due oggetti contengono chiavi identiche, il valore del secondo oggetto sovrascrive il valore del primo oggetto.
Parametri
- albero: L'oggetto copiato.
- secondo albero: L'oggetto unito alla copia del
tree
oggetto.
Restituisce
Oggetto contenente i dati uniti.
cleanup() cleanup
Crea una copia di un oggetto, trova e rimuove gli elementi nella struttura dati che non contengono valori, valori nulli o valori non definiti e restituisce la copia.
Parametri
- albero: L'oggetto da pulire.
Restituisce
Una copia dell'albero che viene pulita.
getItem() getitem
Recupera il valore da un oggetto per la chiave a.
Parametri
- albero: L'oggetto dati.
- chiave: Chiave del valore da recuperare.
Restituisce
Il valore corrispondente alla chiave. Quando la chiave dispone di chiavi secondarie, questa funzione restituisce un oggetto complesso. Quando il tipo del valore per la chiave è undefined
, null
viene restituito .
Esempio
Considera il seguente oggetto Javascript:
myObject {
user: {
location: {
city: "Basel",
details: {
population: 173330,
elevation: 260
}
}
}
}
Il codice di esempio seguente restituisce il valore 260
:
ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");
Il codice di esempio seguente recupera il valore di una chiave con chiavi figlio:
ContextHub.Utils.JSON.tree.getItem(myObject, "/user");
La funzione restituisce il seguente oggetto:
Object {
location: {
city: "Basel",
details: {
population: 173330,
elevation: 260
}
}
}
getKeys() getkeys
Recupera tutte le chiavi dalla struttura dati di un oggetto. Facoltativamente, puoi recuperare solo le chiavi degli elementi secondari di una chiave specifica. Facoltativamente, puoi anche specificare un ordinamento delle chiavi recuperate.
Parametri
- albero: L'oggetto da cui recuperare le chiavi della struttura dati.
- genitore: (Facoltativo) Chiave di un elemento nella struttura dati per la quale si desidera recuperare le chiavi degli elementi secondari.
- ordine: (Facoltativo) Funzione che determina l'ordinamento delle chiavi restituite. (Vedi Array.prototype.sort su Mozilla Developer Network.)
Restituisce
Un array di chiavi.
Esempio
Considera il seguente oggetto:
myObject {
location: {
weather: {
temperature: "28C",
humidity: "77%",
precipitation: "10%",
wind: "8km/h"
},
city: "Basel",
country: "Switzerland",
longitude: 7.5925727,
latitude: 47.557421
}
}
La ContextHub.Utils.JSON.tree.getKeys(myObject);
lo script restituisce la seguente matrice:
["/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
Crea una copia di un oggetto specificato, rimuove il ramo specificato dalla struttura dati e restituisce la copia modificata.
Parametri
- albero: Un oggetto dati.
- chiave: Chiave da rimuovere.
Restituisce
Copia dell'oggetto dati originale con la chiave rimossa.
Esempio
Considera il seguente oggetto:
myObject {
one: {
foo: "bar",
two: {
three: {
four: {
five: 5,
six: 6
}
}
}
}
}
Lo script di esempio seguente rimuove il ramo /uno/due/tre/quattro dalla struttura dati:
myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");
La funzione restituisce il seguente oggetto:
myObject {
one: {
foo: "bar"
}
}
cleanizeKey(key) sanitizekey-key
Rimuove i valori stringa per renderli utilizzabili come chiavi. Per bonificare una stringa, questa funzione esegue le azioni seguenti:
- Riduce più barre consecutive a una singola barra.
- Rimuove gli spazi bianchi dall’inizio e dalla fine della stringa.
- Divide il risultato in una matrice di stringhe delimitate da barre.
Utilizzare la matrice risultante per creare una chiave utilizzabile. Parametri
- chiave: La
string
di bonificare.
Restituisce
Matrice di string
valori in cui ogni stringa è la parte del key
che è stato delimitato da slash. rappresenta la chiave sanizzata. Se la matrice bonificata ha una lunghezza pari a zero, questa funzione restituisce null
.
Esempio
Il codice seguente bonifica una stringa per produrre l'array ["this", "is", "a", "path"]
, quindi genera la chiave "/this/is/a/path"
dalla matrice:
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
Aggiunge una coppia chiave/valore alla struttura dati di una copia di un oggetto. Per informazioni sulle strutture ad albero dei dati, vedi Persistenza.
Parametri
- albero: Un oggetto dati.
- chiave: Chiave da associare al valore aggiunto. La chiave è il percorso dell’elemento nella struttura dati. Questa funzione chiama
ContextHub.Utils.JSON.tree.sanitize
per igienizzare la chiave prima di aggiungerla. - valore: Valore da aggiungere alla struttura dati.
Restituisce
Una copia del tree
che include key
/ value
coppia.
Esempio
Prendi in considerazione il seguente codice JavaScript:
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);
L'oggetto myObject ha il seguente valore:
ContextHub.Utils.storeCandidates contexthub-utils-storecandidates
Consente di registrare i candidati allo store e ottenere i candidati allo store registrati.
Funzioni (ContextHub.Utils.storeCandidate) functions-contexthub-utils-storecandidates
getRegisteredCandidate(storeType) getregisteredcandidates-storetype
Restituisce i tipi di archivio registrati come candidati allo store. Recupera i candicati registrati di un tipo di archivio specifico o di tutti i tipi di archivio.
Parametri
- storeType: (Stringa) Il nome del tipo di archivio. Consulta la sezione
storeType
delContextHub.Utils.storeCandidates.registerStoreCandidate
funzione .
Restituisce
Un oggetto di tipi di archivio. Le proprietà dell'oggetto sono i nomi dei tipi di archivio e i valori delle proprietà sono una matrice di candidati store registrati.
getStoreFromCandidate(storeType) getstorefromcandidates-storetype
Restituisce un tipo di archivio dai candidati registrati. Se vengono registrati più di un tipo di archivio con lo stesso nome, la funzione restituisce il tipo di archivio con la priorità più elevata.
Parametri
- storeType: (Stringa) Il nome del candidato dello store. Consulta la sezione
storeType
delContextHub.Utils.storeCandidates.registerStoreCandidate
funzione .
Restituisce
Oggetto che rappresenta il candidato all'archiviazione registrato. Se il tipo di archivio richiesto non è registrato, viene generato un errore.
getSupportedStoreTypes() getsupportedstoretypes
Restituisce i nomi dei tipi di archivio registrati come candidati allo store. Questa funzione non richiede parametri.
Restituisce
Matrice di valori stringa, in cui ogni stringa è il tipo di archivio con cui è stato registrato un candidato all'archiviazione. Consulta la sezione storeType
del ContextHub.Utils.storeCandidates.registerStoreCandidate
funzione .
registerStoreCandidate(store, storeType, priority, applica) registerstorecandidate-store-storetype-priority-applies
Registra un oggetto store come candidato all'archiviazione utilizzando un nome e una priorità.
La priorità è un numero che indica l’importanza degli archivi con lo stesso nome. Quando un candidato del negozio viene registrato con lo stesso nome di un candidato del negozio già registrato, viene utilizzato il candidato con la priorità più alta. Quando si registra un candidato al negozio, il negozio viene registrato solo se la priorità è superiore ai candidati registrati dello stesso nome.
Parametri
- negozio: (Oggetto) L'oggetto store da registrare come candidato store.
- storeType: (Stringa) Il nome del candidato dello store. Questo valore è necessario quando si crea un'istanza del candidato store.
- priorità: (Numero) La priorità del candidato del negozio.
- si applica: (Funzione) La funzione da richiamare che valuta l'applicabilità dell'archivio nell'ambiente corrente. La funzione deve restituire
true
se il deposito è applicabile, efalse
altrimenti. Il valore predefinito è una funzione che restituisce true:function() {return true;}
Esempio
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);