L’API JavaScript di ContextHub è disponibile per gli script quando Il componente ContextHub è stato aggiunto alla pagina.
Valori costanti definiti dall’API Javascript di ContextHub.
Nella tabella seguente sono elencati i nomi degli eventi che si verificano per gli archivi ContextHub. Vedi anche ContextHub.Utils.Event.
Costante | Descrizione | Valore |
---|---|---|
ContextHub.Constants.EVENT_NAMESPACE | Spazio dei nomi evento di ContextHub | ch |
ContextHub.Constants.EVENT_ALL_STORES_READY | Indica che tutti gli archivi richiesti sono registrati, inizializzati e pronti per essere consumati | pronto all'uso |
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY | Indica che non tutti gli archivi sono stati inizializzati entro un determinato timeout | stores-parzialmente-ready |
ContextHub.Constants.EVENT_STORE_REGISTERED | Generato quando un negozio è registrato | registrato nel negozio |
ContextHub.Constants.EVENT_STORE_READY | Indica che gli archivi sono pronti per funzionare. Viene attivato immediatamente dopo la registrazione, ad eccezione degli archivi JSONP, dove viene attivato quando i dati vengono recuperati). | pronto all'uso |
ContextHub.Constants.EVENT_STORE_UPDATED | Generato quando un archivio aggiorna la sua persistenza | aggiornato |
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME | Nome del contenitore di persistenza | ContextHubPersistence |
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY | Memorizza il nome della chiave di persistenza specifica in cui è memorizzato il risultato JSON non elaborato | /_/raw-response |
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY | Memorizza una marca temporale specifica che indica quando sono stati recuperati i dati JSON | /_/response-time |
ContextHub.Constants.SERVICE_LAST_URL_KEY | Memorizza l’url specifico del servizio JSON utilizzato durante l’ultima chiamata | /_/url |
ContextHub.Constants.IS_CONTAINER_EXPANDED | Indica se l’interfaccia utente di ContextHub è espansa | /_/container-espanso |
Nella tabella seguente sono elencati i nomi degli eventi che si verificano per l’interfaccia utente di ContextHub.
Costante | Descrizione | Valore |
---|---|---|
ContextHub.Constants.EVENT_UI_MODE_REGISTERED | Attivazione quando viene registrata una modalità | in modalità ui-registrato |
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED | Attivato quando una modalità non è registrata | modalità interfaccia utente non registrata |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED | Generato quando viene registrato un renderer di modalità | registrati in modalità ui-renderer |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED | Generato quando un renderer di modalità non è registrato | in modalità ui-renderer-unregistrato |
ContextHub.Constants.EVENT_UI_MODE_ADDED | Attivazione quando viene aggiunta una nuova modalità | aggiunto in modalità ui |
ContextHub.Constants.EVENT_UI_MODE_REMOVED | Attivato quando viene rimossa una modalità | modalità-ui-remove |
ContextHub.Constants.EVENT_UI_MODE_SELECTED | Attivazione quando l’utente seleziona una modalità | in modalità utente selezionata |
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED | Generato quando viene registrato un nuovo modulo | registrato nell'interfaccia utente |
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED | Generato quando un modulo non viene registrato | modulo-ui non registrato |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED | Generato quando un modulo di rendering è registrato | utente-module-renderer-registrato |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED | Generato quando un modulo di rendering non viene registrato | modulo-ui-renderer-unregistrato |
ContextHub.Constants.EVENT_UI_MODULE_ADDED | Generato quando viene aggiunto un nuovo modulo | aggiunto al modulo |
ContextHub.Constants.EVENT_UI_MODULE_REMOVED | Generato quando un modulo viene rimosso | rimosso dall'interfaccia utente |
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED | Generato quando il contenitore dell’interfaccia utente viene aggiunto alla pagina | aggiunto all’interfaccia utente |
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED | Attivazione all’apertura dell’interfaccia utente di ContextHub | contenitore-aperto |
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED | Attivazione quando l’interfaccia utente di ContextHub viene compressa | chiuso-contenitore-ui |
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED | Generato quando una proprietà viene modificata | ui-property-modified |
ContextHub.Constants.EVENT_UI_RENDERED | Viene attivata ogni volta che viene eseguito il rendering dell’interfaccia utente di ContextHub (ad esempio dopo una modifica della proprietà) | renderizzato dall'interfaccia utente |
ContextHub.Constants.EVENT_UI_INITIALIZED | Generato quando il contenitore dell’interfaccia utente viene inizializzato | inizializzato dall'interfaccia utente |
ContextHub.Constants.ACTIVE_UI_MODE | Indica la modalità di interfaccia attiva | /_/active-ui-mode |
L'oggetto ContextHub fornisce l'accesso a tutti gli archivi.
Restituisce tutti gli archivi ContextHub registrati.
Questa funzione non dispone di parametri.
Valore restituito
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
Recupera un archivio come oggetto Javascript.
Parametri
Valore restituito
Oggetto che rappresenta l'archivio.
Esempio
L'esempio seguente recupera l'archivio di geolocalizzazione:
var geoloc = ContextHub.getStore("geolocation");
Rappresenta un segmento ContextHub. Utilizza ContextHub.SegmentEngine.SegmentManager per ottenere i segmenti.
Restituisce il nome del segmento come valore String.
Restituisce il percorso di archivio della definizione del segmento come valore String.
Consente l’accesso ai segmenti ContextHub.
Restituisce i segmenti risolti nel contesto corrente. Questa funzione non dispone di parametri.
Valore restituito
Matrice di oggetti ContextHub.SegmentEngine.Segment.
La classe di base per gli archivi ContextHub.
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).
Nome del negozio.
Un oggetto ContextHub.Utils.Persistence. Per informazioni sul valore predefinito e sull'inizializzazione, vedere [init(name,config)](/docs/experience-manager-65/developing/personlization/contexthub-api.html?lang=it#init-name-config).
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):
I valori possono essere oggetti.
Parametri
options
parametro di setItem(key,value,options).Valore restituito
A boolean
valore:
true
indica che l’oggetto dati è stato memorizzato.false
indica che l'archivio dati è invariato.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
.
Valore restituito
A boolean
valore:
true
indica che il riferimento è stato aggiunto.false
indica che non è stato aggiunto alcun riferimento.Attiva la ready
evento per questo archivio. Questa funzione non ha parametri e non restituisce alcun valore.
Rimuove tutti i dati dall’archivio. La funzione non dispone di parametri e di valori restituiti.
Restituisce il valore associato a una chiave.
Parametri
Valore restituito
Oggetto che rappresenta il valore della chiave.
Recupera le chiavi dall'archivio. Facoltativamente, puoi recuperare le chiavi utilizzate internamente dal framework ContextHub.
Parametri
true
include nei risultati le chiavi utilizzate internamente. Queste chiavi iniziano con il carattere di sottolineatura ("_"). Il valore predefinito è false
.Valore restituito
Matrice di nomi chiave ( string
).
Recupera i riferimenti dall'archivio.
Valore restituito
Matrice che utilizza le chiavi di riferimento come indici per le chiavi di riferimento:
Le chiavi di riferimento corrispondono alle key
del addReference
funzione .
Le chiavi di riferimento corrispondono alle anotherKey
del addReference
funzione .
Recupera la struttura dati dall'archivio. Facoltativamente, puoi includere le coppie chiave/valore utilizzate internamente dal framework ContextHub.
Parametri
includeInternals:
Un valore di true
include nei risultati coppie chiave/valore utilizzate internamente. Le chiavi di questi dati iniziano con il carattere di sottolineatura ("_"). Il valore predefinito è false
.Valore restituito
Oggetto che rappresenta la struttura dati. Le chiavi sono i nomi delle proprietà dell'oggetto.
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:
Determina se l'evento viene messo in pausa per questo archivio.
Valore restituito
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.Sospende l'evento per l'archivio in modo che non vengano attivati eventi. Questa funzione non richiede parametri e non restituisce alcun valore.
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:
true
impedisce l'attivazione del data
evento. Il valore predefinito è false
.Valore restituito
A boolean
valore:
true
indica che la coppia chiave/valore è stata rimossa.false
indica che l'archivio dati è invariato perché la chiave non è stata trovata nell'archivio.Rimuove un riferimento dall'archivio.
Parametri
key
del addReference
funzione .Valore restituito
A boolean
valore:
true
indica che il riferimento è stato rimosso.false
indica che la chiave non era valida e che l'archivio è invariato.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
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
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 a key
del addReference
funzione .
nuovo tentativo: (Numero) Il numero di iterazioni da utilizzare.
Valore restituito
A string
che rappresenta la chiave di riferimento. Se non viene risolto alcun riferimento, il valore del key
viene restituito il parametro .
Riprende gli eventi per questo archivio in modo che gli eventi vengano attivati. Questa funzione non definisce alcun parametro e non restituisce alcun valore.
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:
true
impedisce l'attivazione del data
evento. Il valore predefinito è false
.valore: (Oggetto) Il valore da associare alla chiave.
Valore restituito
A boolean
valore:
true
indica che l’oggetto dati è stato memorizzato.false
indica che l'archivio dati è invariato.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.
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:
override: (Booleano). Un valore di true
fa sì che la configurazione del servizio esistente venga sostituita dalle proprietà di serviceConfig
. Un valore di false
fa sì che le proprietà di configurazione del servizio esistenti vengano unite alle proprietà di serviceConfig
.
Restituisce la risposta non elaborata memorizzata nella cache dall'ultima chiamata al servizio JSONP. La funzione non richiede parametri.
Valore restituito
Oggetto che rappresenta la risposta non elaborata.
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.
Valore restituito
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:
Recupera l'URL del servizio JSONP.
Parametri
true
risolve i parametri e false
No.Valore restituito
A string
che rappresenta l'URL del servizio.
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 a service.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:
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).
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
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
Risolve il parametro specificato.
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 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 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).
Gestisce i moduli di interfaccia utente e i moduli di rendering dell’interfaccia utente.
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
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());
Classe di utilità per l'interazione con i cookie.
Determina se esiste un cookie.
Parametri
String
che contiene la chiave del cookie di cui stai eseguendo il test.Valore restituito
A boolean
il valore true indica che il cookie esiste.
Esempio
if (ContextHub.Utils.Cookie.exists("name")) {
// conditionally-executed code
}
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:
Valore restituito
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/])
Restituisce un valore cookie.
Parametri
Valore restituito
Il valore del cookie, oppure null
se non è stato trovato alcun cookie per la chiave.
Esempio
ContextHub.Utils.Cookie.getItem("name");
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:
true
se il test conferma una corrispondenza.Valore restituito
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/])
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](/docs/experience-manager-65/developing/personlization/contexthub-api.html?lang=it#setitem-key-value-options)
funzione per informazioni. La expires
non ha alcun effetto.
Valore restituito
Questa funzione non restituisce un valore.
Esempio
ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);
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:
date
o number
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
.boolean
che specifica il valore Secure
attributo del cookie. Il valore predefinito è false
.String
valore da utilizzare come Path
attributo del cookie. Il valore predefinito è undefined
.Valore restituito
Il cookie con il valore impostato.
Esempio
ContextHub.Utils.Cookie.setItem("name", "mycookie", {
expires: 3,
domain: 'localhost',
path: '/some/directory',
secure: true
});
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-65/developing/personlization/contexthub-api.md#getkeys-filter)
funzione .
opzioni: La options
argomento da utilizzare nella chiamata al [removeItem](/docs/experience-manager-65/developing/personlization/contexthub-api.md#removeitem-key-options)
funzione .
Valore restituito
Questa funzione non restituisce un valore.
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.
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).
Valore restituito
Questa funzione non restituisce alcun valore.
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 di false
chiama il gestore per gli eventi futuri. Il valore predefinito è true
.
Valore restituito
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>
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 di false
chiama il gestore per gli eventi futuri. Il valore predefinito è true
.
Valore restituito
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.
Classe di utilità che consente a un oggetto di ereditare le proprietà e i metodi di un altro oggetto.
Fa sì che un oggetto erediti le proprietà e i metodi di un altro oggetto.
Parametri
Fornisce funzioni per serializzare gli oggetti in formato JSON e deserializzare le stringhe JSON negli oggetti.
Analizza un valore stringa come JSON e lo converte in un oggetto javascript.
Parametri
Valore restituito
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
}
Serializza i valori e gli oggetti Javascript in valori stringa in formato JSON.
Parametri
Valore restituito
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
});
Questa classe facilita la manipolazione degli oggetti dati da memorizzare o recuperare dagli archivi ContextHub.
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
tree
oggetto.Valore restituito
Oggetto contenente i dati uniti.
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
Valore restituito
Una copia dell'albero che viene pulita.
Recupera il valore da un oggetto per la chiave a.
Parametri
Valore restituito
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
}
}
}
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
Valore restituito
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"]
Crea una copia di un oggetto specificato, rimuove il ramo specificato dalla struttura dati e restituisce la copia modificata.
Parametri
Valore restituito
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"
}
}
Rimuove i valori stringa per renderli utilizzabili come chiavi. Per bonificare una stringa, questa funzione esegue le azioni seguenti:
Utilizzare la matrice risultante per creare una chiave utilizzabile. Parametri
string
di bonificare.Valore restituito
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("/");
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
ContextHub.Utils.JSON.tree.sanitize
per igienizzare la chiave prima di aggiungerla.Valore restituito
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:
Consente di registrare i candidati allo store e ottenere i candidati allo store registrati.
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
del ContextHub.Utils.storeCandidates.registerStoreCandidate
funzione .Valore restituito
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.
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
del ContextHub.Utils.storeCandidates.registerStoreCandidate
funzione .Valore restituito
Oggetto che rappresenta il candidato all'archiviazione registrato. Se il tipo di archivio richiesto non è registrato, viene generato un errore.
Restituisce i nomi dei tipi di archivio registrati come candidati allo store. Questa funzione non richiede parametri.
Valore restituito
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 .
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
true
se il deposito è applicabile, e false
altrimenti. Il valore predefinito è una funzione che restituisce true: function() {return true;}
Esempio
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);