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.
Retorna um armazenamento de sessão de um nome especificado. Consulte também Acesso a um Repositório de Sessões.
Parâmetros
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 fornecido.
Registra um armazenamento de sessão com o Contexto do Cliente. Dispara os eventos de registro e atualização de armazenamento após a conclusão.
Parâmetros
Retorna
Nenhum valor retornado.
Fornece métodos de acompanhamento para ativação e registro do armazenamento de sessão. Consulte também Verificando se um Repositório de Sessões está Definido e Inicializado.
Registra uma função de retorno de chamada que é chamada quando um armazenamento de sessão é inicializado. Para armazenamentos inicializados várias vezes, especifique um atraso de retorno de chamada para que a função de retorno de chamada seja chamada somente uma vez:
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:
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 um segundo evento de inicialização seja acionada e chama a função de retorno de chamada no caso mais ideal.
Parâmetros
true
usa o atraso padrão de 200 ms
. Um valor booliano de false
ou um número negativo não faz com que nenhum atraso seja usado.Retorna
Nenhum valor retornado.
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 está registrada em CQ_Analytics.ClientContextMgr.
Parâmetros
Retorna
Nenhum valor retornado.
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.
Consulte CQ_Analytics.JSONStore e CQ_Analytics.SessionStore para obter as propriedades herdadas.
Consulte também CQ_Analytics.JSONStore e CQ_Analytics.SessionStore para obter métodos herdados.
Cria um objeto CQ_Analytics.JSONPStore.
Parâmetros
Retorna
O novo objeto CQ_Analytics.JSONPStore, ou nulo se storeName for nulo.
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 do serviço tiver sido configurado.
Chama o serviço JSONP. O URL JSONP é o URL do serviço com um nome de função de retorno de chamada.
Parâmetros
Retorna
Nenhum valor retornado.
Cria um objeto CQ_Analytics.JSONPStore e registra a loja com o Contexto do cliente.
Parâmetros
Retorna
O objeto CQ_Analytics.JSONPStore registrado.
Define o URL do serviço JSONP a ser usado para recuperar dados JSON.
Parâmetros
Retorna
Nenhum valor retornado.
Um container para um objeto JSON. Crie uma instância desta classe para criar um armazenamento de sessão não persistente que contenha dados JSON:
myjsonstore = new CQ_Analytics.JSONStore
É possível definir um conjunto de dados que preenche a loja na inicialização.
Estende CQ_Analytics.SessionStore.
A chave que identifica a loja. Use o método getInstance
para recuperar esse valor.
O nome da loja. Use o método getInstance
para recuperar esse valor.
Consulte também CQ_Analytics.SessionStore para obter métodos herdados.
Remove os dados do armazenamento da sessão e remove todas as propriedades de inicialização.
Parâmetros
Nenhum.
Retorna
Nenhum valor retornado.
Cria um objeto CQ_Analytics.JSONStore com um nome especificado e inicializado com os dados JSON fornecidos (chama o método initJSON).
Parâmetros
Retorna
O objeto CQ_Analytics.JSONStore.
Recupera os dados do armazenamento da sessão no formato JSON.
Parâmetros
Nenhum.
Retorna
Um objeto que representa os dados de armazenamento no formato JSON.
Limpa o armazenamento da sessão e o inicializa com a propriedade initialization. Define o sinalizador de inicialização como true
e dispara os eventos initialize
e update
.
Parâmetros
Nenhum.
Retorna
Nenhum dado retornado.
Cria propriedades de inicialização a partir dos dados em um objeto JSON. Como opção, você pode 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
Retorna
Nenhum valor retornado.
Cria um objeto CQ_Analytics.JSONStore com um nome especificado e inicializado com os dados JSON fornecidos (chama o método initJSON). O novo objeto é registrado automaticamente no Gerenciador da Nuvem de sequência de cliques.
Parâmetros
Retorna
O objeto CQ_Analytics.JSONStore.
Dispara eventos e permite que outros objetos escutem esses eventos e reajam. As classes que estendem essa classe podem acionar eventos que fazem com que os ouvintes sejam chamados.
Registra um ouvinte para um evento. Consulte também Criar um ouvinte para reagir a uma atualização do armazenamento de sessão.
Parâmetros
Retorna
Nenhum valor retornado.
Remove o manipulador de eventos fornecido para um evento.
Parâmetros
Retorna
Nenhum valor retornado.
Um container persistente de um objeto JSON recuperado de um serviço JSONP remoto.
Estende CQ_Analytics.PersistedJSONStore.
Consulte também CQ_Analytics.PersistedJSONStore para obter métodos herdados.
Cria um objeto CQ_Analytics.PersistedJSONPStore.
Parâmetros
Retorna
O novo objeto CQ_Analytics.PersistedJSONPStore, ou nulo se storeName for nulo.
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 do serviço tiver sido configurado.
Chama o serviço JSONP. O URL JSONP é o URL do serviço com um nome de função de retorno de chamada.
Parâmetros
Retorna
Nenhum valor retornado.
Cria um objeto CQ_Analytics.PersistedJSONPStore e registra a loja com o Client Context.
Parâmetros
Retorna
O objeto CQ_Analytics.PersistedJSONPStore registrado.
Define o URL do serviço JSONP a ser usado para recuperar dados JSON.
Parâmetros
Retorna
Nenhum valor retornado.
Um container persistente de um objeto JSON.
Estende CQ_Analytics.PersistedSessionStore
.
A chave que identifica a loja. Use o método getInstance
para recuperar esse valor.
O nome da loja. Use o método getInstance
para recuperar esse valor.
Consulte também CQ_Analytics.PersistedSessionStore para obter métodos herdados.
Cria um objeto CQ_Analytics.PersistedJSONStore com um nome especificado e inicializado com os dados JSON fornecidos (chama o método initJSON).
Parâmetros
Retorna
O objeto CQ_Analytics.PersistedJSONStore.
Recupera os dados do armazenamento da sessão no formato JSON.
Parâmetros
Nenhum.
Retorna
Um objeto que representa os dados de armazenamento no formato JSON.
Cria propriedades de inicialização a partir dos dados em um objeto JSON. Como opção, você pode 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
Retorna
Nenhum valor retornado.
Cria um objeto CQ_Analytics.PersistedJSONStore com um nome especificado 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
Retorna
O objeto CQ_Analytics.PersistedJSONStore.
Um container de propriedades e valores. Os dados são persistentes usando CQ_Analytics.SessionPersistence. Crie uma instância desta classe para criar um armazenamento de sessão persistente:
mypersistedstore = new CQ_Analytics.PersistedSessionStore
Estende CQ_Analytics.SessionStore.
O valor padrão é key
.
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.
Recupera a propriedade STOREKEY
.
Parâmetros
Nenhum
Retorna
O valor da propriedade STOREKEY
.
Determina se uma propriedade de dados é persistente.
Parâmetros
Retorna
Um valor booliano de true
se a propriedade for persistente e um valor de false
se o valor não for uma propriedade persistente.
Persiste no armazenamento da sessão. O modo de persistência padrão usa o navegador localStorage
usando ClientSidePersistence
como nome ( window.localStorage.set("ClientSidePersistance", store);
)
Se localStorage não estiver disponível ou gravável, então a loja será mantida como uma propriedade da janela.
Dispara o evento persist
após a conclusão.
Parâmetros
Nenhum
Retorna
Nenhum valor retornado.
Remove todas as propriedades de dados do repositório e persiste no armazenamento. Opcionalmente, não dispara o evento udpate
após a conclusão.
Parâmetros
update
seja acionado. Um valor de false
faz com que o evento de atualização seja acionado.Retorna
Nenhum valor retornado.
Sinaliza uma propriedade de dados como não persistida.
Parâmetros
Retorna
Nenhum valor de retorno.
CQ_Analytics.SessionStore representa um armazenamento de sessão. Crie uma instância desta classe para criar um armazenamento de sessão:
mystore = new CQ_Analytics.SessionStore
Estende CQ_Analytics.Observable.
O nome do armazenamento de sessão. Use getName para recuperar o valor dessa propriedade.
Adiciona uma propriedade e um valor aos dados de inicialização do armazenamento de sessão.
Use loadInitProperties para preencher os dados do armazenamento da sessão com os valores de inicialização.
Parâmetros
Retorna
Nenhum valor retornado.
Remove todas as propriedades de dados do repositório.
Parâmetros
Nenhum.
Retorna
Nenhum valor de retorno.
Retorna os dados de armazenamento. Opcionalmente, exclui as propriedades de nome dos dados. Chama o método init
se a propriedade data do armazenamento não existir.
Parâmetros
excluídos: (Opcional) Uma matriz de nomes de propriedade a serem excluídos dos dados retornados.
Retorna
Um objeto de propriedades e seus valores.
Recupera o valor de uma propriedade de dados.
Parâmetros
Retorna
O valor da propriedade data. Retorna null
se o armazenamento de sessão não contiver nenhuma propriedade do nome fornecido.
Retorna o nome do armazenamento da sessão.
Parâmetros
Nenhum.
Retorna
Um valor String que representa o nome da loja.
Retorna o valor de uma propriedade. O valor é retornado como a propriedade bruta ou o valor filtrado por XSS. Chama o método init
se a propriedade data do armazenamento não existir.
Parâmetros
Retorna
O valor da propriedade data.
Retorna os nomes das propriedades que o armazenamento de sessão contém. Chama o método init
se a propriedade data do armazenamento não existir.
Parâmetros
excluídos: (Opcional) Uma matriz de nomes de propriedade para omitir dos resultados.
Retorna
Uma matriz de valores String que representam os nomes das propriedades session.
Retorna o armazenamento de sessão anexado ao objeto atual.
Parâmetros
Nenhum.
Retorna
this
Marca a loja como inicializada e dispara o evento initialize
.
Parâmetros
Nenhum.
Retorna
Nenhum valor retornado.
Indica se o armazenamento de sessões foi inicializado.
Parâmetros
Nenhum.
Retorna
Um valor de true
se o armazenamento for inicializado e um valor de false
se o armazenamento não for inicializado.
Adiciona as propriedades de um determinado objeto aos dados de inicialização do armazenamento da sessão. Como opção, os dados do objeto também são adicionados aos dados do armazenamento.
Parâmetros
Retorna
Nenhum valor retornado.
Remove uma propriedade do armazenamento de sessão. Dispara o evento update
após a conclusão. Chama o método init
se a propriedade data do armazenamento não existir.
Parâmetros
Retorna
Nenhum valor retornado.
Restaura os valores iniciais do armazenamento de dados. A implementação padrão simplesmente remove todos os dados. Dispara o evento update
após a conclusão.
Parâmetros
Nenhum.
Retorna
Nenhum valor retornado.
Define os valores de várias propriedades. Dispara o evento update
após a conclusão. Chama o método init
se a propriedade data do armazenamento não existir.
Parâmetros
Retorna
Nenhum valor retornado.
Define o valor de uma propriedade. Dispara o evento update
após a conclusão. Chama o método init
se a propriedade data do armazenamento não existir.
Parâmetros
Retorna
Nenhum valor retornado.