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.

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.

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

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):

Observe que os valores podem ser objetos.

Parâmetros

Devoluções

Um valor boolean:

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

Devoluções

Um valor boolean:

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

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

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:

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

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.

Parâmetros

isEventingPaused() iseventingpaused

Determina se o evento está pausado para este armazenamento.

Devoluções

Um valor booleano:

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

Devoluções

Um valor boolean:

removeReference(key) removereference-key

Remove uma referência do armazenamento.

Parâmetros

Devoluções

Um valor boolean:

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

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

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

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

Devoluções

Um valor boolean:

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

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:

getServiceURL(resolver) getserviceurl-resolve

Recupera o URL do serviço JSONP.

Parâmetros

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

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

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

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

Exemplo

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

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

ContextHub.Utils.Cookie contexthub-utils-cookie

Uma classe de utilitário para interagir com cookies.

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

exists(key) exists-key

Determina se um cookie existe.

Parâmetros

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

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

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

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

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

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

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

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

Devoluções

Quando o argumento triggerForPastEvents é true, essa função retorna um valor boolean que indica se o evento 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

Devoluções

Quando o argumento triggerForPastEvents é true, essa função retorna um valor boolean que indica se o evento 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

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

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

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

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

Devoluções

Uma cópia da árvore que é limpa.

getItem() getitem

Recupera o valor de um objeto para a chave.

Parâmetros

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

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

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:

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

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

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

Exemplo

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);