Adicionar o ContextHub às páginas e acessar armazenamentos

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

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 JavaScript do ContextHub, inclua o contexthub no head da sua página. O código HTL do componente de página deve ser semelhante ao seguinte exemplo:

<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 Visualização. Consulte Exibir e ocultar a interface do usuário do ContextHub.

Sobre armazenamentos do ContextHub

Use armazenamentos do ContextHub para persistir os 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 do ContextHub.Store.Core classe . Para obter informações sobre como criar um novo tipo de armazenamento, consulte Criação de lojas personalizadas. Para obter informações sobre tipos de armazenamentos de amostra, consulte Exemplos 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 manter os dados. O armazenamento local é mantido no navegador em todas as sessões.
  • Sessão: Usa HTML5 sessionStorage para manter os dados. O armazenamento de sessão é mantido pela duração da sessão do navegador e está disponível para todas as janelas do navegador.
  • Cookie: Usa o suporte nativo de cookies do navegador 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 dados.

Por padrão, o Context Hub usa o modo de persistência Local. Se o navegador não suportar ou permitir o HTML5 localStorage, a persistência da sessão será usada. Se o navegador não suportar 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 aos armazenamentos, as propriedades do objeto formam ramificações na árvore de dados. Por exemplo, o seguinte objeto complexo é adicionado a um armazenamento vazio chamado location:

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 de árvore define itens de dados no armazenamento como pares de chave/valor. No exemplo acima, a chave /number corresponde ao valor 321e a tecla /data/country corresponde ao valor Switzerland.

Manipulação de Objetos

O ContextHub fornece a variável ContextHub.Utils.JSON.tree classe 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 variável ContextHub.Utils.JSON A classe fornece funções para serializar objetos para cadeia de caracteres e desserializar cadeias de caracteres para objetos. Use essa classe para manipular dados JSON para suportar navegadores que não incluem nativamente a variável JSON.parse e JSON.stringify funções.

Interagir com armazenamentos do ContextHub

Use o ContextHub Objeto Javascript para obter uma loja como um objeto Javascript. Depois de obter o objeto de armazenamento, você pode manipular os dados que ele contém. Use o getAllStores ou getStore para obter a loja.

Acesso aos dados do armazenamento

O ContexHub.Store.Core A classe 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 para armazenar dados.

OBSERVAÇÃO

Por padrão, o ContextHub não tem conhecimento do logon atualmente usado nos 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 o armazenamento de perfis. Consulte exemplo de código no GitHub aqui.

Eventos do ContextHub

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

Uso do Context Hub para Manipular cookies

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

Determinar segmentos do ContextHub resolvidos

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

Segmentos ContextHub

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

Os seguintes segmentos são instalados com a variável Site tutorial WKND.

  • verão
  • inverno

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

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

Os segmentos instalados são fornecidos como configurações de referência para ajudar você a criar sua própria configuração dedicada para o 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 a 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