Referência da API do ContextHub JavaScript contexthub-javascript-api-reference

A API JavaScript do ContextHub estará disponível para os seus scripts quando o componente ContextHub for adicionado à página.

Constantes do ContextHub contexthub-constants

Valores de constante definidos pela API do JavaScript do ContextHub.

Constantes de evento event-constants

A tabela a seguir lista os eventos de nomes que ocorrem para as Lojas do ContextHub. Consulte também ContextHub.Utils.Eventing.

Constante
Descrição
Valor
ContextHub.Constants.EVENT_NAMESPACE
Namespace de evento do ContextHub
ch
ContextHub.Constants.EVENT_ALL_STORES_READY
Indica que todos os armazenamentos necessários estão registrados, inicializados e prontos para serem consumidos
todas as lojas prontas
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY
Indica que nem todos os armazenamentos foram inicializados dentro de um determinado tempo limite
lojas-parcialmente-prontas
ContextHub.Constants.EVENT_STORE_REGISTERED
Acionado quando um armazenamento é registrado
registrado na loja
ContextHub.Constants.EVENT_STORE_READY
Indica que o armazenamento está pronto para funcionar. É acionado imediatamente após o registro, exceto armazenamentos JSONP, em que é acionado quando os dados são buscados).
pronto para armazenamento
ContextHub.Constants.EVENT_STORE_UPDATED
Acionado quando um armazenamento atualiza sua persistência
armazenamento atualizado
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME
Nome do container de persistência
ContextHubPersistence
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY
Armazena um nome de chave de persistência específico onde o resultado JSON bruto é armazenado
/_/raw-response
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY
Armazena um carimbo de data e hora específico que indica quando os dados JSON foram buscados
/_/response-time
ContextHub.Constants.SERVICE_LAST_URL_KEY
Armazena o URL específico do serviço JSON usado durante a última chamada
/_/url
ContextHub.Constants.IS_CONTAINER_EXPANDED
Indica se a interface do usuário do ContextHub é expandida
/_/container-expand

Constantes de evento da interface do usuário ui-event-constants

A tabela a seguir lista os nomes dos eventos que ocorrem para a interface do usuário do ContextHub.

Constante
Descrição
Valor
ContextHub.Constants.EVENT_UI_MODE_REGISTERED
Acionado quando um modo é registrado
ui-mode-registered
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED
Acionado quando um modo tem registro cancelado
ui-mode-unregistered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED
Acionado quando um renderizador de modo é registrado
ui-mode-renderer-registered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED
Acionado quando um renderizador de modo não está registrado
ui-mode-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODE_ADDED
Acionado quando um novo modo é adicionado
ui-mode-Added
ContextHub.Constants.EVENT_UI_MODE_REMOVED
Acionado quando um modo é removido
ui-mode-removed
ContextHub.Constants.EVENT_UI_MODE_SELECTED
Acionado quando um modo é selecionado pelo usuário
modo ui-selecionado
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED
Acionado quando um novo módulo é registrado
ui-module-registered
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED
Acionado quando um módulo não está registrado
ui-module-unregistered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED
Acionado quando um renderizador de módulo é registrado
ui-module-renderer-registered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED
Acionado quando um renderizador de módulo não está registrado
ui-module-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODULE_ADDED
Acionado quando um novo módulo é adicionado
ui-module-Added
ContextHub.Constants.EVENT_UI_MODULE_REMOVED
Acionado quando um módulo é removido
ui-module-removed
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED
Acionado quando o contêiner da interface do usuário é adicionado à página
ui-container-Added
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED
Acionado quando a interface do usuário do ContextHub é aberta
ui-container-opened
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED
Acionado quando a interface do ContextHub é recolhida
ui-container-closed
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED
Acionado quando uma propriedade é modificada
ui-property-modified
ContextHub.Constants.EVENT_UI_RENDERED
Acionado sempre que a interface do usuário do ContextHub é renderizada (por exemplo, após uma alteração de propriedade)
renderizado pela interface
ContextHub.Constants.EVENT_UI_INITIALIZED
Acionado quando o contêiner da interface do usuário é inicializado
inicializado por interface do usuário
ContextHub.Constants.ACTIVE_UI_MODE
Indica o modo da interface do usuário ativa
/_/ative-ui-mode

Referência da API do ContextHub JavaScript contexthub-javascript-api-reference-2

O objeto ContextHub fornece acesso a todos os armazenamentos.

Funções (ContextHub) functions-contexthub

getAllStores() getallstores

Retorna todos os armazenamentos registrados do ContextHub.

Esta função não tem parâmetros.

Devoluções

Um objeto que contém todos os armazenamentos do ContextHub. Cada armazenamento é um objeto que usa o mesmo nome do armazenamento.

Exemplo

O exemplo a seguir recupera todos os armazenamentos e, em seguida, recupera o armazenamento de geolocalização:

var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation

getStore(nome) getstore-name

Recupera um armazenamento como um objeto do JavaScript.

Parâmetros

  • nome: O nome com o qual o armazenamento foi registrado.

Devoluções

Um objeto que representa o armazenamento.

Exemplo

O exemplo a seguir recupera o armazenamento de geolocalização:

var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Representa um segmento do ContextHub. Use o ContextHub.SegmentEngine.SegmentManager para obter segmentos.

Funções (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment

getName() getname

Retorna o nome do segmento como um valor de String.

getPath() getpath

Retorna o caminho do repositório da definição de segmento como um valor String.

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Fornece acesso aos segmentos do ContextHub.

Funções (ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

Retorna os segmentos resolvidos no contexto atual. Esta função não tem parâmetros.

Devoluções

Uma matriz de objetos ContextHub.SegmentEngine.Segment.

ContextHub.Store.Core contexthub-store-core

A classe base para armazenamentos do ContextHub.

Propriedades (ContextHub.Store.Core) properties-contexthub-store-core

evento eventing

Um objeto ContextHub.Utils.Eventing. Use esse objeto para funções de vinculação para armazenar eventos. Para obter informações sobre o valor padrão e a inicialização, consulte init(name,config).

name name

O nome do armazenamento.

persistência persistence

Um objeto ContextHub.Utils.Persistence. Para obter informações sobre o valor padrão e a inicialização, consulte [init(name,config)](https://experienceleague.adobe.com/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.html?lang=pt-BR#init-name-config).

Funções (ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(árvore, opções) addallitems-tree-options

Mescla um objeto de dados ou uma matriz com os dados armazenados. Cada par de chave/valor no objeto ou matriz é adicionado ao armazenamento (por meio da função setItem):

  • Objeto: Chaves são os nomes de propriedade.
  • Matriz: as chaves são os índices de matriz.

Observe que os valores podem ser objetos.

Parâmetros

  • árvore: (Objeto ou matriz) Os dados a serem adicionados ao repositório.
  • options: (Object) um objeto opcional de opções passado para a função setItem. Para obter informações, consulte o parâmetro options de setItem(chave,valor,opções).

Devoluções

Um valor boolean:

  • Um valor de true indica que o objeto de dados foi armazenado.
  • Um valor de false indica que o armazenamento de dados não foi alterado.

addReference(key, anotherKey) addreference-key-anotherkey

Cria uma referência de uma chave para outra. Uma chave não pode fazer referência a si mesma.

Parâmetros

  • chave: a chave que faz referência a anotherKey.

  • anotherkey: A chave referenciada por key.

Devoluções

Um valor boolean:

  • Um valor de true indica que a referência foi adicionada.
  • Um valor de false indica que nenhuma referência foi adicionada.

announcementReadiness() announcereadiness

Aciona o evento ready para este armazenamento. Esta função não tem parâmetros e não retorna nenhum valor.

clean() clean

Remove todos os dados do armazenamento. A função não tem parâmetros e nenhum valor de retorno.

getItem(key) getitem-key

Retorna o valor associado a uma chave.

Parâmetros

  • chave: (Cadeia de caracteres) A chave para a qual retornar o valor.

Devoluções

Um Objeto que representa o valor da chave.

getKeys(includeInternals) getkeys-includeinternals

Recupera as chaves do armazenamento. Como opção, você pode recuperar as chaves usadas internamente pela estrutura do ContextHub.

Parâmetros

  • includeInternals: Um valor de true inclui chaves usadas internamente nos resultados. Essas teclas começam com o caractere de sublinhado ("_"). O valor padrão é false.

Devoluções

Uma matriz de nomes de chave ( string valores).

getReferences() getreferences

Recupera as referências do armazenamento.

Devoluções

Uma matriz que usa chaves de referência como índices para as chaves referenciadas:

  • As chaves de referência correspondem ao parâmetro key da função addReference.

  • As chaves referenciadas correspondem ao parâmetro anotherKey da função addReference.

getTree(includeInternals) gettree-includeinternals

Recupera a árvore de dados do armazenamento. Como opção, inclua os pares chave/valor usados internamente pela estrutura do ContextHub.

Parâmetros

  • includeInternals: Um valor de true inclui pares de chave/valor usados internamente nos resultados. As teclas desses dados começam com o caractere de sublinhado ("_"). O valor padrão é false.

Devoluções

Um objeto que representa a árvore de dados. As chaves são os nomes de propriedade do objeto.

init(nome, configuração) init-name-config

Inicializa o armazenamento.

  • Define os dados de armazenamento como um objeto vazio.

  • Define as referências de armazenamento para um objeto vazio.

  • EventChannel são os dados:name, onde name é o nome do armazenamento.

  • O storeDataKey é /store/name, onde name é o nome do armazenamento.

Parâmetros

  • nome: O nome do armazenamento.

  • config: um objeto que contém propriedades de configuração:

    • eventDeferring: o valor padrão é 32.
    • eventing: o objeto ContextHub.Utils.Eventing para este armazenamento. O valor padrão é o objeto ContextHub.eventing usa.
    • persistência: o objeto ContextHub.Utils.Persistence desse armazenamento. O valor padrão é o objeto ContextHub.persistence.

isEventingPaused() iseventingpaused

Determina se o evento está pausado para este armazenamento.

Devoluções

Um valor booleano:

  • true: o evento está pausado para que nenhum evento seja acionado para este armazenamento.
  • false: o evento não está pausado para que os eventos sejam acionados para este armazenamento.

pauseEventing() pauseeventing

Pausa o evento do armazenamento para que nenhum evento seja acionado. Esta função não requer parâmetros e não retorna nenhum valor.

removeItem(chave, opções) removeitem-key-options

Remove um par de chave/valor do armazenamento.

Quando uma chave é removida, a função aciona o evento data. Os dados do evento incluem o nome do armazenamento, o nome da chave que foi removida, o valor que foi removido, o novo valor para a chave (nulo) e o tipo de ação de "remover".

Como opção, você pode impedir o acionamento do evento data.

Parâmetros

  • chave: (Cadeia de caracteres) O nome da chave a ser removida.

  • opções: (Objeto) Um objeto de opções. As seguintes propriedades de objeto são válidas:

    • silencioso: um valor de true impede o acionamento do evento data. O valor padrão é false.

Devoluções

Um valor boolean:

  • Um valor de true indica que o par chave/valor foi removido.
  • Um valor de false indica que o armazenamento de dados não foi alterado porque a chave não foi encontrada no armazenamento.

removeReference(key) removereference-key

Remove uma referência do armazenamento.

Parâmetros

  • chave: a referência de chave a ser removida. Este parâmetro corresponde ao parâmetro key da função addReference.

Devoluções

Um valor boolean:

  • Um valor de true indica que a referência foi removida.
  • Um valor de false indica que a chave não era válida e o armazenamento não foi alterado.

redefinir(keepRemainingData) reset-keepremainingdata

Redefine os valores iniciais dos dados persistentes do armazenamento. Como opção, você pode remover todos os outros dados do armazenamento. O evento está pausado para este armazenamento enquanto o armazenamento é redefinido. Esta função não retorna nenhum valor.

Os valores iniciais são fornecidos na propriedade initialValues do objeto de configuração usado para instanciar o objeto de armazenamento.

Parâmetros

  • keepRemainingData: (Booleano) Um valor true faz com que os dados não iniciais sejam mantidos. Um valor false faz com que todos os dados sejam removidos, exceto os valores iniciais.

Redefine os valores iniciais dos dados persistentes do armazenamento. Como opção, você pode remover todos os outros dados do armazenamento. O evento está pausado para este armazenamento enquanto o armazenamento é redefinido. Esta função não retorna nenhum valor.

Os valores iniciais são fornecidos na propriedade initialValues do objeto de configuração usado para instanciar o objeto de armazenamento.

Parâmetros

  • keepRemainingData: (booleano) um valor true faz com que os dados não iniciais sejam mantidos. Um valor false faz com que todos os dados sejam removidos, exceto os valores iniciais.

resolveReference(key, retry) resolvereference-key-retry

Recupera uma chave referenciada. Opcionalmente, você pode especificar o número de iterações a serem usadas para resolver a melhor correspondência.

Parâmetros

  • chave: (Cadeia de caracteres) A chave para a qual resolver a referência. Este parâmetro key corresponde ao parâmetro key da função addReference.

  • tentar novamente: (Número) O número de iterações a serem usadas.

Devoluções

Um valor string que representa a chave referenciada. Se nenhuma referência for resolvida, o valor do parâmetro key será retornado.

resumeEventing() resumeeventing

Retoma os eventos deste armazenamento para que eles sejam acionados. Esta função não define parâmetros e não retorna nenhum valor.

setItem(chave, valor, opções) setitem-key-value-options

Adiciona um par de chave/valor ao armazenamento.

Aciona o evento data somente se o valor da chave for diferente do valor armazenado atualmente para a chave. Opcionalmente, você pode impedir o acionamento do evento data.

Os dados do evento incluem o nome do armazenamento, a chave, o valor anterior, o novo valor e o tipo de ação de set.

Parâmetros

  • chave: (Cadeia de caracteres) O nome da chave.

  • opções: (Objeto) Um objeto de opções. As seguintes propriedades de objeto são válidas:

    • silencioso: um valor de true impede o acionamento do evento data. O valor padrão é false.
  • value: (Objeto) O valor a ser associado à chave.

Devoluções

Um valor boolean:

  • Um valor de true indica que o objeto de dados foi armazenado.
  • Um valor de false indica que o armazenamento de dados não foi alterado.

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Um armazenamento que contém dados JSON. Os dados são recuperados de um serviço JSONP externo ou, opcionalmente, de um serviço que retorna dados JSON. Especifique os detalhes do serviço usando a função init ao criar uma instância dessa classe.

O armazenamento usa a persistência na memória (variável do JavaScript). Os dados de armazenamento estão disponíveis somente durante o tempo de vida da página.

ContextHub.Store.JSONPStore estende ContextHub.Store.Core e herda as funções dessa classe.

Funções (ContextHub.Store.JSONPStore) functions-contexthub-store-jsonpstore

configureService(serviceConfig, substituição) configureservice-serviceconfig-override

Configura os detalhes para a conexão com o serviço JSONP que este objeto usa. Você pode atualizar ou substituir a configuração existente. A função não retorna nenhum valor.

Parâmetros

  • serviceConfig: um objeto que contém as seguintes propriedades:

    • host: (String) O nome ou endereço IP do servidor.

    • jsonp: (Booleano) Um valor true indica que o serviço é um serviço JSONP; caso contrário, false. Quando verdadeiro, o {callback: "ContextHub.Callbacks.O objeto Object.name} foi adicionado ao objeto service.params.

    • params: (Objeto) Parâmetros de URL representados como propriedades de objeto. Os nomes dos parâmetros são nomes de propriedades e os valores dos parâmetros são valores de propriedades.

    • path: (String) O caminho para o serviço.

    • porta: (Número) O número da porta do serviço.

    • secure: (String ou Booleano) Determina o protocolo a ser usado para o URL do serviço:

      • auto: //
      • true: https://
      • false: https://
  • substituição: (Booleano). Um valor de true faz com que a configuração de serviço existente seja substituída pelas propriedades de serviceConfig. Um valor de false faz com que as propriedades de configuração de serviço existentes sejam mescladas com as propriedades de serviceConfig.

getRawResponse() getrawresponse

Retorna a resposta bruta armazenada em cache desde a última chamada para o serviço JSONP. A função não requer parâmetros.

Devoluções

Um objeto que representa a resposta bruta.

getServiceDetails() getservicedetails

Recupera o objeto de serviço para este objeto ContextHub.Store.JSONPStore. O objeto de serviço contém todas as informações necessárias para criar o URL do serviço.

Devoluções

Um objeto com as seguintes propriedades:

  • host: (Cadeia de caracteres) O nome ou endereço IP do servidor.

  • jsonp: (Booleano) Um valor true indica que o serviço é um serviço JSONP; caso contrário, false. Quando verdadeiro, o {callback: "ContextHub.Callbacks.O objeto Object.name} foi adicionado ao objeto service.params.

  • parâmetros: parâmetros (Objeto) de URL representados como propriedades de objeto. Os nomes dos parâmetros são nomes de propriedades e os valores dos parâmetros são valores de propriedades.

  • caminho: (Cadeia de caracteres) O caminho para o serviço.

  • porta: (Número) O número da porta do serviço.

  • secure: (Cadeia de caracteres ou Booleano) Determina o protocolo a ser usado para a URL do serviço:

    • auto: //
    • true: https://
    • false: https://

getServiceURL(resolver) getserviceurl-resolve

Recupera o URL do serviço JSONP.

Parâmetros

  • resolver: (Booleano) Determina se os parâmetros resolvidos devem ser incluídos na URL. Um valor de true resolve parâmetros, mas false não.

Devoluções

Um valor string que representa a URL do serviço.

init(nome, configuração) init-name-config-1

inicializa o objeto ContextHub.Store.JSONPStore.

Parâmetros

  • nome: (Cadeia de caracteres) O nome do armazenamento.

  • config: (Objeto) Um objeto que contém a propriedade de serviço. O objeto JSONPStore usa as propriedades do objeto service para construir a URL do serviço JSONP:

    • eventDeferring: 32.

    • eventing: o objeto ContextHub.Utils.Eventing para esse armazenamento. O valor padrão é o objeto ContextHub.eventing.

    • persistência: o objeto ContextHub.Utils.Persistence desse armazenamento. Por padrão, a persistência de memória é usada (objeto JavaScript).

    • service: (Objeto)

      • host: (String) O nome ou endereço IP do servidor.

      • jsonp: (Booleano) Um valor true indica que o serviço é um serviço JSONP; caso contrário, false. Quando verdadeiro, o objeto {callback: "ContextHub.Callbacks.*Object.name*} é adicionado a service.params.

      • params: (Objeto) Parâmetros de URL representados como propriedades de objeto. Os nomes e valores de parâmetros são os nomes e valores de propriedades de objetos, respectivamente.

      • path: (String) O caminho para o serviço.

      • porta: (Número) O número da porta do serviço.

      • secure: (String ou Booleano) Determina o protocolo a ser usado para o URL do serviço:

        • auto: //
        • true: https://
        • false: https://
      • timeout: (Número) A quantidade de tempo de espera para que o serviço JSONP responda antes de atingir o timeout, em milissegundos.

      • ttl: O tempo mínimo em milissegundos decorrido entre chamadas para o serviço JSONP. (Consulte a função queryService).

queryService(reload) queryservice-reload

Consulta o serviço JSONP remoto e armazena a resposta em cache. Se o tempo desde a chamada anterior para essa função for menor que o valor de config.service.ttl, o serviço não será chamado e a resposta em cache não será alterada. Como opção, você pode forçar a chamada do serviço. A propriedade config.service.ttl é definida ao chamar a função init para inicializar o armazenamento.

Aciona o evento pronto quando a consulta é concluída. Se o URL do serviço JSONP não estiver definido, a função não fará nada.

Parâmetros

  • reload: (Booleano) Um valor true remove a resposta em cache e força o serviço JSONP a ser chamado.

redefinir reset

Redefine os valores iniciais dos dados persistentes do armazenamento e, em seguida, chama o serviço JSONP. Como opção, você pode remover todos os outros dados do armazenamento. O evento é pausado para este armazenamento enquanto os valores iniciais são redefinidos. Esta função não retorna nenhum valor.

Os valores iniciais são fornecidos na propriedade initialValues do objeto de configuração usado para instanciar o objeto de armazenamento.

Parâmetros

  • keepRemainingData: (Booleano) Um valor true faz com que os dados não iniciais sejam mantidos. Um valor false faz com que todos os dados sejam removidos, exceto os valores iniciais.

resolveParameter(f) resolveparameter-f

Resolve o parâmetro fornecido.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore estende ContextHub.Store.JSONPStore para herdar todas as funções dessa classe. No entanto, os dados recuperados do serviço JSONP são mantidos de acordo com a configuração da persistência do ContextHub. (Consulte Modos de Persistência.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore estende ContextHub.Store.Core para herdar todas as funções dessa classe. Os dados nesse armazenamento são mantidos de acordo com a configuração da persistência do ContextHub.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore estende ContextHub.Store.Core para herdar todas as funções dessa classe. Os dados neste armazenamento são mantidos usando a persistência na memória (objeto JavaScript).

ContextHub.UI contexthub-ui

Gerencia módulos de interface do usuário e renderizadores de módulo de interface do usuário.

Funções (ContextHub.UI) functions-contexthub-ui

registerRenderer(moduleType, renderizador, dontRender) registerrenderer-moduletype-renderer-dontrender

Registra um renderizador de módulo de interface do usuário no ContextHub. Depois que o renderizador é registrado, ele pode ser usado para criar módulos de interface. Use esta função quando você estiver estendendo ContextHub.UI.BaseModuleRenderer para criar um renderizador de Módulo de Interface do Usuário personalizado.

Parâmetros

  • moduleType: (Cadeia de Caracteres) O identificador do renderizador do módulo da interface do usuário. Se um renderizador já estiver registrado usando o valor especificado, o renderizador existente terá o registro cancelado antes que esse renderizador seja registrado.
  • renderizador: (Cadeia de caracteres) O nome da classe que renderiza o módulo de interface do usuário.
  • dontRender: (Booleano) Definido como true para impedir que a interface do usuário do ContextHub seja renderizada depois que o renderizador for registrado. O valor padrão é false.

Exemplo

O exemplo a seguir registra um renderizador como o tipo de módulo contexthub.browserinfo.

ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

Uma classe de utilitário para interagir com cookies.

exists(key) exists-key

Determina se um cookie existe.

Parâmetros

  • chave: uma String que contém a chave do cookie para o qual você está testando.

Devoluções

Um valor boolean true indica que o cookie existe.

Exemplo

if (ContextHub.Utils.Cookie.exists("name")) {
   // conditionally-executed code
}

getAllItems(filtro) getallitems-filter

Retorna todos os cookies com chaves que correspondem a um filtro.

Parâmetros

  • (Opcional) filtro: Critérios para chaves de cookies correspondentes. Para retornar todos os cookies, não especifique nenhum valor. Os seguintes tipos são compatíveis:

    • String: a string é comparada com a chave do cookie.
    • Matriz: cada item na matriz é um filtro.
    • Um objeto RegExp: a função de teste do objeto é usada para corresponder chaves de cookie.
    • Uma função: uma função que testa uma correspondência em uma chave de cookie. A função deve tomar a chave do cookie como um parâmetro e retornar verdadeiro se o teste confirmar uma correspondência.

Devoluções

Um objeto de cookies. As propriedades do objeto são chaves de cookie e os valores de chave são valores de cookie.

Exemplo

ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])

getItem(key) getitem-key-1

Retorna um valor de cookie.

Parâmetros

  • chave: a chave do cookie para o qual você deseja o valor.

Devoluções

O valor do cookie, ou null se nenhum cookie foi encontrado para a chave.

Exemplo

ContextHub.Utils.Cookie.getItem("name");

getKeys(filtro) getkeys-filter

Retorna uma matriz das chaves de cookies existentes que correspondem a um filtro.

Parâmetros

  • Filtro: Critérios para chaves de cookies correspondentes. Os seguintes tipos são compatíveis:

    • String: a string é comparada com a chave do cookie.
    • Matriz: cada item na matriz é um filtro.
    • Um objeto RegExp: a função de teste do objeto é usada para corresponder chaves de cookie.
    • Uma função: uma função que testa uma correspondência em uma chave de cookie. A função deve tomar a chave do cookie como um parâmetro e retornar true se o teste confirmar uma correspondência.

Devoluções

Uma matriz de strings em que cada string é a chave de um cookie que corresponde ao filtro.

Exemplo

ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])

removeItem(chave, opções) removeitem-key-options-1

Remove um cookie. Para remover o cookie, o valor é definido como uma string vazia e a data de expiração é definida como o dia antes da data atual.

Parâmetros

  • chave: um valor String que representa a chave do cookie a ser removido.

  • opções: um objeto que contém valores de propriedade para configurar os atributos de cookie. Consulte a função [setItem](https://experienceleague.adobe.com/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.html?lang=pt-BR#setitem-key-value-options) para obter informações. A propriedade expires não tem efeito.

Devoluções

Esta função não retorna um valor.

Exemplo

ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);

setItem(chave, valor, opções) setitem-key-value-options-1

Cria um cookie com a chave e o valor fornecidos e adiciona o cookie ao documento atual. Opcionalmente, você pode especificar opções que configuram os atributos do cookie.

Parâmetros

  • chave: uma cadeia de caracteres que contém a chave do cookie.

  • valor: uma cadeia de caracteres que contém o valor do cookie.

  • opções: (opcional) um objeto que contém qualquer uma das seguintes propriedades que configuram os atributos do cookie:

    • expires: um valor date ou number que especifica quando o cookie expira. Um valor de data especifica o tempo absoluto de expiração. Um número (em dias) define a hora de expiração para a hora atual mais o número. O valor padrão é undefined.
    • seguro: Um valor boolean que especifica o atributo Secure do cookie. O valor padrão é false.
    • caminho: um valor String para usar como o atributo Path do cookie. O valor padrão é undefined.

Devoluções

O cookie com o valor definido.

Exemplo

ContextHub.Utils.Cookie.setItem("name", "mycookie", {
    expires: 3,
    domain: 'localhost',
    path: '/some/directory',
    secure: true
});

desaparecer (filtro, opções) vanish-filter-options

Remove todos os cookies que correspondem a um determinado filtro. Os cookies são correspondidos usando a função getKeys e removidos usando a função removeItem.

Parâmetros

  • filtro: o argumento filter a ser usado na chamada para a função [getKeys](/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.md#getkeys-filter).

  • opções: o argumento options a ser usado na chamada para a função [removeItem](/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.md#removeitem-key-options).

Devoluções

Esta função não retorna um valor.

ContextHub.Utils.Eventing contexthub-utils-eventing

Permite vincular e desvincular funções a eventos de armazenamento do ContextHub. Acesse objetos ContextHub.Utils.Eventing para um repositório usando a propriedade eventing do repositório.

Funções (ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off(nome, seletor) off-name-selector

Desassocia uma função de um evento.

Parâmetros

  • nome: O nome do evento para o qual você está desassociando a função.

  • seletor: o seletor que identifica a associação. (Consulte o parâmetro selector para as funções on e once).

Devoluções

Esta função não retorna nenhum valor.

on(nome, manipulador, seletor, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

Vincula uma função a um evento. A função é chamada sempre que o evento ocorre. Como opção, a função pode ser chamada para eventos que ocorreram no passado, antes que a vinculação seja estabelecida.

Parâmetros

  • nome: (Cadeia de caracteres) O nome do evento ao qual você está associando a função.

  • manipulador: (Função) A função a ser associada ao evento.

  • seletor: (Cadeia de caracteres) Um identificador exclusivo para a associação. Você precisa do seletor para identificar a associação se quiser usar a função off para remover a associação.

  • triggerForPastEvents: (Booleano) Indica se o manipulador deve ser executado para eventos que ocorreram no passado. Um valor de true chama o manipulador de eventos anteriores. Um valor de false chama o manipulador para eventos futuros. O valor padrão é true.

Devoluções

Quando o argumento triggerForPastEvents é true, essa função retorna um valor boolean que indica se o evento ocorreu no passado:

  • true: O evento ocorreu no passado e o manipulador será chamado.
  • false: O evento não ocorreu no passado.

Se triggerForPastEvents for false, essa função não retornará nenhum valor.

Exemplo

O exemplo a seguir vincula uma função ao evento de dados do armazenamento de geolocalização. A função preenche um elemento na página com o valor do item de dados de latitude do armazenamento.

<div class="location">
    <p>latitude: <span id="lat"></span></p>
</div>

<script>
    var geostore = ContextHub.getStore("geolocation");
    geostore.eventing.on(ContextHub.Constants.EVENT_DATA_UPDATE,getlat,"getlat");

    function getlat(){
       latitude = geostore.getItem("latitude");
       $("#lat").html(latitude);
    }
</script>

once(nome, manipulador, seletor, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

Vincula uma função a um evento. A função é chamada apenas uma vez, para a primeira ocorrência do evento. Como opção, a função pode ser chamada para o evento que ocorreu no passado, antes que a vinculação seja estabelecida.

Parâmetros

  • nome: (Cadeia de caracteres) O nome do evento ao qual você está associando a função.

  • manipulador: (Função) A função a ser associada ao evento.

  • seletor: (Cadeia de caracteres) Um identificador exclusivo para a associação. Você precisa do seletor para identificar a associação se quiser usar a função off para remover a associação.

  • triggerForPastEvents: (Booleano) Indica se o manipulador deve ser executado para eventos que ocorreram no passado. Um valor de true chama o manipulador de eventos anteriores. Um valor de false chama o manipulador para eventos futuros. O valor padrão é true.

Devoluções

Quando o argumento triggerForPastEvents é true, essa função retorna um valor boolean que indica se o evento ocorreu no passado:

  • true: O evento ocorreu no passado e o manipulador será chamado.
  • false: O evento não ocorreu no passado.

Se triggerForPastEvents for false, essa função não retornará nenhum valor.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Uma classe de utilitário que permite que um objeto herde as propriedades e os métodos de outro objeto.

Funções (ContextHub.Utils.inheritance) functions-contexthub-utils-inheritance

inherit(filho, pai) inherit-child-parent

Faz um objeto herdar as propriedades e os métodos de outro objeto.

Parâmetros

  • filho: (Objeto) O objeto que herda.
  • parent: (Objeto) O objeto que define as propriedades e os métodos herdados.

ContextHub.Utils.JSON contexthub-utils-json

Fornece funções para serializar objetos no formato JSON e desserializar strings JSON em objetos.

Funções (ContextHub.Utils.JSON) functions-contexthub-utils-json

parse(data) parse-data

Analisa um valor de string como JSON e o converte em um objeto javascript.

Parâmetros

  • dados: um valor de cadeia de caracteres em formato JSON.

Devoluções

Um objeto do JavaScript.

Exemplo

O código ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); retorna o seguinte objeto:

Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(dados) stringify-data

Serializa valores e objetos do JavaScript em valores de string do formato JSON.

Parâmetros

  • dados: o valor ou objeto a ser serializado. Esta função oferece suporte a valores booleanos, de matriz, número, sequência de caracteres e data.

Devoluções

O valor da string serializada. Quando data é um valor R egExp, esta função retorna um objeto vazio. Quando data é uma função, retorna undefined.

Exemplo

O código a seguir retorna "{'city':'Basel','country':'Switzerland','population':'173330'}":

ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

ContextHub.Utils.JSON.tree contexthub-utils-json-tree

Essa classe facilita a manipulação de objetos de dados que serão armazenados ou recuperados dos armazenamentos do ContextHub.

Funções (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree

addAllItems() addallitems

Cria uma cópia de um objeto de dados e adiciona a ele a árvore de dados de um segundo objeto. A função retorna a cópia e não modifica nenhum dos objetos originais. Quando as árvores de dados dos dois objetos contêm chaves idênticas, o valor do segundo objeto substitui o valor do primeiro objeto.

Parâmetros

  • árvore: o objeto copiado.
  • secondTree: O objeto mesclado com a cópia do objeto tree.

Devoluções

Um objeto que contém os dados mesclados.

cleanup() cleanup

Cria uma cópia de um objeto, localiza e remove itens na árvore de dados que não contêm valores, valores nulos ou valores indefinidos e retorna a cópia.

Parâmetros

  • árvore: o objeto a ser limpo.

Devoluções

Uma cópia da árvore que é limpa.

getItem() getitem

Recupera o valor de um objeto para a chave.

Parâmetros

  • árvore: o objeto de dados.
  • chave: a chave do valor que você deseja recuperar.

Devoluções

O valor que corresponde à chave. Quando a chave tem chaves filhas, essa função retorna um objeto complexo. Quando o tipo do valor da chave é undefined, null é retornado.

Exemplo

Considere o seguinte objeto do JavaScript:

myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

O código de exemplo a seguir retorna o valor 260:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

O código de exemplo a seguir recupera o valor de uma chave que tem chaves filhas:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

A função retorna o seguinte objeto:

Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys() getkeys

Recupera todas as chaves da árvore de dados de um objeto. Como opção, você pode recuperar somente as chaves dos filhos de uma chave específica. Também é possível especificar uma ordem de classificação das chaves recuperadas.

Parâmetros

  • árvore: o objeto do qual recuperar as chaves da árvore de dados.
  • pai: (opcional) a chave de um item na árvore de dados para o qual você deseja recuperar as chaves dos itens filho.
  • ordem: (Opcional) Uma função que determina a ordem de classificação das chaves retornadas. (Consulte Array.prototype.sort no Mozilla Developer Network.)

Devoluções

Uma matriz de chaves.

Exemplo

Considere o seguinte objeto:

myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

O script ContextHub.Utils.JSON.tree.getKeys(myObject); retorna a seguinte matriz:

["/location", "/location/city", "/location/country", "/location/latitude", "/location/longitude", "/location/weather", "/location/weather/humidity", "/location/weather/precipitation", "/location/weather/temperature", "/location/weather/wind"]

removeItem() removeitem

Cria uma cópia de um determinado objeto, remove a ramificação especificada da árvore de dados e retorna a cópia modificada.

Parâmetros

  • árvore: um objeto de dados.
  • key: a chave a ser removida.

Devoluções

Uma cópia do objeto de dados original com a chave removida.

Exemplo

Considere o seguinte objeto:

myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

O exemplo de script a seguir remove a ramificação /um/dois/três/quatro da árvore de dados:

myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

A função retorna o seguinte objeto:

myObject {
  one: {
    foo: "bar"
  }
}

sanitizeKey(key) sanitizekey-key

Limpa os valores da string para torná-los utilizáveis como chaves. Para limpar uma string, essa função executa as seguintes ações:

  • Reduz várias barras consecutivas a uma única barra.
  • Remove os espaços em branco do início e do fim da sequência de caracteres.
  • Divide o resultado em uma matriz de strings demarcadas por barras.

Use a matriz resultante para criar uma chave utilizável. Parâmetros

  • chave: o string para limpar.

Devoluções

Uma matriz de string valores em que cada cadeia de caracteres é a parte de key que foi demarcada por barras. representa a chave limpa. Se a matriz limpa tiver comprimento zero, essa função retornará null.

Exemplo

O código a seguir limpa uma cadeia de caracteres para produzir a matriz ["this", "is", "a", "path"] e, em seguida, gera a chave "/this/is/a/path" da matriz:

var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(árvore, chave, valor) setitem-tree-key-value

Adiciona um par de chave/valor à árvore de dados de uma cópia de um objeto. Para obter informações sobre árvores de dados, consulte Persistência.

Parâmetros

  • árvore: um objeto de dados.
  • key: a chave a ser associada ao valor que você está adicionando. A chave é o caminho para o item na árvore de dados. Esta função chama ContextHub.Utils.JSON.tree.sanitize para limpar a chave antes de adicioná-la.
  • value: o valor a ser adicionado à árvore de dados.

Devoluções

Uma cópia do objeto tree que inclui o par key/ value.

Exemplo

Considere o seguinte código JavaScript:

var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

var myKey = "/user/location/details";

var myValue = {
      population: 173330,
      elevation: 260
     };

myObject = ContextHub.Utils.JSON.tree.setItem(myObject, myKey, myValue);

O objeto myObject tem o seguinte valor:

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

Permite registrar candidatos de armazenamento e obter candidatos registrados.

Funções (ContextHub.Utils.storeCandidates) functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Retorna os tipos de armazenamento registrados como candidatos de armazenamento. Recupere os candidatos registrados de um tipo de armazenamento específico ou de todos os tipos de armazenamento.

Parâmetros

Devoluções

Um objeto de tipos de armazenamento. As propriedades do objeto são os nomes do tipo de armazenamento e os valores da propriedade são uma matriz de candidatos de armazenamento registrados.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Retorna um tipo de armazenamento dos candidatos registrados. Se mais de um tipo de armazenamento com o mesmo nome for registrado, a função retornará o tipo de armazenamento com a prioridade mais alta.

Parâmetros

Devoluções

Um objeto que representa o candidato de armazenamento registrado. Se o Tipo de armazenamento solicitado não estiver registrado, um erro será lançado.

getSupportedStoreTypes() getsupportedstoretypes

Retorna os nomes dos tipos de armazenamento registrados como candidatos de armazenamento. Esta função não requer parâmetros.

Devoluções

Uma matriz de valores de string, em que cada string é o tipo de loja com o qual um candidato a armazenamento foi registrado. Consulte o parâmetro storeType da função ContextHub.Utils.storeCandidates.registerStoreCandidate.

registerStoreCandidate(store, storeType, priority, aplica) registerstorecandidate-store-storetype-priority-applies

Registra um objeto de armazenamento como um candidato de armazenamento usando um nome e uma prioridade.

A prioridade é um número que indica a importância de armazenamentos com o mesmo nome. Quando um candidato de armazenamento é registrado usando o mesmo nome de um candidato de armazenamento já registrado, o candidato com a prioridade mais alta é usado. Ao registrar um candidato de armazenamento, o armazenamento será registrado somente se a prioridade for maior que os candidatos de armazenamento registrados com o mesmo nome.

Parâmetros

  • repositório: (Objeto) O objeto de repositório a ser registrado como um candidato a repositório.
  • storeType: (Cadeia de Caracteres) O nome do candidato ao armazenamento. Esse valor é necessário ao criar uma instância do candidato de armazenamento.
  • prioridade: (Número) A prioridade do candidato a armazenamento.
  • applies: (Função) A função a ser invocada que avalia a aplicabilidade do armazenamento no ambiente atual. A função deve retornar true se o armazenamento for aplicável, caso contrário false. O valor padrão é uma função que retorna verdadeiro: function() {return true;}

Exemplo

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2