Aggiunta di ContextHub alle pagine e accesso ai negozi

Aggiungi ContextHub alle tue pagine per abilitare le funzionalità di ContextHub e per effettuare il collegamento alle librerie Javascript di ContextHub.

L’API Javascript di ContextHub fornisce l’accesso ai dati contestuali gestiti da ContextHub. Questa pagina descrive brevemente le funzioni principali dell’API per l’accesso ai dati contestuali e la loro manipolazione. Segui i collegamenti alla documentazione di riferimento API per visualizzare informazioni dettagliate ed esempi di codice.

Aggiunta di ContextHub a un componente pagina

Per abilitare le funzioni ContextHub e per effettuare il collegamento alle librerie Javascript di ContextHub, includi le contexthub nel head della pagina. Il codice HTL per il componente pagina deve essere simile al seguente esempio:

<sly data-sly-resource="${'contexthub' @ resourceType='granite/contexthub/components/contexthub'}"/>

È inoltre necessario configurare se la barra degli strumenti di ContextHub viene visualizzata in modalità Anteprima. Vedi Mostrare e nascondere l’interfaccia utente di ContextHub.

Informazioni sugli archivi ContextHub

Utilizza gli archivi ContextHub per mantenere i dati contestuali. ContextHub fornisce i seguenti tipi di archivi che costituiscono la base di tutti i tipi di store:

Tutti i tipi di archivio sono estensioni del ContextHub.Store.Core classe. Per informazioni sulla creazione di un nuovo tipo di archivio, consulta Creazione di store personalizzati. Per informazioni sui tipi di archivio di esempio, consulta Candidati allo store ContextHub di esempio.

Modalità di persistenza

Gli archivi di Context Hub utilizzano una delle seguenti modalità di persistenza:

  • Locale: Utilizza HTML5 localStorage per mantenere i dati. L'archiviazione locale viene mantenuta sul browser in più sessioni.
  • Sessione: Utilizza HTML5 sessionStorage per mantenere i dati. L’archiviazione della sessione viene mantenuta per tutta la durata della sessione del browser ed è disponibile per tutte le finestre del browser.
  • Cookie: Utilizza il supporto nativo dei cookie del browser per l'archiviazione dei dati. I dati dei cookie vengono inviati a e dal server nelle richieste HTTP.
  • Window.name: Utilizza la proprietà window.name per mantenere i dati.
  • Memoria: Utilizza un oggetto Javascript per mantenere i dati.

Per impostazione predefinita, Context Hub utilizza la modalità di persistenza locale. Se il browser non supporta o consente HTML5 localStorage, viene utilizzata la persistenza della sessione. Se il browser non supporta o consente HTML5 sessionStorage, viene utilizzata la persistenza Window.name.

Dati store

All’interno, archiviare i dati forma una struttura ad albero, consentendo l’aggiunta di valori come tipi principali o oggetti complessi. Quando si aggiungono oggetti complessi agli archivi, le proprietà dell'oggetto vengono aggiunte ai rami della struttura dati. Ad esempio, il seguente oggetto complesso viene aggiunto a un archivio vuoto denominato location:

Object {
   number: 321,
   data: {
      city: "Basel",
      country: "Switzerland",
      details: {
         population: 173330,
         elevation: 260
      }
   }
}

La struttura ad albero dei dati archiviati può essere concettualizzata come segue:

/
|- number
|- data
      |- city
      |- country
      |- details
            |- population
            |- elevation

La struttura ad albero definisce gli elementi dati nell’archivio come coppie chiave/valore. Nell’esempio precedente, la chiave /number corrisponde al valore 321e la chiave /data/country corrisponde al valore Switzerland.

Manipolazione degli oggetti

ContextHub fornisce ContextHub.Utils.JSON.tree Classe per la manipolazione di oggetti JavaScript. Utilizzare le funzioni di questa classe per manipolare gli oggetti Javascript prima di aggiungerli a uno store o dopo averli ottenuti da uno store.

Inoltre, la ContextHub.Utils.JSON Questa classe fornisce funzioni per la serializzazione degli oggetti alle punture e la deserializzazione delle stringhe agli oggetti. Usa questa classe per gestire i dati JSON per supportare i browser che non includono in modo nativo i JSON.parse e JSON.stringify funzioni.

Interazione con gli archivi ContextHub

Utilizza la ContextHub Oggetto JavaScript per ottenere un archivio come oggetto Javascript. Una volta ottenuto l'oggetto Store è possibile manipolare i dati contenuti. Utilizza la getAllStores o getStore per ottenere lo store.

Accesso ai dati dell’archivio

La ContexHub.Store.Core La classe JavaScript definisce diverse funzioni per l'interazione con i dati dell'archivio. Le seguenti funzioni memorizzano e recuperano più elementi dati contenuti negli oggetti:

I singoli elementi dati sono memorizzati come un insieme di coppie chiave/valore. Per memorizzare e recuperare i valori si specifica la chiave corrispondente:

I candidati all’archivio personalizzati possono definire funzioni aggiuntive che consentono l’accesso ai dati archiviati.

NOTA

ContextHub non è per impostazione predefinita a conoscenza dell'accesso attualmente utilizzato sui server di pubblicazione e tali utenti sono considerati da ContextHub come "Anonymous".

Puoi rendere ContextHub consapevole degli utenti connessi caricando l’archivio dei profili. Fai riferimento a codice di esempio su GitHub qui.

Evento ContextHub

ContextHub include un framework di eventi che consente di reagire automaticamente agli eventi archiviati. Ogni oggetto store contiene un ContextHub.Utils.Eventing oggetto disponibile come eventing proprietà. Utilizza la on o once per associare una funzione Javascript a un evento store.

Utilizzo di Context Hub per manipolare i cookie

L’API Javascript di Context Hub fornisce supporto cross-browser per la gestione dei cookie del browser. La ContextHub.Utils.Cookie Lo spazio dei nomi definisce diverse funzioni per la creazione, la manipolazione e l’eliminazione dei cookie.

Determinazione dei segmenti ContextHub risolti

Il motore di segmenti ContextHub ti consente di determinare quali dei segmenti registrati vengono risolti nel contesto corrente. Utilizzare la funzione getResolvedSegments del ContextHub.SegmentEngine.SegmentManager per recuperare i segmenti risolti. Quindi, utilizza il getName o getPath funzione ContextHub.SegmentEngine.Segment da sottoporre a test per un segmento.

Segmenti ContextHub

I segmenti ContextHub sono installati sotto la /conf/<site>/settings/wcm/segments nodo.

I seguenti segmenti sono installati con Sito tutorial WKND.

  • estate
  • inverno

Le regole utilizzate per risolvere questi segmenti sono riepilogate come segue:

  • Prima la geolocalizzazione viene utilizzato per determinare la latitudine dell'utente.
  • Quindi la voce dati del mese del negozio surferinfo determina quale stagione è in quella latitudine.
AVVERTENZA

I segmenti installati vengono forniti come configurazioni di riferimento per facilitare la creazione di una configurazione dedicata per il progetto e non devono quindi essere utilizzati direttamente.

Debug di ContextHub

Esistono diverse opzioni per il debug di ContextHub, inclusa la generazione di registri. Vedi Configurazione di ContextHub per ulteriori informazioni.

Vedi una panoramica del framework ContextHub

ContextHub fornisce un pagina di diagnostica dove puoi visualizzare una panoramica del framework ContextHub.

In questa pagina