L’objet CQ_Analytics.ClientContextMgr est un singleton qui contient un ensemble de magasins de sessions auto-enregistrés et fournit des méthodes d’enregistrement, de conservation et de gestion des magasins de sessions.
Étend CQ_Analytics.PersistedSessionStore.
Retourne un magasin de session d’un nom spécifié. Voir aussi Accès à un magasin de sessions.
Paramètres
Renvoie
Objet CQ_Analytics.SessionStore qui représente le magasin de sessions du nom en question. Renvoie null
lorsqu’il n’existe pas de magasin pour le nom donné.
Enregistre un magasin de sessions avec ClientContext. Déclenche les événements storeregister et storeupdate à la fin.
Paramètres
Renvoie
Aucune valeur renvoyée.
Fournit des méthodes d’écoute pour l’activation et l’enregistrement du magasin de sessions. Consultez également la section Vérification de la définition et de l’initialisation d’un magasin de session.
Enregistre une fonction de rappel appelée lors de l’initialisation d’un magasin de sessions. Pour les magasins initialisés plusieurs fois, spécifiez un délai de rappel afin que la fonction de rappel ne soit appelée qu’une seule fois :
Par exemple, un magasin de sessions est basé sur un objet JSON et récupéré via une requête JSON. Les scénarios d’initialisation suivants sont possibles :
Lorsque le délai est défini sur true
ou sur une valeur en millisecondes, la méthode attend avant d’appeler la méthode de rappel. Si un autre événement d’initialisation est déclenché avant le dépassement du délai, il attend que le délai soit dépassé sans événement d’initialisation. Cela permet d’attendre le déclenchement d’un second événement d’initialisation et d’appeler la fonction de rappel dans le cas le plus optimisé.
Paramètres
true
utilise le délai par défaut de 200 ms
. Une valeur booléenne false
ou un nombre négatif n’entraîne aucun report.Renvoie
Aucune valeur renvoyée.
Enregistre une fonction de rappel appelée lors de l’enregistrement d’un magasin de sessions. L’événement register se produit lorsqu’un magasin est enregistré sur CQ_Analytics.ClientContextMgr.
Paramètres
Renvoie
Aucune valeur renvoyée.
Un magasin de session non conservé qui contient des données JSON. Les données sont extraites d’un service JSONP externe. Utilisez la méthode getInstance
ou getRegisteredInstance
pour créer une instance de cette classe.
Étend CQ_Analytics.JSONStore.
Voir CQ_Analytics.JSONStore et CQ_Analytics.SessionStore pour les propriétés héritées.
Voir aussi CQ_Analytics.JSONStore et CQ_Analytics.SessionStore pour connaître les méthodes héritées.
Crée un objet CQ_Analytics.JSONPStore.
Paramètres
Renvoie
Le nouvel objet CQ_Analytics.JSONPStore, ou la valeur null si storeName est null.
Récupère l’URL du service JSONP que cet objet utilise pour récupérer les données JSON.
Paramètres
Aucun.
Renvoie
Chaîne représentant l’URL du service ou valeur nulle si aucune URL de service n’a été configurée.
Appelle le service JSONP. L’URL JSONP est l’URL du service avec comme suffixe le nom d’une fonction de rappel.
Paramètres
Renvoie
Aucune valeur renvoyée.
Crée un objet CQ_Analytics.JSONPStore et enregistre le magasin avec ClientContext.
Paramètres
Renvoie
Objet CQ_Analytics.JSONPStore enregistré.
Définit l’URL du service JSONP à utiliser pour récupérer les données JSON.
Paramètres
Renvoie
Aucune valeur renvoyée.
Conteneur pour un objet JSON. Créez une instance de cette classe pour créer un magasin de sessions non persistant contenant des données JSON :
myjsonstore = new CQ_Analytics.JSONStore
Vous pouvez définir un ensemble de données qui remplit le magasin lors de l’initialisation.
Étend CQ_Analytics.SessionStore.
Clé qui identifie le magasin. Utilisez la méthode getInstance
pour récupérer cette valeur.
Nom du magasin. Utilisez la méthode getInstance
pour récupérer cette valeur.
Voir également CQ_Analytics.SessionStore pour connaître les méthodes héritées.
Supprime les données du magasin de sessions et supprime toutes les propriétés d’initialisation.
Paramètres
Aucun.
Renvoie
Aucune valeur renvoyée.
Crée un objet CQ_Analytics.JSONStore avec un nom donné et initialisé avec les données JSON spécifiées (appelle la méthode initJSON).
Paramètres
Renvoie
Objet CQ_Analytics.JSONStore.
Récupère les données du magasin de sessions au format JSON.
Paramètres
Aucun.
Renvoie
Objet représentant les données du magasin au format JSON.
Efface le magasin de sessions et l’initialise avec la propriété d’initialisation. Définit l’indicateur d’initialisation sur true
, puis déclenche les événements initialize
et update
.
Paramètres
Aucun.
Renvoie
Aucune donnée renvoyée.
Crée des propriétés d’initialisation à partir des données d’un objet JSON. Vous pouvez éventuellement supprimer toutes les propriétés d’initialisation existantes.
Les noms des propriétés sont dérivés de la hiérarchie des données dans l’objet JSON. L’exemple de code suivant représente un objet JSON :
{
A: "valueA",
B: {
B1: "valueBB1"
}
}
Pour cet exemple, les propriétés suivantes sont créées dans le magasin :
A: "valueA"
B/B1: "valueBB1"
Paramètres
Renvoie
Aucune valeur renvoyée.
Crée un objet CQ_Analytics.JSONStore avec un nom donné et initialisé avec les données JSON spécifiées (appelle la méthode initJSON). Le nouvel objet est automatiquement enregistré auprès de Clickstream Cloud Manager.
Paramètres
Renvoie
Objet CQ_Analytics.JSONStore.
Déclenche des événements et permet à d’autres objets d’écouter ces événements et de réagir. Les classes qui étendent cette classe peuvent déclencher des événements qui provoquent l’appel d’écouteurs.
Enregistre un écouteur pour un événement. Voir aussi Création d’un écouteur pour réagir à une mise à jour de magasin de sessions.
Paramètres
Renvoie
Aucune valeur renvoyée.
Supprime le gestionnaire d’événements donné pour un événement.
Paramètres
Renvoie
Aucune valeur renvoyée.
Conteneur persistant d’un objet JSON récupéré à partir d’un service JSONP distant.
Étend CQ_Analytics.PersistedJSONStore.
Voir également CQ_Analytics.PersistedJSONStore pour connaître les méthodes héritées.
Crée un objet CQ_Analytics.PersistedJSONPStore.
Paramètres
Renvoie
Nouvel objet CQ_Analytics.PersistedJSONPStore, ou valeur null si storeName est null.
Récupère l’URL du service JSONP que cet objet utilise pour récupérer les données JSON.
Paramètres
Aucun.
Renvoie
Chaîne représentant l’URL du service ou valeur nulle si aucune URL de service n’a été configurée.
Appelle le service JSONP. L’URL JSONP est l’URL du service avec comme suffixe le nom d’une fonction de rappel.
Paramètres
Renvoie
Aucune valeur renvoyée.
Crée un objet CQ_Analytics.PersistedJSONPStore et enregistre le magasin avec ClientContext.
Paramètres
Renvoie
Objet CQ_Analytics.PersistedJSONPStore enregistré.
Définit l’URL du service JSONP à utiliser pour récupérer les données JSON.
Paramètres
Renvoie
Aucune valeur renvoyée.
Conteneur persistant d’un objet JSON.
Il étend CQ_Analytics.PersistedSessionStore
.
Clé qui identifie le magasin. Utilisez la méthode getInstance
pour récupérer cette valeur.
Nom du magasin. Utilisez la méthode getInstance
pour récupérer cette valeur.
Voir également CQ_Analytics.PersistedSessionStore pour connaître les méthodes héritées.
Crée un objet CQ_Analytics.PersistedJSONStore avec un nom donné et initialisé avec les données JSON spécifiées (appelle la méthode initJSON).
Paramètres
Renvoie
Objet CQ_Analytics.PersistedJSONStore.
Récupère les données du magasin de sessions au format JSON.
Paramètres
Aucun.
Renvoie
Objet représentant les données du magasin au format JSON.
Crée des propriétés d’initialisation à partir des données d’un objet JSON. Vous pouvez éventuellement supprimer toutes les propriétés d’initialisation existantes.
Les noms des propriétés sont dérivés de la hiérarchie des données dans l’objet JSON. L’exemple de code suivant représente un objet JSON :
{
A: "valueA",
B: {
B1: "valueBB1"
}
}
Pour cet exemple, les propriétés suivantes sont créées dans le magasin :
A: "valueA"
B/B1: "valueBB1"
Paramètres
Renvoie
Aucune valeur renvoyée.
Crée un objet CQ_Analytics.PersistedJSONStore avec un nom donné et initialisé avec les données JSON spécifiées (appelle la méthode initJSON). Le nouvel objet est automatiquement enregistré auprès de ClientContext Manager.
Paramètres
Renvoie
Objet CQ_Analytics.PersistedJSONStore.
Conteneur de propriétés et de valeurs. Les données sont conservées à l’aide de CQ_Analytics.SessionPersistence. Créez une instance de cette classe pour créer un magasin de sessions persistant :
mypersistedstore = new CQ_Analytics.PersistedSessionStore
Étend CQ_Analytics.SessionStore.
La valeur par défaut est key
.
Voir CQ_Analytics.SessionStore pour connaître les méthodes héritées.
Lorsque les méthodes héritées clear
, setProperty
, setProperties
, removeProperty
sont utilisées pour modifier les données du magasin, les modifications sont automatiquement conservées, à moins que les propriétés modifiées ne soient marquées comme notPersisted.
Récupère la propriété STOREKEY
.
Paramètres
Aucun
Renvoie
Valeur de la propriété STOREKEY
.
Détermine si une propriété de données est conservée.
Paramètres
Renvoie
Valeur booléenne de true
si la propriété est persistante et de false
si la valeur n’est pas une propriété persistante.
Rend persistant le magasin de session. Le mode de persistance par défaut utilise le navigateur localStorage
en utilisant ClientSidePersistence
comme nom (window.localStorage.set("ClientSidePersistance", store);
).
Si localStorage n’est pas disponible ou inscriptible, le magasin est conservé en tant que propriété de la fenêtre.
Déclenche l’événement persist
à la fin de l’opération.
Paramètres
Aucun
Renvoie
Aucune valeur renvoyée.
Supprime toutes les propriétés de données du magasin et conserve le magasin. En option, ne déclenche pas l’événement udpate
à la fin de l’opération.
Paramètres
update
. Une valeur false
provoque le déclenchement de l’événement de mise à jour.Renvoie
Aucune valeur renvoyée.
Marque une propriété de données comme non persistante.
Paramètres
Renvoie
Aucune valeur renvoyée.
CQ_Analytics.SessionStore représente un magasin de sessions. Créez une instance de cette classe pour créer un magasin de sessions :
mystore = new CQ_Analytics.SessionStore
Étend CQ_Analytics.Observable.
Nom du magasin de sessions. Utilisez getName pour récupérer la valeur de cette propriété.
Ajoute une propriété et une valeur aux données d’initialisation du magasin de sessions.
Utilisez loadInitProperties pour renseigner les données du magasin de sessions avec les valeurs d’initialisation.
Paramètres
Renvoie
Aucune valeur renvoyée.
Supprime toutes les propriétés de données du magasin.
Paramètres
Aucun.
Renvoie
Aucune valeur renvoyée.
Renvoie les données du magasin. Facultativement, exclut les propriétés de nom des données. Appelle la méthode init
si la propriété data du magasin n’existe pas.
Paramètres
excluded : (Facultatif) Un tableau de noms de propriétés à exclure des données renvoyées.
Renvoie
Objet de propriétés et de leurs valeurs.
Récupère la valeur d’une propriété de données.
Paramètres
Renvoie
Valeur de la propriété de données. Renvoie null
si le magasin de sessions ne contient aucune propriété portant le nom spécifié.
Renvoie le nom du magasin de sessions.
Paramètres
Aucun.
Renvoie
Une valeur String qui représente le nom du magasin.
Renvoie la valeur d’une propriété. La valeur est renvoyée en tant que propriété brute ou valeur filtrée XSS. Appelle la méthode init
si la propriété data du magasin n’existe pas.
Paramètres
Renvoie
Valeur de la propriété de données.
Renvoie les noms des propriétés que contient le magasin de sessions. Appelle la méthode init
si la propriété data du magasin n’existe pas.
Paramètres
excluded : (Facultatif) Un tableau de noms de propriétés à omettre des résultats.
Renvoie
Tableau de valeurs String représentant les noms des propriétés de session.
Renvoie le magasin de sessions associé à l’objet actif.
Paramètres
Aucun.
Renvoie
this
Marque le magasin comme initialisé et déclenche l’événement initialize
.
Paramètres
Aucun.
Renvoie
Aucune valeur renvoyée.
Indique si le magasin de sessions est initialisé.
Paramètres
Aucun.
Renvoie
Valeur true
si le magasin est initialisé et false
s’il ne l’est pas.
Ajoute les propriétés de l’objet en question aux données d’initialisation du magasin de sessions. En option, les données d’objet sont également ajoutées aux données du magasin.
Paramètres
Renvoie
Aucune valeur renvoyée.
Supprime une propriété du magasin de sessions. Déclenche l’événement update
à la fin de l’opération. Appelle la méthode init
si la propriété data du magasin n’existe pas.
Paramètres
Renvoie
Aucune valeur renvoyée.
Restaure les valeurs initiales du magasin de données. L’implémentation par défaut supprime simplement toutes les données. Déclenche l’événement update
à la fin de l’opération.
Paramètres
Aucun.
Renvoie
Aucune valeur renvoyée.
Définit les valeurs de plusieurs propriétés. Déclenche l’événement update
à la fin de l’opération. Appelle la méthode init
si la propriété data du magasin n’existe pas.
Paramètres
Renvoie
Aucune valeur renvoyée.
Définit les valeurs d’une propriété. Déclenche l’événement update
à la fin de l’opération. Appelle la méthode init
si la propriété data du magasin n’existe pas.
Paramètres
Renvoie
Aucune valeur renvoyée.