Hinzufügen von ContextHub zu Seiten und Zugreifen auf Speicher

Fügen Sie Ihren Seiten ContextHub hinzu, um die ContextHub-Funktionen zu aktivieren und eine Verknüpfung mit den ContextHub-JavaScript-Bibliotheken herzustellen.

Die ContextHub-JavaScript-API ermöglicht den Zugriff auf die von ContextHub verwalteten Kontextdaten. Diese Seite enthält einen kurzen Überblick über die wichtigsten Funktionen der API für den Zugriff auf Kontextdaten und deren Bearbeitung. Ausführlichere Informationen und Code-Beispiele finden Sie unter den Links zur API-Referenzdokumentation.

Hinzufügen von ContextHub zu einer Seitenkomponente

Schließen Sie die contexthub-Komponente in den Bereich head Ihrer Seite ein, um die ContextHub-Funktionen zu aktivieren und eine Verknüpfung mit den ContextHub-JavaScript-Bibliotheken herzustellen. Der HTL-Code für Ihre Seitenkomponente sollte in etwa wie im folgenden Beispiel aussehen:

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

Beachten Sie, dass Sie auch konfigurieren müssen, ob die ContextHub-Symbolleiste im Vorschaumodus angezeigt werden soll. Siehe Ein- und Ausblenden der ContextHub-Benutzeroberfläche.

Informationen zu ContextHub-Speichern

Verwenden Sie ContextHub-Speicher, um Kontextdaten beizubehalten. ContextHub bietet folgende Arten von Speichern, die die Grundlage für alle Speichertypen bilden:

• PersistedStore
• SessionStore
• JSONPStore
• PersistedJSONPStore

Alle Speichertypen sind Erweiterungen der Klasse ContextHub.Store.Core. Informationen zum Erstellen eines Store-Typs finden Sie unter Erstellen benutzerdefinierter Stores. Weitere Informationen zu Beispielspeichertypen finden Sie unter Beispielkandidaten für ContextHub-Speicher.

Beibehaltungsmodi

ContextHub-Speicher verwenden einen der folgenden Persistenzmodi:

• Lokal: Verwendet „localStorage“ (HTML5), um Daten beizubehalten. Lokaler Speicher wird sitzungsübergreifend im Browser persistiert.
• Sitzung: Verwendet „sessionStorage“ (HTML5), um Daten beizubehalten. Sitzungsspeicher wird für die Dauer der Browser-Sitzung beibehalten und steht für alle Browser-Fenster zur Verfügung.
• Cookie: Verwendet die native Unterstützung von Cookies durch den Browser für die Datenspeicherung. Cookie-Daten werden in HTTP-Anfrage an den bzw. vom Server gesendet.
• Window.name: Verwendet die Eigenschaft „window.name“, um Daten beizubehalten.
• Speicher: Verwendet ein JavaScript-Objekt, um Daten beizubehalten.

Standardmäßig verwendet ContextHub den lokalen Persistenzmodus. Falls der Browser „localStorage“ (HTML5) nicht unterstützt oder nicht zulässt, wird die Sitzungspersistenz verwendet. Falls der Browser „sessionStorage“ (HTML5) nicht unterstützt oder nicht zulässt, wird die Persistenz vom Typ „Window.name“ verwendet.

Store-Daten

Intern bilden die Speicherdaten eine Baumstruktur, sodass Werte als Primärtypen oder komplexe Objekte hinzugefügt werden können. Wenn Sie komplexe Objekte zu Speichern hinzufügen, bilden die Objekteigenschaften Verzweigungen in der Datenstruktur. Im folgenden Beispiel wird das folgende komplexe Objekt einem leeren, als Store bezeichneten Ort hinzugefügt:

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

Die Baumstruktur der Speicherdaten kann wie folgt gestaltet werden:

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

Die Baumstruktur definiert Datenelemente im Speicher als Schlüssel-Wert-Paare. Im obigen Beispiel entspricht der Schlüssel /number dem Wert 321 und der Schlüssel /data/country dem Wert Switzerland.

Bearbeiten von Objekten

Für die Bearbeitung von JavaScript-Objekten stellt ContextHub die Klasse ContextHub.Utils.JSON.tree bereit. Mithilfe der Funktionen dieser Klasse können Sie JavaScript-Objekte bearbeiten, bevor Sie sie einem Speicher hinzufügen oder nachdem Sie sie aus einem Speicher abgerufen haben.

Darüber hinaus bietet die Klasse ContextHub.Utils.JSON Funktionen zum Serialisieren von Objekten zu Zeichenfolgen und zum Deserialisieren von Zeichenfolgen zu Objekten. Verwenden Sie diese Klasse zur Behandlung von JSON-Daten, um Browser zu unterstützen, die nativ nicht über die Funktionen JSON.parse und JSON.stringify verfügen.

Interagieren mit ContextHub-Stores

Verwenden Sie das JavaScript-Objekt ContextHub, um einen Speicher als JavaScript-Objekt abzurufen. Nach dem Abrufen des Store-Objekts können Sie die darin enthaltenen Daten bearbeiten. Verwenden Sie zum Abrufen des Stores die Funktion getAllStores oder getStore.

Zugreifen auf Store-Daten

Die JavaScript-Klasse ContexHub.Store.Core definiert mehrere Funktionen für die Interaktion mit Speicher-Daten. Die folgenden Funktionen ermöglichen das Speichern und Abrufen mehrerer in Objekten enthaltener Datenelemente:

• addAllItems
• getTree

Einzelne Datenelemente werden als Satz von Schlüssel-Wert-Paaren gespeichert. Um Werte zu speichern und abzurufen, geben Sie den entsprechenden Schlüssel an:

• getItem
• setItem

Beachten Sie, dass benutzerdefinierte Speicherkandidaten weitere Funktionen definieren können, die den Zugriff auf Speicherdaten ermöglichen.

ContextHub-Ereignisse

ContextHub enthält ein Ereignis-Framework, das automatische Reaktionen auf Store-Ereignisse ermöglicht. Jedes Store-Objekt enthält ein Objekt vom Typ ContextHub.Utils.Eventing, das als Eigenschaft eventing des Stores verfügbar ist. Verwenden Sie die Funktion on oder once, um eine JavaScript-Funktion an ein Speicher-Ereignis zu binden.

Bearbeiten von Cookies mithilfe von ContextHub

Die ContextHub-JavaScript-API bietet Browser-übergreifende Unterstützung für die Behandlung der Cookies von Browsern. Der Namespace ContextHub.Utils.Cookie definiert eine Reihe von Funktionen zum Erstellen, Bearbeiten und Löschen von Cookies.

Ermitteln aufgelöster ContextHub-Segmente

Mit der ContextHub-Segment-Engine können Sie ermitteln, welche der registrierten Segmente im aktuellen Kontext aufgelöst werden. Verwenden Sie die Funktion „getResolvedSegments“ der Klasse ContextHub.SegmentEngine.SegmentManager, um aufgelöste Segmente abzurufen. Verwenden Sie anschließend die Funktion getName oder getPath der Klasse ContextHub.SegmentEngine.Segment, um auf ein Segment zu testen.

ContextHub-Segmente

ContextHub-Segmente werden unter dem Knoten /conf/<site>/settings/wcm/segments installiert.

Die folgenden Segmente werden mit der WKND-Tutorial-Site installiert.

• summer
• winter

Die Regeln zur Auflösung dieser Segmente werden wie folgt zusammengefasst:

• Zunächst wird der geolocation-Store zur Bestimmung des Breitengrads des Benutzers verwendet.
• Dann bestimmt das Datenelement für den Monat des surferinfo-Stores, in welcher Jahreszeit sich dieser Breitengrad befindet.

Debuggen von ContextHub

Es gibt verschiedene Optionen zum Debugging von ContextHub, einschließlich der Erstellung von Protokollen. Weitere Informationen finden Sie unter Konfigurieren von ContextHub.

Überblick über das ContextHub-Framework

ContextHub bietet eine Diagnoseseite, auf der Sie einen Überblick über das ContextHub-Framework erhalten.