Experience League

Experience Cloud

Document Cloud

API Javascript de contexto do cliente

CQ_Analytics.ClientContextMgr

O objeto CQ_Analytics.ClientContextMgr é um singleton que contém um conjunto de armazenamentos de sessão autoregistrados e fornece métodos para registrar, persistir e gerenciar os armazenamentos de sessão.

Estende CQ_Analytics.PersistedSessionStore.

Métodos

getRegisteredStore(name)

Retorna um armazenamento de sessão com um nome especificado. Consulte também Acesso a um Armazenamento de Sessão.

Parâmetros

name: Sequência de caracteres. O nome do armazenamento de sessão.

Retorna

Um objeto CQ_Analytics.SessionStore que representa o armazenamento de sessão do nome fornecido. Retorna null quando não existe nenhum armazenamento do nome especificado.

register(sessionstore)

Registra um armazenamento de sessão com o Contexto do Cliente. Aciona os eventos storeregister e storeupdate após a conclusão.

Parâmetros

sessionstore: CQ_Analytics.SessionStore. O objeto do repositório de sessão a ser registrado.

Retorna

Nenhum valor retornado.

CQ_Analytics.ClientContextUtils

Fornece métodos de acompanhamento para ativação e registro da loja de sessões. Consulte também Verificando se um armazenamento de sessão está definido e inicializado.

Métodos

onStoreInitialized(storeName, callback, atraso)

Registra uma função de retorno de chamada que é chamada quando um armazenamento de sessão é inicializado. Para armazenamentos que são inicializados várias vezes, especifique um atraso de retorno de chamada para que a função de retorno de chamada seja chamada apenas uma vez:

Quando o armazenamento é inicializado durante o período de atraso de uma inicialização anterior, a chamada de função anterior é cancelada e a função é chamada novamente para a inicialização atual.
Se o período de atraso expirar antes de ocorrer uma inicialização subsequente, a função de retorno de chamada será executada duas vezes.

Por exemplo, um armazenamento de sessão é baseado em um objeto JSON e recuperado por meio de uma solicitação JSON. Os seguintes cenários de inicialização são possíveis:

A solicitação é concluída, os dados recuperados e carregados no armazenamento. Nesse caso, a inicialização ocorre uma vez.
A solicitação falha (tempo limite). Nesse caso, a inicialização não ocorre e não há dados no armazenamento.
A loja é pré-preenchida com valores padrão (propriedades da inicialização), mas a solicitação falha (tempo limite). Há apenas uma inicialização com valores padrão.
A loja é pré-preenchida.

Quando o atraso é definido como true ou um número de milissegundos, o método aguarda antes de chamar o método de retorno de chamada. Se outro evento de inicialização for acionado antes que o atraso seja passado, ele aguardará até que o tempo de atraso seja excedido sem nenhum evento de inicialização. Isso permite que a espera por que um segundo evento de inicialização seja acionado e chama a função de retorno de chamada no caso mais ideal.

Parâmetros

storeName: Sequência de caracteres. O nome do armazenamento de sessão para adicionar o ouvinte.
retorno de chamada: Função. A função a ser chamada na inicialização da loja.
atraso: Booleano ou número. O tempo para atrasar a chamada para a função de retorno de chamada, em milissegundos. Um valor booleano de true usa o atraso padrão de 200 ms. Um valor booleano false ou um número negativo não faz com que nenhum atraso seja usado.

Retorna

Nenhum valor retornado.

onStoreRegistered(storeName, callback)

Registra uma função de retorno de chamada que é chamada quando um armazenamento de sessão é registrado. O evento de registro ocorre quando uma loja é registrada em CQ_Analytics.ClientContextMgr.

Parâmetros

storeName: Sequência de caracteres. O nome do armazenamento de sessão para adicionar o ouvinte.
retorno de chamada: Função. A função a ser chamada na inicialização da loja.

Retorna

Nenhum valor retornado.

CQ_Analytics.JSONPStore

Um armazenamento de sessão não persistente que contém dados JSON. Os dados são recuperados de um serviço JSONP externo. Use o método getInstance ou getRegisteredInstance para criar uma instância dessa classe.

Estende CQ_Analytics.JSONStore.

Propriedades

Consulte CQ_Analytics.JSONStore e CQ_Analytics.SessionStore para obter propriedades herdadas.

Métodos

Consulte também CQ_Analytics.JSONStore e CQ_Analytics.SessionStore para obter métodos herdados.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback)

Cria um objeto CQ_Analytics.JSONPStore.

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas. Se nenhum storeName for fornecido, o método retornará null.
serviceURL: Sequência de caracteres. O URL do serviço JSONP
dynamicData: (Opcional) Objeto. Dados JSON a serem anexados aos dados de inicialização do armazenamento antes da chamada da função de retorno de chamada.
deferLoading: (Opcional) Booleano. Um valor true impede que o serviço JSONP seja chamado na criação do objeto. Um valor false faz com que o serviço JSONP seja chamado.
loadingCallback: (Opcional) String. O nome da função a ser chamada para o processamento do objeto JSONP retornado pelo serviço JSONP. A função de retorno de chamada deve definir um único parâmetro que seja um objeto CQ_Analytics.JSONPStore.

Retorna

O novo objeto CQ_Analytics.JSONPStore ou nulo se storeName for nulo.

getServiceURL()

Recupera o URL do serviço JSONP que este objeto usa para recuperar dados JSON.

Parâmetros

Nenhum.

Retorna

Uma String que representa o URL do serviço ou nulo se nenhum URL de serviço tiver sido configurado.

load(serviceURL, dynamicData, retorno de chamada)

Chama o serviço JSONP. O URL JSONP é o sufixo do URL de serviço com um nome de função de retorno de chamada.

Parâmetros

serviceURL: (Opcional) String. O serviço JSONP a ser chamado. Um valor nulo faz com que o URL de serviço já configurado seja usado. Um valor não nulo define o serviço JSONP a ser usado para esse objeto. (Consulte setServiceURL.)
dynamicData: (Opcional) Objeto. Dados JSON a serem anexados aos dados de inicialização do armazenamento antes da chamada da função de retorno de chamada.
retorno de chamada: (Opcional) String. O nome da função a ser chamada para o processamento do objeto JSONP retornado pelo serviço JSONP. A função de retorno de chamada deve definir um único parâmetro que seja um objeto CQ_Analytics.JSONPStore.

Retorna

Nenhum valor retornado.

registerNewInstance(storeName, serviceURL, dynamicData, retorno de chamada)

Cria um objeto CQ_Analytics.JSONPStore e registra a loja no Contexto do Cliente.

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas. Se nenhum storeName for fornecido, o método retornará null.
serviceURL: (Opcional) String. O URL do serviço JSONP.
dynamicData: (Opcional) Objeto. Dados JSON a serem anexados aos dados de inicialização do armazenamento antes da chamada da função de retorno de chamada.
retorno de chamada: (Opcional) String. O nome da função a ser chamada para o processamento do objeto JSONP retornado pelo serviço JSONP. A função de retorno de chamada deve definir um único parâmetro que seja um objeto CQ_Analytics.JSONPStore.

Retorna

O objeto CQ_Analytics.JSONPStore registrado.

setServiceURL(serviceURL)

Define o URL do serviço JSONP a ser usado para recuperar dados JSON.

Parâmetros

serviceURL: Sequência de caracteres. O URL do serviço JSONP que fornece dados JSON

Retorna

Nenhum valor retornado.

CQ_Analytics.JSONStore

Um contêiner para um objeto JSON. Crie uma instância dessa classe para criar um armazenamento de sessão não persistente que contenha dados JSON:

myjsonstore = new CQ_Analytics.JSONStore

Você pode definir um conjunto de dados que preenche a loja na inicialização.

Estende CQ_Analytics.SessionStore.

Propriedades

STOREKEY

A chave que identifica a loja. Use o método getInstance para recuperar esse valor.

STORENAME

O nome da loja. Use o método getInstance para recuperar esse valor.

Métodos

Consulte também CQ_Analytics.SessionStore para obter métodos herdados.

limpar()

Remove os dados do armazenamento da sessão e remove todas as propriedades de inicialização.

Parâmetros

Nenhum.

Retorna

Nenhum valor retornado.

getInstance(storeName, jsonData)

Cria um objeto CQ_Analytics.JSONStore com um determinado nome e inicializado com os dados JSON fornecidos (chama o método initJSON).

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas.
jsonData: Objeto. Um objeto que contém dados JSON.

Retorna

O objeto CQ_Analytics.JSONStore.

getJSON()

Recupera os dados do armazenamento da sessão no formato JSON.

Parâmetros

Nenhum.

Retorna

Um objeto que representa os dados do armazenamento no formato JSON.

init()

Apaga o armazenamento de sessão e o inicializa com a propriedade de inicialização. Define o sinalizador de inicialização como true e dispara os eventos initialize e update.

Parâmetros

Nenhum.

Retorna

Nenhum dado retornado.

initJSON(jsonData, doNotClear)

Cria propriedades de inicialização a partir dos dados em um objeto JSON. Opcionalmente, é possível remover todas as propriedades de inicialização existentes.

Os nomes das propriedades são derivados da hierarquia dos dados no objeto JSON. O código de exemplo a seguir representa um objeto JSON:

{
A: "valueA",  
B: {
     B1: "valueBB1"
    }
}

Neste exemplo, as seguintes propriedades são criadas na loja:

A: "valueA" 
B/B1: "valueBB1"

Parâmetros

jsonData: Um objeto JSON que contém os dados a serem armazenados.
doNotClear: Um valor true preserva as propriedades de inicialização existentes e adiciona as derivadas do objeto JSON. Um valor false remove as propriedades de inicialização existentes antes de adicionar aquelas derivadas do objeto JSON.

Retorna

Nenhum valor retornado.

registerNewInstance(storeName, jsonData)

Cria um objeto CQ_Analytics.JSONStore com um determinado nome e inicializado com os dados JSON fornecidos (chama o método initJSON). O novo objeto é registrado automaticamente no Clickstream Cloud Manager.

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas.
jsonData: Objeto. Um objeto que contém dados JSON.

Retorna

O objeto CQ_Analytics.JSONStore.

CQ_Analytics.Observable

Aciona eventos e permite que outros objetos ouçam esses eventos e reajam. As classes que estendem essa classe podem disparar eventos que fazem com que os ouvintes sejam chamados.

Métodos

addListener(event, fct, scope)

Registra um ouvinte para um evento. Consulte também Criação de um ouvinte para reagir a uma atualização do armazenamento de sessão.

Parâmetros

evento: Sequência de caracteres. O nome do evento que será escutado.
fct: Função. A função que é chamada quando o evento ocorre.
escopo: (Opcional) Objeto. O escopo no qual executar a função do manipulador. O contexto "this" da função de manipulador.

Retorna

Nenhum valor retornado.

removeListener(event, fct)

Remove o manipulador de eventos fornecido para um evento.

Parâmetros

evento: Sequência de caracteres. O nome do evento.
fct: Função. O manipulador de eventos.

Retorna

Nenhum valor retornado.

CQ_Analytics.PersistedJSONPStore

Um contêiner persistente de um objeto JSON recuperado de um serviço JSONP remoto.

Estende CQ_Analytics.PersistedJSONStore.

Métodos

Consulte também CQ_Analytics.PersistedJSONStore para obter métodos herdados.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback)

Cria um objeto CQ_Analytics.PersistedJSONPStore.

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas. Se nenhum storeName for fornecido, o método retornará null.
serviceURL: Sequência de caracteres. O URL do serviço JSONP
dynamicData: (Opcional) Objeto. Dados JSON a serem anexados aos dados de inicialização do armazenamento antes da chamada da função de retorno de chamada.
deferLoading: (Opcional) Booleano. Um valor true impede que o serviço JSONP seja chamado na criação do objeto. Um valor false faz com que o serviço JSONP seja chamado.
loadingCallback: (Opcional) String. O nome da função a ser chamada para o processamento do objeto JSONP retornado pelo serviço JSONP. A função de retorno de chamada deve definir um único parâmetro que seja um objeto CQ_Analytics.JSONPStore.

Retorna

O novo objeto CQ_Analytics.PersistedJSONPStore ou nulo se storeName for nulo.

getServiceURL()

Recupera o URL do serviço JSONP que este objeto usa para recuperar dados JSON.

Parâmetros

Nenhum.

Retorna

Uma String que representa o URL do serviço ou nulo se nenhum URL de serviço tiver sido configurado.

load(serviceURL, dynamicData, retorno de chamada)

Chama o serviço JSONP. O URL JSONP é o sufixo do URL de serviço com um nome de função de retorno de chamada.

Parâmetros

serviceURL: (Opcional) String. O serviço JSONP a ser chamado. Um valor nulo faz com que o URL de serviço já configurado seja usado. Um valor não nulo define o serviço JSONP a ser usado para esse objeto. (Consulte setServiceURL.)
dynamicData: (Opcional) Objeto. Dados JSON a serem anexados aos dados de inicialização do armazenamento antes da chamada da função de retorno de chamada.
retorno de chamada: (Opcional) String. O nome da função a ser chamada para o processamento do objeto JSONP retornado pelo serviço JSONP. A função de retorno de chamada deve definir um único parâmetro que seja um objeto CQ_Analytics.JSONPStore.

Retorna

Nenhum valor retornado.

registerNewInstance(storeName, serviceURL, dynamicData, retorno de chamada)

Cria um objeto CQ_Analytics.PersistedJSONPStore e registra o armazenamento no Contexto do Cliente.

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas. Se nenhum storeName for fornecido, o método retornará null.
serviceURL: (Opcional) String. O URL do serviço JSONP.
dynamicData: (Opcional) Objeto. Dados JSON a serem anexados aos dados de inicialização do armazenamento antes da chamada da função de retorno de chamada.
retorno de chamada: (Opcional) String. O nome da função a ser chamada para o processamento do objeto JSONP retornado pelo serviço JSONP. A função de retorno de chamada deve definir um único parâmetro que seja um objeto CQ_Analytics.JSONPStore.

Retorna

O objeto CQ_Analytics.PersistedJSONPStore registrado.

setServiceURL(serviceURL)

Define o URL do serviço JSONP a ser usado para recuperar dados JSON.

Parâmetros

serviceURL: Sequência de caracteres. O URL do serviço JSONP que fornece dados JSON

Retorna

Nenhum valor retornado.

CQ_Analytics.PersistedJSONStore

Um contêiner persistente de um objeto JSON.

Estende CQ_Analytics.PersistedSessionStore.

Propriedades

STOREKEY

A chave que identifica a loja. Use o método getInstance para recuperar esse valor.

STORENAME

O nome da loja. Use o método getInstance para recuperar esse valor.

Métodos

Consulte também CQ_Analytics.PersistedSessionStore para obter métodos herdados.

getInstance(storeName, jsonData)

Cria um objeto CQ_Analytics.PersistedJSONStore com um determinado nome e inicializado com os dados JSON fornecidos (chama o método initJSON).

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas.
jsonData: Objeto. Um objeto que contém dados JSON.

Retorna

O objeto CQ_Analytics.PersistedJSONStore .

getJSON()

Recupera os dados do armazenamento da sessão no formato JSON.

Parâmetros

Nenhum.

Retorna

Um objeto que representa os dados do armazenamento no formato JSON.

initJSON(jsonData, doNotClear)

Cria propriedades de inicialização a partir dos dados em um objeto JSON. Opcionalmente, é possível remover todas as propriedades de inicialização existentes.

Os nomes das propriedades são derivados da hierarquia dos dados no objeto JSON. O código de exemplo a seguir representa um objeto JSON:

{
A: "valueA",  
B: {
     B1: "valueBB1"
    }
}

Neste exemplo, as seguintes propriedades são criadas na loja:

A: "valueA" 
B/B1: "valueBB1"

Parâmetros

jsonData: Um objeto JSON que contém os dados a serem armazenados.
doNotClear: Um valor true preserva as propriedades de inicialização existentes e adiciona as derivadas do objeto JSON. Um valor false remove as propriedades de inicialização existentes antes de adicionar aquelas derivadas do objeto JSON.

Retorna

Nenhum valor retornado.

registerNewInstance(storeName, jsonData)

Cria um objeto CQ_Analytics.PersistedJSONStore com um determinado nome e inicializado com os dados JSON fornecidos (chama o método initJSON). O novo objeto é registrado automaticamente no Gerenciador de Contexto do Cliente.

Parâmetros

storeName: Sequência de caracteres. O nome a ser usado como a propriedade STORENAME. O valor da propriedade STOREKEY é definido para storeName com todos os caracteres em maiúsculas.
jsonData: Objeto. Um objeto que contém dados JSON.

Retorna

O objeto CQ_Analytics.PersistedJSONStore .

CQ_Analytics.PersistedSessionStore

Um contêiner de propriedades e valores. Os dados são mantidos usando CQ_Analytics.SessionPersistence. Crie uma instância dessa classe para criar um armazenamento de sessão persistente:

mypersistedstore = new CQ_Analytics.PersistedSessionStore

Estende CQ_Analytics.SessionStore.

Propriedades

STOREKEY

O valor padrão é key.

Métodos

Consulte CQ_Analytics.SessionStore para obter métodos herdados.

Quando os métodos herdados clear, setProperty, setProperties, removeProperty são usados para alterar os dados do armazenamento, as alterações são automaticamente persistentes, a menos que as propriedades alteradas sejam sinalizadas como notPersisted.

getStoreKey()

Recupera a propriedade STOREKEY.

Parâmetros

Nenhum

Retorna

O valor da propriedade STOREKEY.

isPersisted(name)

Determina se uma propriedade de dados é persistente.

Parâmetros

name: Sequência de caracteres. O nome da propriedade.

Retorna

Um valor booleano true se a propriedade for persistente e um valor false se o valor não for uma propriedade persistente.

persist()

Persiste no armazenamento da sessão. O modo de persistência padrão usa o navegador localStorage usando ClientSidePersistence como o nome ( window.localStorage.set("ClientSidePersistance", store);)

Se localStorage não estiver disponível ou gravável, o armazenamento será mantido como uma propriedade da janela.

Aciona o evento persist após a conclusão.

Parâmetros

Nenhum

Retorna

Nenhum valor retornado.

reset(deferEvent)

Remove todas as propriedades de dados do armazenamento e mantém o armazenamento. Opcionalmente, não dispara o evento udpate após a conclusão.

Parâmetros

deferEvent: Um valor true impede que o evento update seja disparado. Um valor false faz com que o evento de atualização seja disparado.

Retorna

Nenhum valor retornado.

setNonPersisted(name)

Sinaliza uma propriedade de dados como não persistente.

Parâmetros

name: Sequência de caracteres. O nome da propriedade que não deve ser mantida.

Retorna

Nenhum valor de retorno.

CQ_Analytics.SessionStore

CQ_Analytics.SessionStore representa um armazenamento de sessão. Crie uma instância dessa classe para criar um armazenamento de sessão:

mystore = new CQ_Analytics.SessionStore

Estende CQ_Analytics.Observable.

Propriedades

STORENAME

O nome do armazenamento de sessão. Use getName para recuperar o valor dessa propriedade.

Métodos

addInitProperty(name, value)

Adiciona uma propriedade e um valor aos dados de inicialização do repositório de sessão.

Use loadInitProperties para preencher os dados do repositório de sessão com os valores de inicialização.

Parâmetros

name: Sequência de caracteres. O nome da propriedade a ser adicionada.
valor: Sequência de caracteres. O valor da propriedade a ser adicionada.

Retorna

Nenhum valor retornado.

setProperties(properties)

Define os valores de várias propriedades. Aciona o evento update após a conclusão. Chama o método init se a propriedade de dados do armazenamento não existir.

Parâmetros

Propriedades: Objeto. Um objeto que contém propriedades enumeráveis. Cada nome e valor de propriedade é adicionado ao armazenamento.

Retorna

Nenhum valor retornado.

setProperty(name, value)

Define o valor de uma propriedade. Aciona o evento update após a conclusão. Chama o método init se a propriedade de dados do armazenamento não existir.

Parâmetros