Adicionando o ContextHub a páginas e acessando as lojas

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

A API Javascript do ContextHub fornece acesso aos dados de contexto que o ContextHub gerencia. Esta página descreve resumidamente 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

Para ativar os recursos do ContextHub e vincular às bibliotecas do ContextHub Javascript, inclua o componente contexthub na seção head da sua página. O código HTL do componente de sua página deve se assemelhar ao exemplo a seguir:

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

Observe que também é necessário configurar se a barra de ferramentas do ContextHub aparece no modo de Pré-visualização. Consulte Mostrando e Ocultando a interface do usuário do ContextHub.

Sobre as Lojas do ContextHub

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

Todos os tipos de armazenamento são extensões da classe ContextHub.Store.Core. Para obter informações sobre a criação de um novo tipo de armazenamento, consulte Criação de armazenamentos personalizados. Para obter informações sobre tipos de armazenamento de amostra, consulte Amostra de candidatos à loja do ContextHub.

Modos de persistência

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

  • Local: usa HTML5 localStorage para persistir nos dados. O armazenamento local é persistente no navegador entre sessões.
  • Sessão: usa HTML5 sessionStorage para persistir os dados. O armazenamento de sessão é persistente durante a sessão do navegador e está disponível para todas as janelas do navegador.
  • Cookie: usa o suporte nativo do navegador para cookies para armazenamento de dados. Os dados do cookie são enviados para e do servidor em solicitações HTTP.
  • Window.name: Usa a propriedade window.name para persistir os dados.
  • Memória: usa um objeto Javascript para persistir nos dados.

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 da sessão será usada. Se o navegador não oferecer suporte ou permitir o HTML5 sessionStorage, a persistência de Window.name será usada.

Armazenamento de dados

Internamente, armazene formulários de dados em uma estrutura em árvore, permitindo que valores sejam adicionados como tipos primários ou objetos complexos. Quando objetos complexos são adicionados a armazenamentos, as propriedades de objetos formam ramificações na árvore de dados. Por exemplo, o seguinte objeto complexo é adicionado a uma loja vazia com o nome de local:

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

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

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

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

Manipular objetos

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 uma loja ou depois de obtê-los de uma loja.

Além disso, a classe ContextHub.Utils.JSON fornece funções para serialização de objetos em strings e desserialização de strings em 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 as armazenamentos do ContextHub

Use o objeto Javascript ContextHub para obter uma loja como um objeto Javascript. Depois de obter o objeto store, é possível manipular os dados que ele contém. Use a função getAllStores ou getStore para obter a loja.

Acessar dados da loja

A classe ContexHub.Store.Core Javascript define várias funções para interagir com dados de armazenamento. As seguintes funções 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:

Observe que os candidatos a armazenamento personalizado podem definir funções adicionais que fornecem acesso aos dados de armazenamento.

OBSERVAÇÃO

Por padrão, o ContextHub não está ciente do logon atualmente usado em servidores de publicação e esses usuários são considerados pelo ContextHub como "Anônimos".

Você pode tornar o ContextHub ciente dos usuários conectados carregando a loja de perfis. Consulte código de amostra no GitHub aqui.

Eventos do ContextHub

O ContextHub inclui uma estrutura de evento que permite que você reaja automaticamente para armazenar eventos. Cada objeto store contém um objeto ContextHub.Utils.Eventing que está disponível como a propriedade eventing da loja. Use a função on ou once para vincular uma função Javascript a um evento de armazenamento.

Usando o Context Hub para Manipular Cookies

A API Javascript do Context Hub fornece suporte entre navegadores para lidar com cookies de navegadores. A namespace ContextHub.Utils.Cookie define várias funções para criar, manipular e excluir cookies.

Determinando segmentos resolvidos do ContextHub

O mecanismo de segmento ContextHub permite que você determine quais 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

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

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

  • verão
  • inverno

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

  • Primeiro, a loja geolocation é usada para determinar a latitude do usuário.
  • Em seguida, o item de dados do mês do surferinfo store determina qual estação está nessa latitude.
AVISO

Os segmentos instalados são fornecidos como configurações de referência para ajudá-lo a criar sua própria configuração dedicada ao seu projeto e, como tal, não devem ser usados diretamente.

Depuração do ContextHub

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

Consulte uma visão geral da estrutura do ContextHub

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

Nesta página