Referência de API do Javascript do ContextHub

Última atualização: 4 de maio de 2023

Criado para:

  • Desenvolvedor
CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

A API Javascript do ContextHub está disponível para seus scripts quando a variável O componente ContextHub foi adicionado à página.

Constantes do ContextHub

Valores constantes que a API Javascript do ContextHub define.

Constantes do evento

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

ConstanteDescriçãoValor
ContextHub.Constants.EVENT_NAMESPACENamespace do evento do ContextHubch
ContextHub.Constants.EVENT_ALL_STORES_READYIndica que todas as lojas necessárias estão registradas, inicializadas e prontas para serem consumidaspronto para todas as lojas
ContextHub.Constants.EVENT_STORES_PARTIALLY_READYIndica que nem todos os armazenamentos foram inicializados dentro de um determinado tempo limitearmazenamentos parcialmente prontos
ContextHub.Constants.EVENT_STORE_REGISTEREDDisparado quando uma loja é registradaregistrado na loja
ContextHub.Constants.EVENT_STORE_READYIndica que as lojas estão prontas para funcionar. É acionado imediatamente após o registro, exceto armazenamentos JSONP, onde é acionado quando os dados são buscados).pronto para armazenamento
ContextHub.Constants.EVENT_STORE_UPDATEDDisparado quando um armazenamento atualiza sua persistênciaarmazenado atualizado
ContextHub.Constants.PERSISTENCE_CONTAINER_NAMENome do contêiner de persistênciaContextHubPersistence
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEYArmazena o nome da chave de persistência específica onde o resultado JSON bruto é armazenado/_/raw-response
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEYArmazena um carimbo de data e hora específico que indica quando os dados JSON foram obtidos/_/tempo de resposta
ContextHub.Constants.SERVICE_LAST_URL_KEYArmazena url específico do serviço JSON usado durante a última chamada/_/url
ContextHub.Constants.IS_CONTAINER_EXPANDEDIndica se a interface do usuário do ContextHub foi expandida/_/contêiner expandido

Constantes de evento da interface do usuário

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

ConstanteDescriçãoValor
ContextHub.Constants.EVENT_UI_MODE_REGISTEREDDisparado quando um modo é registradoui-mode-register
ContextHub.Constants.EVENT_UI_MODE_UNREGISTEREDAcionado quando um modo não está registradoui-mode-unregister
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTEREDAcionado quando um renderizador de modo é registradoui-mode-renderer-register
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTEREDAcionado quando um renderizador de modo não está registradoui-mode-renderer-unregister
ContextHub.Constants.EVENT_UI_MODE_ADDEDAcionado quando um novo modo é adicionadoui-mode-added
ContextHub.Constants.EVENT_UI_MODE_REMOVEDAcionado quando um modo é removidoui-mode-remove
ContextHub.Constants.EVENT_UI_MODE_SELECTEDAcionado quando um modo é selecionado pelo usuárioui-mode-seleted
ContextHub.Constants.EVENT_UI_MODULE_REGISTEREDAcionado quando um novo módulo é registradoui-module-registrado
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTEREDAcionado quando um módulo não está registradoui-module-unregister
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTEREDAcionado quando um renderizador de módulo é registradoui-module-renderer-register
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTEREDAcionado quando um renderizador de módulo não está registradoui-module-renderer-unregister
ContextHub.Constants.EVENT_UI_MODULE_ADDEDAcionado quando um novo módulo é adicionadoui-module adicionado
ContextHub.Constants.EVENT_UI_MODULE_REMOVEDAcionado quando um módulo é removidoui-module-removido
ContextHub.Constants.EVENT_UI_CONTAINER_ADDEDAcionado quando o contêiner da interface do usuário é adicionado à páginaui-container-added
ContextHub.Constants.EVENT_UI_CONTAINER_OPENEDAcionado quando a interface do usuário do ContextHub é abertaui-container-opened
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSEDAcionado quando a interface do usuário do ContextHub é recolhidaui-container-closed
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIEDAcionado quando uma propriedade é modificadaui-property-modified
ContextHub.Constants.EVENT_UI_RENDEREDDisparado sempre que a interface do usuário do ContextHub é renderizada (por exemplo, após uma alteração de propriedade)ui-renderizado
ContextHub.Constants.EVENT_UI_INITIALIZEDDisparado quando o contêiner da interface do usuário é inicializadoui-initialized
ContextHub.Constants.ACTIVE_UI_MODEIndica o modo de interface do usuário ativo/_/ative-ui-mode

Referência de API do Javascript do ContextHub

O objeto ContextHub fornece acesso a todos os armazenamentos.

Funções (ContextHub)

getAllStores()

Retorna todos os armazenamentos registrados do ContextHub.

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

Devoluções

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

Exemplo

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

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

getStore(name)

Recupera uma loja como um objeto Javascript.

Parâmetros

  • name: O nome com o qual a loja foi registrada.

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

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

Funções (ContextHub.ContextEngine.Segment)

getName()

Retorna o nome do segmento como um valor de String.

getPath()

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

ContextHub.SegmentEngine.SegmentManager

Fornece acesso aos segmentos do ContextHub.

Funções (ContextHub.SegmentEngine.SegmentManager)

getResolvedSegments()

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

Devoluções

Uma matriz de objetos ContextHub.SegmentEngine.Segment.

ContextHub.Store.Core

A classe base dos armazenamentos do ContextHub.

Propriedades (ContextHub.Store.Core)

evento

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

name

O nome da loja.

persistência

Um objeto ContextHub.Utils.Persistence. Para obter informações sobre o valor padrão e a inicialização, consulte init(name,config).

Funções (ContextHub.Store.Core)

addAllItems(tree, options)

Une um objeto de dados ou uma matriz aos dados da loja. Cada par de chave/valor no objeto ou na matriz é adicionado ao armazenamento (por meio do setItem função):

  • Objeto: Chaves são os nomes de propriedade.
  • Matriz: 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 armazenamento.
  • opções: (Objeto) Um objeto opcional de opções passado para a função setItem . Para obter informações, consulte o options parâmetro de setItem(key,value,options).

Devoluções

A boolean valor:

  • Um valor de true indica que o objeto de dados foi armazenado.
  • Um valor de false indica que o armazenamento de dados permanece inalterado.

addReference(key, anotherKey)

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

Parâmetros

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

  • Outra chave: A chave referenciada por key.

Devoluções

A boolean valor:

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

advertisingReadiness()

Dispara o ready para esta loja. Essa função não tem parâmetros e não retorna valor.

clean()

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

getItem(key)

Retorna o valor associado a uma chave.

Parâmetros

  • chave: (String) A chave para a qual retornar o valor.

Devoluções

Um Objeto que representa o valor da chave.

getKeys(includeInternals)

Recupera as chaves da loja. Opcionalmente, é possível recuperar as chaves usadas internamente pela estrutura do ContextHub.

Parâmetros

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

Devoluções

Uma matriz de nomes de chaves ( string valores).

getReferences()

Recupera as referências da loja.

Devoluções

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

  • As teclas de referência correspondem à variável key do addReference .

  • As chaves referenciadas correspondem à função anotherKey do addReference .

getTree(includeInternals)

Recupera a árvore de dados do armazenamento. Opcionalmente, é possível incluir os pares chave/valor usados internamente pela estrutura do ContextHub.

Parâmetros

  • includeInternals: Um valor de true O inclui pares de chave/valor usados internamente nos resultados. As chaves desses dados começam com o caractere 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(name, config)

Inicializa o armazenamento.

  • Define os dados do armazenamento para um objeto vazio.

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

  • O eventChannel são dados:name, onde name é o nome da loja.

  • O storeDataKey é /store/name, onde name é o nome da loja.

Parâmetros

  • name: O nome da loja.

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

    • eventDeferring: O valor padrão é 32.
    • evento: O ContextHub.Utils.Eventing para esta loja. O valor padrão é o que o objeto ContextHub.eventing usa.
    • persistência: O objeto ContextHub.Utils.Persistence para esta loja. O valor padrão é o objeto ContextHub.persistence.

isEventingPaused()

Determina se o evento está pausado para esta loja.

Devoluções

Um valor booleano:

  • true: O evento é pausado para que nenhum evento seja acionado para esta loja.
  • false: Os eventos não são pausados para que sejam acionados para esta loja.

pauseEventing()

Pausa o evento para a loja para que nenhum evento seja acionado. Essa função não requer parâmetros e não retorna valor.

removeItem(key, options)

Remove um par de chave/valor do armazenamento.

Quando uma chave é removida, a função aciona a variável data evento. 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 "remover".

Como opção, você pode impedir o acionamento da variável data evento.

Parâmetros

  • chave: (String) 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 da variável data evento. O valor padrão é false.

Devoluções

A boolean valor:

  • Um valor de true indica que o par chave/valor foi removido.
  • Um valor de false indica que o armazenamento de dados permanece inalterado, pois a chave não foi encontrada no armazenamento.

removeReference(key)

Remove uma referência da loja.

Parâmetros

  • chave: A referência de chave a ser removida. Esse parâmetro corresponde à variável key do addReference .

Devoluções

A boolean valor:

  • 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 que a loja permanece inalterada.

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 é pausado para esta loja enquanto ela é redefinida. Essa função não retorna valor.

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

Parâmetros

  • keepRemainingData: (Booleano) Um valor true faz com que os dados não iniciais sejam persistentes. 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 é pausado para esta loja enquanto ela é redefinida. Essa função não retorna valor.

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

Parâmetros

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

resolveReference(key, retry)

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

Parâmetros

  • chave: (String) A chave para a qual resolver a referência. Essa key corresponde ao parâmetro key do addReference .

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

Devoluções

A string que representa a chave referenciada. Se nenhuma referência for resolvida, o valor da variável key é retornado.

resumeEventing()

Retoma o evento para esta loja para que os eventos sejam acionados. Essa função não define parâmetros e não retorna valor.

setItem(key, value, options)

Adiciona um par de chave/valor à loja.

Dispara o data somente se o valor da chave for diferente do valor armazenado para a chave no momento. Opcionalmente, é possível impedir o acionamento da variável data evento.

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

Parâmetros

  • chave: (String) 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 da variável data evento. O valor padrão é false.

  • valor: (Objeto) O valor a ser associado à chave.

Devoluções

A boolean valor:

  • Um valor de true indica que o objeto de dados foi armazenado.
  • Um valor de false indica que o armazenamento de dados permanece inalterado.

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 o init ao criar uma instância dessa classe.

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

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

Funções (ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

Configura os detalhes para 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 valor.

Parâmetros

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

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

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

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

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

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

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

      • auto: //
      • true: https://
      • falso: 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 do serviço existentes sejam mescladas com as propriedades de serviceConfig.

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

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 de serviço.

Devoluções

Um objeto com as seguintes propriedades:

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

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

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

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

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

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

    • auto: //
    • true: https://
    • falso: https://

getServiceURL(resolve)

Recupera o URL do serviço JSONP.

Parâmetros

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

Devoluções

A string que representa o URL do serviço.

init(name, config)

inicializa o objeto ContextHub.Store.JSONPStore .

Parâmetros

  • name: (String) O nome do armazenamento.

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

    • eventDeferring: 32.

    • evento: O objeto ContextHub.Utils.Eventing para esta loja. O valor padrão é o ContextHub.eventing objeto.

    • persistência: O objeto ContextHub.Utils.Persistence para esta loja. Por padrão, a persistência de memória é usada (objeto Javascript).

    • serviço: (Objeto)

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

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

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

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

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

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

        • auto: //
        • true: https://
        • falso: https://

      • tempo limite: (Número) A quantidade de tempo para aguardar a resposta do serviço JSONP antes de atingir o tempo limite, em milissegundos.

      • ttl: O tempo mínimo, em milissegundos, que passa entre as chamadas para o serviço JSONP. (Consulte o queryService ).

queryService(reload)

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

Aciona o evento ready quando o query for concluído. Se o URL do serviço JSONP não estiver definido, a função não fará nada.

Parâmetros

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

redefinir

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 esta loja enquanto os valores iniciais são redefinidos. Essa função não retorna valor.

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

Parâmetros

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

resolveParameter(f)

Resolve o parâmetro especificado.

ContextHub.Store.PersistedJSONPStore

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

ContextHub.Store.PersistedStore

O ContextHub.Store.PersistedStore estende ContextHub.Store.Core portanto, ela herda 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 estende ContextHub.Store.Core portanto, ela herda todas as funções dessa classe. Os dados nesse armazenamento são mantidos com persistência na memória (objeto Javascript).

ContextHub.UI

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

Funções (ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

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

Parâmetros

  • moduleType: (String) 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 não será registrado antes que esse renderizador seja registrado.
  • renderizador: (String) O nome da classe que renderiza o módulo da interface do usuário.
  • dontRender: (Booleano) Defina 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)

Determina se um cookie existe.

Parâmetros

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

Devoluções

A boolean valor true indica que o cookie existe.

Exemplo

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

getAllItems(filter)

Retorna todos os cookies que têm chaves que correspondem a um filtro.

Parâmetros

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

    • Sequência de caracteres: A string é comparada à chave do cookie.
    • Matriz: Cada item na matriz é um filtro.
    • Um objeto RegExp: A função de teste do objeto é usada para corresponder às chaves do cookie.
    • Uma função: Uma função que testa uma chave de cookie para obter uma correspondência. A função deve assumir a chave do cookie como parâmetro e retornar true 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-chave são valores de cookie.

Exemplo

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

getItem(key)

Retorna um valor de cookie.

Parâmetros

  • chave: A chave do cookie para o qual você deseja obter 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(filter)

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

Parâmetros

  • filtro: Critérios para corresponder chaves de cookie. Os seguintes tipos são suportados:

    • Sequência de caracteres: A string é comparada à chave do cookie.
    • Matriz: Cada item na matriz é um filtro.
    • Um objeto RegExp: A função de teste do objeto é usada para corresponder às chaves do cookie.
    • Uma função: Uma função que testa uma chave de cookie para obter uma correspondência. A função deve assumir a chave do cookie como parâmetro e retornar true se o teste confirmar uma correspondência.

Devoluções

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

Exemplo

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

removeItem(key, options)

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: A String que representa a chave do cookie a ser removido.

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

Devoluções

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

Exemplo

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

setItem(key, value, options)

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

Parâmetros

  • chave: Uma String que contém a chave do cookie.

  • valor: Uma String 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:

    • expira: A 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 o tempo de expiração para a hora atual mais o número. O valor padrão é undefined.
    • seguro: A boolean que especifica a variável Secure do cookie. O valor padrão é false.
    • caminho: A String valor a ser usado como o 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
});

vanish(filter, options)

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

Parâmetros

  • filtro: O filter argumento a ser usado na chamada para o [getKeys](/docs/experience-manager-64/developing/personlization/contexthub-api.md#getkeys-filter) .

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

Devoluções

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

ContextHub.Utils.Eventing

Permite vincular e desvincular funções a eventos de armazenamento do ContextHub. Acesse os objetos ContextHub.Utils.Eventing de um armazenamento usando a evento da loja.

Funções (ContextHub.Utils.Eventing)

off(nome, seletor)

Desvincula uma função de um evento.

Parâmetros

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

  • seletor: O seletor que identifica o vínculo. (Consulte o selector para o on e once funções).

Devoluções

Essa função não retorna valor.

on(name, handler, seletor, 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 o vínculo seja estabelecido.

Parâmetros

  • name: (String) O nome do evento à qual você está vinculando a função.

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

  • seletor: (String) Um identificador exclusivo para o vínculo. Você precisa do seletor para identificar o vínculo se deseja usar o off para remover o vínculo.

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

Devoluções

Quando a variável triggerForPastEvents argumento é true, essa função retorna um 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.

If triggerForPastEvents é false, essa função não retorna 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 da loja.

<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(name, handler, seletor, triggerForPastEvents)

Vincula uma função a um evento. A função é chamada somente 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 o vínculo seja estabelecido.

Parâmetros

  • name: (String) O nome do evento à qual você está vinculando a função.

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

  • seletor: (String) Um identificador exclusivo para o vínculo. Você precisa do seletor para identificar o vínculo se deseja usar o off para remover o vínculo.

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

Devoluções

Quando a variável triggerForPastEvents argumento é true, essa função retorna um 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.

If triggerForPastEvents é false, essa função não retorna valor.

ContextHub.Utils.inheritance

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

Funções (ContextHub.Utils.hereditance)

herdar(filho, pai)

Faz com que um objeto herde as propriedades e os métodos de outro objeto.

Parâmetros

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

ContextHub.Utils.JSON

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

Funções (ContextHub.Utils.JSON)

parse(data)

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

Parâmetros

  • dados: Um valor de string no formato JSON.

Devoluções

Um objeto 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(data)

Serializa valores e objetos Javascript em valores de string de formato JSON.

Parâmetros

  • dados: O valor ou objeto a ser serializado. Essa função suporta valores booleanos, de matriz, de número, de string e de data.

Devoluções

O valor da string serializada. When data é um R egExp , essa função retorna um objeto vazio. When 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

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

Funções (ContextHub.Utils.JSON.tree)

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 que é copiado.
  • SecondTree: O objeto que é unido à cópia do tree objeto.

Devoluções

Um objeto que contém os dados unidos.

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

Recupera o valor de um objeto para a chave a.

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 secundárias, essa função retorna um objeto complexo. Quando o tipo do valor da chave é undefined, null é retornado.

Exemplo

Considere o seguinte objeto 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 tenha chaves secundárias:

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

A função retorna o seguinte objeto:

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

getKeys()

Recupera todas as chaves da árvore de dados de um objeto. Como opção, você pode recuperar apenas as chaves dos filhos de uma chave específica. Opcionalmente, 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.
  • principal: (Opcional) A chave de um item na árvore de dados para a qual você deseja recuperar as chaves dos itens filhos.
  • pedido: (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 ContextHub.Utils.JSON.tree.getKeys(myObject); o script 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()

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.
  • chave: 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 script de exemplo 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)

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

  • Reduz várias barras consecutivas para a frente em uma única barra.
  • Remove o espaço em branco do início e do fim da cadeia 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 purificar.

Devoluções

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

Exemplo

O código a seguir limpa uma string para produzir a matriz ["this", "is", "a", "path"]e então gera a chave "/this/is/a/path" do storage:

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

setItem(tree, key, value)

Adiciona um par 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.
  • chave: A chave para associar ao valor que você está adicionando. A chave é o caminho para o item na árvore de dados. Essa função chama ContextHub.Utils.JSON.tree.sanitize para limpar a chave antes de adicioná-la.
  • valor: O valor a ser adicionado à árvore de dados.

Devoluções

Uma cópia do tree que inclui a variável key/ value par.

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

Permite registrar candidatos a lojas e obter candidatos a lojas registradas.

Funções (ContextHub.Utils.storeCandidates)

getRegisteredCandidates(storeType)

Retorna os tipos de loja que são registrados como candidatos de loja. Recupere os predicados 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 a armazenamento registrado.

getStoreFromCandidates(storeType)

Retorna um tipo de armazenamento dos candidatos registrados. Se mais de um tipo de armazenamento do 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()

Retorna os nomes dos tipos de loja que estão registrados como candidatos de loja. Essa função não requer parâmetros.

Devoluções

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

registerStoreCandidate(store, storeType, priority, apply)

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

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

Parâmetros

  • armazenar: (Objeto) O objeto de armazenamento a ser registrado como candidato de loja.
  • storeType: (String) O nome do candidato da loja. Esse valor é necessário ao criar uma instância do candidato de loja.
  • prioridade: (Número) A prioridade do candidato à loja.
  • aplica-se: (Função) A função para invocar que avalia a aplicabilidade da loja no ambiente atual. A função deve retornar true se o armazém for aplicável, e false caso contrário. O valor padrão é uma função que retorna true: function() {return true;}

Exemplo

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);
Página anterior
Próxima página

Experience Manager