L’API JavaScript di ContextHub è disponibile per gli script quando Il componente ContextHub è stato aggiunto alla pagina.
Valori costanti definiti dall’API JavaScript ContextHub.
Nella tabella seguente sono elencati i nomi degli eventi che si verificano per gli store ContextHub. Vedi anche ContextHub.Utils.Eventing.
Costante | Descrizione | Valore |
---|---|---|
ContextHub.Constants.EVENT_NAMESPACE | Spazio dei nomi dell’evento ContextHub | ch |
ContextHub.Constants.EVENT_ALL_STORES_READY | Indica che tutti gli archivi richiesti sono registrati, inizializzati e pronti per essere utilizzati | pronto per tutti i negozi |
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY | Indica che non tutti gli archivi sono stati inizializzati entro un determinato timeout | store-parzialmente-ready |
ContextHub.Constants.EVENT_STORE_REGISTERED | Generato quando un negozio è registrato | registrato in negozio |
ContextHub.Constants.EVENT_STORE_READY | Indica che i negozi sono pronti per funzionare. Viene attivato immediatamente dopo la registrazione, ad eccezione degli archivi JSONP in cui viene attivato al recupero dei dati. | pronto per il negozio |
ContextHub.Constants.EVENT_STORE_UPDATED | Generato quando un archivio aggiorna la sua persistenza | aggiornato da store |
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME | Nome contenitore persistenza | ContextHubPersistence |
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY | Memorizza il nome della chiave di persistenza specifica in cui viene memorizzato il risultato JSON non elaborato | /_/raw-response |
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY | Memorizza timestamp specifico che indica quando i dati JSON sono stati recuperati | /_/tempo di risposta |
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-EXPANDED |
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 | Generato quando una modalità è registrata | registrazione modalità interfaccia utente |
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED | Generato quando una modalità viene annullata | modalità interfaccia utente non registrata |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED | Generato quando un renderer modalità è registrato | ui-mode-renderer-registered |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED | Generato quando un renderer modalità viene annullato | ui-mode-renderer-unregistered |
ContextHub.Constants.EVENT_UI_MODE_ADDED | Generato quando viene aggiunta una nuova modalità | modalità interfaccia utente aggiunta |
ContextHub.Constants.EVENT_UI_MODE_REMOVED | Generato quando una modalità viene rimossa | ui-mode-remove |
ContextHub.Constants.EVENT_UI_MODE_SELECTED | Generato quando una modalità è selezionata dall'utente | modalità interfaccia utente selezionata |
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED | Generato quando viene registrato un nuovo modulo | registrazione ui-module |
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED | Generato quando un modulo non è registrato | registrazione di ui-module-unregistered |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED | Generato quando un modulo di rendering è registrato | ui-module-renderer-registered |
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED | Generato quando un modulo di rendering viene annullato | ui-module-renderer-unregistered |
ContextHub.Constants.EVENT_UI_MODULE_ADDED | Generato quando viene aggiunto un nuovo modulo | ui-module-aggiunto |
ContextHub.Constants.EVENT_UI_MODULE_REMOVED | Generato quando un modulo viene rimosso | ui-module-remove |
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED | Generato quando il contenitore dell’interfaccia utente viene aggiunto alla pagina | ui-container-ADDED |
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED | Generato quando viene aperta l’interfaccia utente di ContextHub | ui-container-open |
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED | Generato quando l’interfaccia utente di ContextHub è compressa | ui-container-closed |
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED | Generato quando una proprietà viene modificata | ui-property-modified |
ContextHub.Constants.EVENT_UI_RENDERED | Generato ogni volta che viene eseguito il rendering dell’interfaccia utente di ContextHub (ad esempio, dopo una modifica della proprietà) | con rendering dell'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à interfaccia utente attiva | /_/active-ui-mode |
L'oggetto ContextHub consente di accedere a tutti gli archivi.
Restituisce tutti gli archivi ContextHub registrati.
Questa funzione non ha parametri.
Restituisce
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 l’archivio di geolocalizzazione:
var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation
Recupera un archivio come oggetto JavaScript.
Parametri
Restituisce
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 dell’archivio della definizione del segmento come valore String.
Fornisce accesso ai segmenti ContextHub.
Restituisce i segmenti risolti nel contesto corrente. Questa funzione non ha parametri.
Restituisce
Array di oggetti ContextHub.SegmentEngine.Segment.
La classe base per gli archivi ContextHub.
A ContextHub.Utils.Eventing oggetto. Utilizzare questo oggetto per le funzioni di associazione per memorizzare gli eventi. Per informazioni sul valore predefinito e sull'inizializzazione, vedere init(name,config).
Nome dell’archivio.
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 un array con i dati dell’archivio. Ogni coppia chiave/valore nell'oggetto o nell'array viene aggiunta all'archivio tramite setItem
funzione ):
I valori possono essere oggetti.
Parametri
options
parametro di setItem(chiave,valore,opzioni).Restituisce
A boolean
valore:
true
indica che l’oggetto dati è stato archiviato.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 si fa riferimento anotherKey
.
altro tasto: Chiave a cui fa riferimento key
.
Restituisce
A boolean
valore:
true
indica che il riferimento è stato aggiunto.false
indica che non è stato aggiunto alcun riferimento.Attiva il ready
per questo archivio. Questa funzione non ha parametri e non restituisce alcun valore.
Rimuove tutti i dati dall'archivio. La funzione non ha parametri e nessun valore restituito.
Restituisce il valore associato a una chiave.
Parametri
Restituisce
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. Questi tasti iniziano con il carattere di sottolineatura ("_"). Il valore predefinito è false
.Restituisce
Matrice di nomi chiave ( string
valori).
Recupera i riferimenti dall’archivio.
Restituisce
Matrice che utilizza chiavi di riferimento come indici per le chiavi di riferimento:
Le chiavi di riferimento corrispondono a key
parametro di addReference
funzione.
Le chiavi di riferimento corrispondono alle anotherKey
parametro di 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 le 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.
Inizializza l’archivio.
Imposta i dati dell'archivio su un oggetto vuoto.
Imposta i riferimenti dell'archivio su un oggetto vuoto.
EventChannel è costituito da dati:nome, dove nome è il nome dell’archivio.
StoreDataKey è /store/nome, dove nome è il nome dell’archivio.
Parametri
nome: Nome dell’archivio.
config: Oggetto contenente le proprietà di configurazione:
Determina se l'evento viene sospeso per questo archivio.
Restituisce
Un valore booleano:
true
: l’evento viene sospeso in modo che non venga attivato alcun evento per questo archivio.false
: l’evento non viene sospeso in modo che gli eventi vengano attivati per questo archivio.Sospende l'evento per l'archivio in modo che non venga attivato alcun evento. Questa funzione non richiede parametri e non restituisce alcun valore.
Rimuove una coppia chiave/valore dall'archivio.
Quando un tasto viene rimosso, la funzione attiva il 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 di data
evento.
Parametri
chiave: (Stringa) Nome della chiave da rimuovere.
opzioni: (Oggetto) Oggetto di opzioni. Le seguenti proprietà dell'oggetto sono valide:
true
impedisce l'attivazione della data
evento. Il valore predefinito è false
.Restituisce
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
parametro di addReference
funzione.Restituisce
A boolean
valore:
true
indica che il riferimento è stato rimosso.false
indica che la chiave non era valida e che l’archivio non è stato modificato.Reimposta 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 archivio durante la reimpostazione dello stesso. 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
Reimposta 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 archivio durante la reimpostazione dello stesso. 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) Chiave per la quale risolvere il riferimento. Questo key
il parametro corrisponde al key
parametro di addReference
funzione.
riprova: (Numero) Il numero di iterazioni da utilizzare.
Restituisce
A string
valore che rappresenta la chiave di riferimento. Se non viene risolto alcun riferimento, il valore di key
viene restituito il parametro.
Riprende gli eventi per questo archivio in modo che vengano attivati gli eventi. Questa funzione non definisce alcun parametro e non restituisce alcun valore.
Aggiunge una coppia chiave/valore all'archivio.
Attiva il data
solo se il valore della chiave è diverso dal valore attualmente memorizzato per la chiave. Facoltativamente, puoi impedire l'attivazione di data
evento.
I dati dell’evento includono il nome dell’archivio, la chiave, il valore precedente, il nuovo valore e il tipo di azione set
.
Parametri
chiave: (Stringa) Nome della chiave.
opzioni: (Oggetto) Oggetto di opzioni. Le seguenti proprietà dell'oggetto sono valide:
true
impedisce l'attivazione della data
evento. Il valore predefinito è false
.valore: (Oggetto) Valore da associare alla chiave.
Restituisce
A boolean
valore:
true
indica che l’oggetto dati è stato archiviato.false
indica che l'archivio dati è invariato.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 del Negozio sono disponibili solo per la durata della pagina.
ContextHub.Store.JSONPStore estende ContextHub.Store.Core ed eredita le funzioni di tale classe.
Configura i dettagli per la connessione al servizio JSONP utilizzato da questo oggetto. Puoi aggiornare o sostituire la configurazione esistente. La funzione non restituisce alcun valore.
Parametri
serviceConfig: Oggetto contenente le seguenti proprietà:
host: (stringa) il nome o l’indirizzo IP del server.
jsonp: (booleano) Un valore true indica che il servizio è un servizio JSONP, in caso contrario false. Se è true, il callback {callback: "ContextHub.Callbacks.Object.name} viene aggiunto all'oggetto service.params.
parametri: (Oggetto) parametri URL rappresentati come proprietà oggetto. I nomi dei parametri sono nomi di proprietà e i valori dei parametri sono valori di proprietà.
path: (String) il percorso del servizio.
porta: (Numero) il numero di porta del servizio.
secure: (stringa o booleano) determina il protocollo da utilizzare per l’URL del servizio:
sostituisci: (Booleano). Un valore di true
fa sì che la configurazione del servizio esistente venga sostituita dalle proprietà di serviceConfig
. Un valore di false
determina l'unione delle proprietà di configurazione del servizio esistenti con le proprietà di serviceConfig
.
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 raw.
Recupera l'oggetto servizio per l'oggetto ContextHub.Store.JSONPStore. L'oggetto servizio contiene tutte le informazioni necessarie per creare l'URL del servizio.
Restituisce
Oggetto con le seguenti proprietà:
host: (Stringa) Nome o indirizzo IP del server.
jsonp: (Booleano) Il valore true indica che il servizio è un servizio JSONP, in caso contrario false. Se è true, il callback {callback: "ContextHub.Callbacks.Object.name} viene aggiunto all'oggetto service.params.
parametri: (Oggetto) Parametri URL rappresentati come proprietà oggetto. I nomi dei parametri sono nomi di proprietà e i valori dei parametri sono valori di proprietà.
percorso: (Stringa) Percorso del servizio.
porta: (Numero) Il numero di porta del servizio.
protetto: (Stringa o booleano) Determina il protocollo da utilizzare per l'URL del servizio:
Recupera l’URL del servizio JSONP.
Parametri
true
risolve i parametri e false
non lo fa.Restituisce
A string
valore che rappresenta l’URL del servizio.
inizializza l'oggetto ContextHub.Store.JSONPStore.
Parametri
nome: (Stringa) Nome dell’archivio.
config: (Oggetto) Oggetto contenente la proprietà service. 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 è ContextHub.eventing
oggetto.
persistenza: oggetto ContextHub.Utils.Persistence per questo archivio. Per impostazione predefinita, viene utilizzata la persistenza della memoria (oggetto JavaScript).
service: (oggetto)
host: (stringa) il nome o l’indirizzo IP del server.
jsonp: (booleano) Un valore true indica che il servizio è un servizio JSONP, in caso contrario false. Se è true, la proprietà {callback: "ContextHub.Callbacks.*Object.name*}
l’oggetto viene aggiunto a service.params
.
parametri: (Oggetto) parametri URL rappresentati come proprietà oggetto. I nomi e i valori dei parametri sono rispettivamente i nomi e i valori delle proprietà dell'oggetto.
path: (String) il percorso del servizio.
porta: (Numero) il numero di porta del servizio.
secure: (stringa o booleano) 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: tempo minimo in millisecondi che intercorre tra le chiamate al servizio JSONP. (consultare la queryService funzione ).
Interroga il servizio JSONP remoto e memorizza nella cache la risposta. Se il tempo trascorso dalla precedente chiamata 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. Il config.service.ttl
viene impostata quando si chiama 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, 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 di ContextHub. (vedere Modalità di persistenza.)
ContextHub.Store.PersistedStore estende ContextHub.Store.Core quindi eredita tutte le funzioni di quella classe. I dati in questo archivio vengono salvati in modo permanente in base alla configurazione della persistenza di ContextHub.
ContextHub.Store.SessionStore estende ContextHub.Store.Core quindi eredita tutte le funzioni di quella classe. I dati in questo archivio vengono salvati in modo permanente utilizzando la persistenza in memoria (oggetto JavaScript).
Gestisce i moduli UI e i renderer dei moduli UI.
Registra un modulo di rendering dell’interfaccia utente con ContextHub. Dopo la registrazione, il renderer può essere utilizzato per creare moduli UI. Utilizza questa funzione quando sei estensione di ContextHub.UI.BaseModuleRenderer per creare un modulo di rendering dell'interfaccia utente personalizzato.
Parametri
true
per impedire che venga eseguito il rendering dell’interfaccia utente di 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 per il quale 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
}
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:
Restituisce
Oggetto dei cookie. Le proprietà dell’oggetto sono chiavi di cookie e i valori chiave sono valori di cookie.
Esempio
ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])
Restituisce un valore di cookie.
Parametri
Restituisce
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.Restituisce
Matrice di stringhe in cui ogni stringa è la chiave di un cookie che corrisponde al filtro.
Esempio
ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])
Rimuovi un cookie. Per rimuovere il cookie, il valore viene impostato su una stringa vuota e la data di scadenza viene impostata sul giorno precedente alla data corrente.
Parametri
chiave: A String
valore che rappresenta la chiave del cookie da rimuovere.
opzioni: Oggetto contenente i valori delle proprietà per la configurazione degli attributi dei cookie. Consulta la [setItem](/docs/experience-manager-65/developing/personlization/contexthub-api.html?lang=it#setitem-key-value-options)
per informazioni. Il expires
non ha alcun effetto.
Restituisce
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: Stringa che contiene la chiave del cookie.
valore: Stringa che contiene il valore del cookie.
opzioni: (Facoltativo) Oggetto contenente una delle seguenti proprietà che configurano gli attributi del cookie:
date
o number
valore 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 sull'ora corrente più il numero. Il valore predefinito è undefined
.boolean
valore che specifica Secure
attributo del cookie. Il valore predefinito è false
.String
valore da utilizzare come Path
attributo del cookie. Il valore predefinito è undefined
.Restituisce
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 tramite la funzione getKeys e rimossi tramite la funzione removeItem.
Parametri
filtro: Il filter
argomento da utilizzare nella chiamata al [getKeys](/docs/experience-manager-65/developing/personlization/contexthub-api.md#getkeys-filter)
funzione.
opzioni: Il options
argomento da utilizzare nella chiamata al [removeItem](/docs/experience-manager-65/developing/personlization/contexthub-api.md#removeitem-key-options)
funzione.
Restituisce
Questa funzione non restituisce un valore.
Consente di associare e annullare l’associazione di funzioni agli eventi store ContextHub. Accedere agli oggetti ContextHub.Utils.Eventing per un archivio utilizzando evento dell'archivio.
Scollega una funzione da un evento.
Parametri
nome: Il nome dell’evento per cui si sta annullando l’associazione della funzione.
selettore: Selettore che identifica l'associazione. (consultare la selector
parametro per il e una volta funzioni ).
Restituisce
Questa funzione non restituisce alcun valore.
Associazione una funzione a un evento. La funzione viene chiamata ogni volta che si verifica l’evento. Facoltativamente, la funzione può essere chiamata per eventi che si sono verificati in passato, prima che l’associazione venga stabilita.
Parametri
nome: (Stringa) Il nome dell’evento a cui si sta associando la funzione.
handler: (Funzione) Funzione da associare all’evento.
selettore: (Stringa) Identificatore univoco del binding. È necessario il selettore per identificare l'associazione se si desidera utilizzare off
per rimuovere l'associazione.
triggerForPastEvents: (Booleano) Indica se il gestore deve essere eseguito per 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
.
Restituisce
Quando triggerForPastEvents
argomento è true
, questa funzione restituisce un boolean
valore che indica se l’evento si è verificato in passato:
true
: l’evento si è verificato in passato e il gestore verrà chiamato.false
: l’evento non si è verificato in passato.Se triggerForPastEvents
è false
, questa funzione non restituisce alcun valore.
Esempio
L’esempio seguente associa una funzione all’evento dati dell’archivio di geolocalizzazione. La funzione compila un elemento sulla pagina con il valore per l’elemento di 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>
Associazione una funzione a un evento. La funzione viene chiamata una sola volta, per la prima occorrenza dell’evento. Facoltativamente, la funzione può essere chiamata per l’evento che si è verificato in passato, prima che l’associazione venga stabilita.
Parametri
nome: (Stringa) Il nome dell’evento a cui si sta associando la funzione.
handler: (Funzione) Funzione da associare all’evento.
selettore: (Stringa) Identificatore univoco del binding. È necessario il selettore per identificare l'associazione se si desidera utilizzare off
per rimuovere l'associazione.
triggerForPastEvents: (Booleano) Indica se il gestore deve essere eseguito per 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
.
Restituisce
Quando triggerForPastEvents
argomento è true
, questa funzione restituisce un boolean
valore che indica se l’evento si è verificato in passato:
true
: l’evento si è verificato in passato e il gestore verrà chiamato.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
Restituisce
Oggetto JavaScript.
Esempio
Il codice ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}");
restituisce il seguente oggetto:
Object {
city: "Basel",
country: "Switzerland",
population: 173330
}
Serializza i valori e gli oggetti JavaScript in valori stringa in formato JSON.
Parametri
Restituisce
Valore stringa serializzato. Quando data
è una R egExp
questa funzione restituisce un oggetto vuoto. Quando data
è una funzione, restituisce undefined
.
Esempio
Viene restituito il codice seguente "{'city':'Basel','country':'Switzerland','population':'173330'}":
ContextHub.Utils.JSON.stringify({
city: "Basel",
country: "Switzerland",
population: 173330
});
Questa classe facilita la manipolazione degli oggetti dati che devono essere memorizzati o che vengono recuperati dagli archivi ContextHub.
Crea una copia di un oggetto dati e vi aggiunge la struttura dati da un secondo oggetto. La funzione restituisce la copia e non modifica nessuno degli oggetti originali. Quando gli alberi dati dei due oggetti contengono chiavi identiche, il valore del secondo oggetto sovrascrive il valore del primo oggetto.
Parametri
tree
oggetto.Restituisce
Oggetto contenente i dati uniti.
Crea una copia di un oggetto, trova e rimuove elementi nella struttura dati che non contengono valori, valori Null o valori non definiti e restituisce la copia.
Parametri
Restituisce
Copia dell'albero pulita.
Recupera il valore da un oggetto per la chiave a.
Parametri
Restituisce
Valore corrispondente alla chiave. Quando la chiave ha chiavi secondarie, questa funzione restituisce un oggetto complesso. Quando il tipo di 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 secondarie:
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 l’ordinamento delle chiavi recuperate.
Parametri
Restituisce
Matrice 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
}
}
Il ContextHub.Utils.JSON.tree.getKeys(myObject);
script restituisce il seguente array:
["/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 determinato oggetto, rimuove il ramo specificato dalla struttura dati e restituisce la copia modificata.
Parametri
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 /one/two/three/four dalla struttura dati:
myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");
La funzione restituisce il seguente oggetto:
myObject {
one: {
foo: "bar"
}
}
Sanitizza i valori stringa per renderli utilizzabili come chiavi. Per bonificare una stringa, questa funzione esegue le azioni seguenti:
Utilizza l’array risultante per creare una chiave utilizzabile. Parametri
string
per bonificare.Restituisce
Un array di string
valori in cui ogni stringa è la porzione della key
che era delimitata da barre. rappresenta la chiave bonificata. Se la lunghezza dell’array bonificato è 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"
dall’array:
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 dati, vedi Persistenza.
Parametri
ContextHub.Utils.JSON.tree.sanitize
per bonificare la chiave prima di aggiungerla.Restituisce
Una copia della tree
oggetto che include key
/ value
coppia.
Esempio
Considera 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 valore seguente:
Consente di registrare i candidati per lo store e di ottenere i candidati per lo store registrati.
Restituisce i tipi di punto vendita registrati come candidati. Recupera i candidati registrati di un tipo di archivio specifico o di tutti i tipi di archivio.
Parametri
storeType
parametro di ContextHub.Utils.storeCandidates.registerStoreCandidate
funzione.Restituisce
Oggetto di tipo store. Le proprietà dell'oggetto sono i nomi dei tipi di archivio e i valori delle proprietà sono una matrice dei candidati di archivio registrati.
Restituisce un tipo di archivio dai candidati registrati. Se più di un tipo di archivio con lo stesso nome viene rigenerato, la funzione restituisce il tipo di archivio con la priorità più alta.
Parametri
storeType
parametro di ContextHub.Utils.storeCandidates.registerStoreCandidate
funzione.Restituisce
Oggetto che rappresenta il candidato dell'archivio registrato. Se il tipo di archivio richiesto non è registrato, viene generato un errore.
Restituisce i nomi dei tipi di punto vendita registrati come candidati. Questa funzione non richiede parametri.
Restituisce
Matrice di valori stringa, in cui ogni stringa è lo storetype con cui è stato registrato il candidato dell'archivio. Consulta la storeType
parametro di ContextHub.Utils.storeCandidates.registerStoreCandidate
funzione.
Registra un oggetto store come candidato all'archivio utilizzando un nome e una priorità.
La priorità è un numero che indica l'importanza degli archivi con lo stesso nome. Quando un candidato per lo store viene registrato con lo stesso nome di un candidato per lo store già registrato, viene utilizzato il candidato con la priorità più elevata. Quando si registra un candidato per un punto vendita, l'archivio viene registrato solo se la priorità è superiore a quella dei candidati per lo stesso punto vendita registrati con lo stesso nome.
Parametri
true
se il deposito è idoneo, e false
altrimenti. Il valore predefinito è una funzione che restituisce true: function() {return true;}
Esempio
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);