Adicionar o ContextHub a páginas e acessar lojas adding-contexthub-to-pages-and-accessing-stores

Adicione o ContextHub às suas páginas para ativar os recursos do ContextHub e para vincular às bibliotecas de JavaScript do ContextHub.

A API do ContextHub JavaScript fornece acesso aos dados de contexto que o ContextHub gerencia. Esta página descreve brevemente os principais recursos da API para acessar e manipular dados de contexto. Siga os links para a documentação de referência da API para ver informações detalhadas e exemplos de código.

Adicionar o ContextHub a um componente de Página adding-contexthub-to-a-page-component

Para habilitar os recursos do ContextHub e vincular às bibliotecas de JavaScript do ContextHub, inclua o componente contexthub na seção head da sua página. O código HTL do seu componente Página deve se parecer com o seguinte exemplo:

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

Você também precisa configurar se a barra de ferramentas do ContextHub aparece no modo de Visualização. Consulte Mostrando e ocultando a interface do usuário do ContextHub.

Sobre as lojas ContextHub about-contexthub-stores

Use os armazenamentos do ContextHub para manter os dados de contexto. O ContextHub fornece os seguintes tipos de armazenamentos que formam a base de todos os tipos de armazenamentos:

Todos os tipos de armazenamento são extensões da classe ContextHub.Store.Core. Para obter informações sobre como criar um tipo de armazenamento, consulte Criando Armazenamentos Personalizados. Para obter informações sobre tipos de armazenamento de exemplo, consulte Amostra de candidatos ao armazenamento do ContextHub.

Modos de persistência persistence-modes

Os armazenamentos do Context Hub usam um dos seguintes modos de persistência:

Por padrão, o Context Hub usa o modo de persistência local. Se o navegador não suportar ou permitir HTML5 localStorage, a persistência de sessão será usada. Se o navegador não suportar ou permitir HTML5 sessionStorage, a persistência Window.name será usada.

Armazenamento de dados store-data

Internamente, os dados de armazenamento formam uma estrutura em árvore, permitindo que os valores sejam adicionados como tipos primários ou objetos complexos. Quando você adiciona objetos complexos a armazenamentos, as propriedades do objeto formam ramificações na árvore de dados. Por exemplo, o seguinte objeto complexo é adicionado a um armazenamento vazio chamado localização:

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

A estrutura de árvore dos dados de armazenamento pode ser conceitualizada da seguinte maneira:

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

A estrutura de árvore define itens de dados no armazenamento como pares de chave/valor. No exemplo acima, a chave /number corresponde ao valor 321, e a chave /data/country corresponde ao valor Switzerland.

Manipulação de objetos manipulating-objects

O ContextHub fornece a classe ContextHub.Utils.JSON.tree para manipular objetos JavaScript. Use as funções dessa classe para manipular objetos JavaScript antes de adicioná-los a um armazenamento ou depois de obtê-los de um armazenamento.

Além disso, a classe ContextHub.Utils.JSON fornece funções para serializar objetos para sequências e desserializar cadeias de caracteres para objetos. Use essa classe para manipular dados JSON para suportar navegadores que não incluem nativamente as funções JSON.parse e JSON.stringify.

Interagir com lojas ContextHub interacting-with-contexthub-stores

Use o objeto JavaScript ContextHub para obter um armazenamento como um objeto JavaScript. Depois de obter o objeto de armazenamento, você pode manipular os dados que ele contém. Use a função getAllStores ou getStore para obter o armazenamento.

Acessar dados da loja accessing-store-data

A classe JavaScript ContexHub.Store.Core define várias funções para interagir com os dados de armazenamento. As funções a seguir armazenam e recuperam vários itens de dados contidos em objetos:

Os itens de dados individuais são armazenados como um conjunto de pares de chave-valor. Para armazenar e recuperar valores, especifique a chave correspondente:

Os candidatos de armazenamento personalizado podem definir funções adicionais que forneçam acesso aos dados armazenados.

Eventos do ContextHub contexthub-eventing

O ContextHub inclui uma estrutura de eventos que permite que você reaja automaticamente aos eventos de armazenamento. Cada objeto de repositório contém um objeto ContextHub.Utils.Eventing que está disponível como a propriedade eventing do repositório. Use a função on ou once para associar uma função JavaScript a um evento de armazenamento.

Utilização do Context Hub para manipular cookies using-context-hub-to-manipulate-cookies

A API do JavaScript do Context Hub oferece suporte entre navegadores para manipular cookies do navegador. O namespace ContextHub.Utils.Cookie define várias funções para criar, manipular e excluir cookies.

Determinar segmentos resolvidos do ContextHub determining-resolved-contexthub-segments

O mecanismo de segmento do ContextHub permite determinar quais dos segmentos registrados são resolvidos no contexto atual. Use a função getResolvedSegments da classe ContextHub.SegmentEngine.SegmentManager para recuperar segmentos resolvidos. Em seguida, use a função getName ou getPath da classe ContextHub.SegmentEngine.Segment para testar um segmento.

Segmentos ContextHub contexthub-segments

Os segmentos do ContextHub são instalados abaixo do nó /conf/<site>/settings/wcm/segments.

Os seguintes segmentos estão instalados com o site de tutorial do WKND.

As regras usadas para resolver esses segmentos são resumidas da seguinte maneira:

Depuração do ContextHub debugging-contexthub

Há várias opções para depurar o ContextHub, incluindo a geração de logs. Consulte Configurando o ContextHub para obter mais informações.

Consulte uma visão geral da estrutura do ContextHub see-an-overview-of-the-contexthub-framework

O ContextHub fornece uma página de diagnósticos, onde você pode ter uma visão geral da estrutura do ContextHub.