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.
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 com um nome especificado. Consulte também Acessar um armazenamento de sessão.
Parâmetros
Devoluções
Um objeto CQ_Analytics.SessionStore que representa o armazenamento de sessão do nome fornecido. Devoluções null
quando não existe nenhum armazenamento do nome fornecido.
Registra um armazenamento de sessão com o Contexto do Cliente. Aciona os eventos storeregister e storeupdate após a conclusão.
Parâmetros
Devoluções
Nenhum valor retornado.
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.
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:
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 estiver definido como true
Para 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
true
usa o atraso padrão de 200 ms
. Um valor booleano de false
ou um número negativo faz com que nenhum atraso seja usado.Devoluções
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 para CQ_Analytics.ClientContextMgr.
Parâmetros
Devoluções
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 getInstance
ou getRegisteredInstance
para criar uma instância dessa classe.
Estende CQ_Analytics.JSONStore.
Consulte CQ_Analytics.JSONStore e CQ_Analytics.SessionStore para obter 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
Devoluções
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.
Devoluções
Uma String que representa o URL do serviço ou nulo se nenhum URL de serviço tiver sido configurado.
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
Devoluções
Nenhum valor retornado.
Cria um objeto CQ_Analytics.JSONPStore e registra a loja no Contexto do Cliente.
Parâmetros
Devoluções
O objeto CQ_Analytics.JSONPStore registrado.
Define o URL do serviço JSONP a ser usado para recuperar dados JSON.
Parâmetros
Devoluções
Nenhum valor retornado.
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.
A chave que identifica a loja. Use o getInstance
para recuperar esse valor.
O nome da loja. Use o 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.
Devoluções
Nenhum valor retornado.
Cria um objeto CQ_Analytics.JSONStore com um determinado nome e inicializado com os dados JSON fornecidos (chama o método initJSON).
Parâmetros
Devoluções
O objeto CQ_Analytics.JSONStore.
Recupera os dados do armazenamento da sessão no formato JSON.
Parâmetros
Nenhum.
Devoluções
Um objeto que representa os dados do armazenamento no formato JSON.
Apaga o armazenamento de sessão e o inicializa com a propriedade de inicialização. Define o sinalizador de inicialização como true
e, em seguida, dispara o initialize
e update
eventos.
Parâmetros
Nenhum.
Devoluções
Nenhum dado retornado.
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
Devoluções
Nenhum valor retornado.
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
Devoluções
O objeto CQ_Analytics.JSONStore.
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.
Registra um ouvinte para um evento. Consulte também Criando um ouvinte para reagir a uma atualização do armazenamento de sessão.
Parâmetros
Devoluções
Nenhum valor retornado.
Remove o manipulador de eventos fornecido para um evento.
Parâmetros
Devoluções
Nenhum valor retornado.
Um contêiner 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
Devoluções
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.
Devoluções
Uma String que representa o URL do serviço ou nulo se nenhum URL de serviço tiver sido configurado.
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
Devoluções
Nenhum valor retornado.
Cria um objeto CQ_Analytics.PersistedJSONPStore e registra o armazenamento no Contexto do Cliente.
Parâmetros
Devoluções
O objeto CQ_Analytics.PersistedJSONPStore registrado.
Define o URL do serviço JSONP a ser usado para recuperar dados JSON.
Parâmetros
Devoluções
Nenhum valor retornado.
Um contêiner persistente de um objeto JSON.
Estende CQ_Analytics.PersistedSessionStore
.
A chave que identifica a loja. Use o getInstance
para recuperar esse valor.
O nome da loja. Use o getInstance
para recuperar esse valor.
Consulte também CQ_Analytics.PersistedSessionStore para obter métodos herdados.
Cria um objeto CQ_Analytics.PersistedJSONStore com um determinado nome e inicializado com os dados JSON fornecidos (chama o método initJSON).
Parâmetros
Devoluções
O objeto CQ_Analytics.PersistedJSONStore .
Recupera os dados do armazenamento da sessão no formato JSON.
Parâmetros
Nenhum.
Devoluções
Um objeto que representa os dados do armazenamento no formato JSON.
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
Devoluções
Nenhum valor retornado.
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
Devoluções
O objeto CQ_Analytics.PersistedJSONStore .
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.
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 usadas para alterar os dados do armazenamento, as alterações são automaticamente persistentes, a menos que as propriedades alteradas sejam sinalizadas como notPersisted.
Recupera o STOREKEY
propriedade.
Parâmetros
Nenhum
Devoluções
O valor da variável STOREKEY
propriedade.
Determina se uma propriedade de dados é persistente.
Parâmetros
Devoluções
Um valor booleano 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
usar 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 persist
após a conclusão.
Parâmetros
Nenhum
Devoluções
Nenhum valor retornado.
Remove todas as propriedades de dados do armazenamento e mantém o armazenamento. Opcionalmente, não dispara a variável udpate
após a conclusão.
Parâmetros
update
de ser acionado. Um valor de false
O faz com que o evento de atualização seja acionado.Devoluções
Nenhum valor retornado.
Sinaliza uma propriedade de dados como não persistente.
Parâmetros
Devoluções
Nenhum valor de retorno.
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.
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 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
Devoluções
Nenhum valor retornado.
Remove todas as propriedades de dados do armazenamento.
Parâmetros
Nenhum.
Devoluções
Nenhum valor de retorno.
Retorna os dados de armazenamento. Opcionalmente, exclui propriedades de nomes dos dados. Chama a init
se a propriedade de dados do armazenamento não existir.
Parâmetros
excluídos: (Opcional) Uma matriz de nomes de propriedade a serem excluídos dos dados retornados.
Devoluções
Um objeto de propriedades e seus valores.
Recupera o valor de uma propriedade de dados.
Parâmetros
Devoluções
O valor da propriedade de dados. Devoluções 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.
Devoluções
Um valor String que representa o nome do armazenamento.
Retorna o valor de uma propriedade. O valor é retornado como a propriedade bruta ou o valor filtrado por XSS. Chama a init
se a propriedade de dados do armazenamento não existir.
Parâmetros
Devoluções
O valor da propriedade de dados.
Retorna os nomes das propriedades que o armazenamento de sessão contém. Chama a init
se a propriedade de dados do armazenamento não existir.
Parâmetros
excluídos: (Opcional) Uma matriz de nomes de propriedade para omitir dos resultados.
Devoluções
Uma matriz de valores de String que representam os nomes de propriedade da sessão.
Retorna o armazenamento de sessão anexado ao objeto atual.
Parâmetros
Nenhum.
Devoluções
this
Marca o armazenamento como inicializado e dispara o initialize
evento.
Parâmetros
Nenhum.
Devoluções
Nenhum valor retornado.
Indica se o armazenamento de sessões foi inicializado.
Parâmetros
Nenhum.
Devoluções
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 de sessão. Opcionalmente, os dados do objeto também serão adicionados aos dados do armazenamento.
Parâmetros
Devoluções
Nenhum valor retornado.
Remove uma propriedade do armazenamento de sessão. Aciona o update
após a conclusão. Chama a init
se a propriedade de dados do armazenamento não existir.
Parâmetros
Devoluções
Nenhum valor retornado.
Restaura os valores iniciais do armazenamento de dados. A implementação padrão simplesmente remove todos os dados. Aciona o update
após a conclusão.
Parâmetros
Nenhum.
Devoluções
Nenhum valor retornado.
Define os valores de várias propriedades. Aciona o update
após a conclusão. Chama a init
se a propriedade de dados do armazenamento não existir.
Parâmetros
Devoluções
Nenhum valor retornado.
Define o valor de uma propriedade. Aciona o update
após a conclusão. Chama a init
se a propriedade de dados do armazenamento não existir.
Parâmetros
Devoluções
Nenhum valor retornado.