Agregar ContextHub a páginas y acceder a tiendas

Agregue ContextHub a sus páginas para habilitar las funciones de ContextHub y vincular a las bibliotecas JavaScript de ContextHub.

La API de JavaScript de ContextHub proporciona acceso a los datos de contexto que administra ContextHub. En esta página se describen brevemente las principales funciones de la API para acceder y manipular los datos de contexto. Siga los vínculos a la documentación de referencia de la API para ver información detallada y ejemplos de código.

Adición de ContextHub a un componente de página

Para habilitar las funciones de ContextHub y vincular a las bibliotecas JavaScript de ContextHub, incluya la variable contexthub en el head de su página. El código HTL del componente de página debe parecerse al siguiente ejemplo:

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

Tenga en cuenta que también debe configurar si la barra de herramientas de ContextHub aparece en el modo de vista previa. Consulte Mostrar y ocultar la interfaz de usuario de ContextHub.

Acerca de las tiendas de ContextHub

Utilice los almacenes de ContextHub para conservar los datos de contexto. ContextHub proporciona los siguientes tipos de tiendas que forman la base de todos los tipos de tiendas:

Todos los tipos de tienda son extensiones de ContextHub.Store.Core Clase . Para obtener información sobre la creación de un nuevo tipo de almacén, consulte Creación de tiendas personalizadas. Para obtener información sobre los tipos de almacén de muestra, consulte Ejemplos de candidatos a la tienda de ContextHub.

Modos de persistencia

Los almacenes de ContextHub utilizan uno de los siguientes modos de persistencia:

  • Local: Utiliza HTML5 localStorage para mantener los datos. El almacenamiento local se mantiene en el explorador en todas las sesiones.
  • Sesión: Utiliza sessionStorage de HTML5 para mantener los datos. El almacenamiento de sesión se mantiene durante la sesión del explorador y está disponible para todas las ventanas del explorador.
  • Cookie: Utiliza la compatibilidad nativa de cookies del explorador para el almacenamiento de datos. Los datos de cookies se envían desde y hacia el servidor en solicitudes HTTP.
  • Window.name: Utiliza la propiedad window.name para mantener los datos.
  • Memoria: Utiliza un objeto Javascript para mantener los datos.

De forma predeterminada, ContextHub utiliza el modo de persistencia local. Si el explorador no admite o no permite HTML5 localStorage, se utiliza la persistencia de sesión. Si el explorador no admite o no permite HTML5 sessionStorage, se utiliza la persistencia Window.name.

Almacenar datos

Internamente, el almacenamiento de datos forma una estructura de árbol, que permite agregar valores como tipos primarios u objetos complejos. Cuando se agregan objetos complejos a los almacenes, las propiedades de objeto forman ramas en el árbol de datos. Por ejemplo, el siguiente objeto complejo se agrega a una ubicación de almacén vacía denominada:

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

La estructura de árbol de los datos del almacén se puede conceptualizar de la siguiente manera:

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

La estructura de árbol define los elementos de datos del almacén como pares clave/valor. En el ejemplo anterior, la clave /number corresponde al valor 321y la clave /data/country corresponde al valor Switzerland.

Manipulación de objetos

ContextHub proporciona ContextHub.Utils.JSON.tree para manipular objetos de JavaScript. Utilice las funciones de esta clase para manipular objetos de JavaScript antes de agregarlos a una tienda o después de obtenerlos de una tienda.

Además, la variable ContextHub.Utils.JSON proporciona funciones para serializar objetos en cadenas y deserializar cadenas en objetos. Utilice esta clase para gestionar datos JSON para admitir exploradores que no incluyan de forma nativa el JSON.parse y JSON.stringify funciones.

Interactuar con las tiendas de ContextHub

Utilice la variable ContextHub Objeto Javascript para obtener un almacén como objeto Javascript. Una vez obtenido el objeto de almacén, puede manipular los datos que contiene. Utilice la variable getAllStores o getStore para obtener el almacén.

Acceso a los datos del almacén

La variable ContexHub.Store.Core La clase Javascript define varias funciones para interactuar con datos de almacenamiento. Las siguientes funciones almacenan y recuperan varios elementos de datos contenidos en objetos:

Los elementos de datos individuales se almacenan como un conjunto de pares clave/valor. Para almacenar y recuperar valores, especifique la clave correspondiente:

Tenga en cuenta que los candidatos de tiendas personalizadas pueden definir funciones adicionales que proporcionan acceso a los datos de almacenamiento.

NOTA

De forma predeterminada, ContextHub no tiene en cuenta el inicio de sesión que se está utilizando en los servidores de publicación y ContextHub considera a estos usuarios como "anónimos".

Puede hacer que ContextHub sepa de los usuarios que iniciaron sesión cargando el almacén de perfiles. Consulte código de muestra en GitHub aquí.

Eventos de ContextHub

ContextHub incluye un marco de eventos que le permite reaccionar automáticamente al almacenar eventos. Cada objeto de almacén contiene un ContextHub.Utils.Eventing objeto que está disponible como eventing propiedad. Utilice la variable on o once para enlazar una función de JavaScript a un evento de tienda.

Uso de ContextHub para manipular cookies

La API de JavaScript de Context Hub proporciona compatibilidad con exploradores múltiples para administrar cookies de exploradores. La variable ContextHub.Utils.Cookie namespace define varias funciones para crear, manipular y eliminar cookies.

Determinación de segmentos de ContextHub resueltos

El motor de segmentos de ContextHub permite determinar cuál de los segmentos registrados se resuelve en el contexto actual. Utilice la función getResolvedSegments de la función ContextHub.SegmentEngine.SegmentManager para recuperar segmentos resueltos. A continuación, utilice el getName o getPath de la función ContextHub.SegmentEngine.Segment para probar un segmento.

Segmentos de ContextHub

Los segmentos de ContextHub se instalan debajo de /conf/<site>/settings/wcm/segments nodo .

Los siguientes segmentos se instalan con la variable Sitio del tutorial de WKND.

  • verano
  • invierno

Las reglas que se utilizan para resolver estos segmentos se resumen de la siguiente manera:

  • Primero, la función geolocalización store se utiliza para determinar la latitud del usuario.
  • A continuación, el elemento de datos del mes de la variable surferinfo store determina en qué temporada se encuentra en esa latitud.
ADVERTENCIA

Los segmentos instalados se proporcionan como configuraciones de referencia para ayudarle a crear su propia configuración dedicada para su proyecto y, como tal, no debe utilizarse directamente.

Depuración de ContextHub

Existen varias opciones para depurar ContextHub, incluida la generación de registros. Consulte Configuración de ContextHub para obtener más información.

Consulte Información general sobre el marco de ContextHub

ContextHub proporciona un página de diagnóstico donde puede ver información general del marco de ContextHub.

En esta página