Das Objekt CQ_Analytics.ClientContextMgr ist ein Singleton, das einen Satz an selbstregistrierten Sitzungsspeichern enthält und Methoden für die Registrierung, Speicherung und Verwaltung der Sitzungsspeicher bereitstellt.
Es erweitert CQ_Analytics.PersistedSessionStore.
Gibt einen Sitzungsspeicher eines festgelegten Namens zurück. Siehe auch Zugreifen auf einen Sitzungsspeicher.
Parameter
Rückgabe
Ein CQ_Analytics.SessionStore-Objekt, das den Sitzungsspeicher des angegebenen Namens repräsentiert. Gibt null
zurück, wenn kein Speicher mit dem angegebenen Namen vorhanden ist.
Registriert einen Sitzungsspeicher mit ClientContext. Löst die storeregister- und storeupdate-Ereignisse nach Fertigstellung aus.
Parameter
Rückgabe
Kein zurückgegebener Wert
Stellt Methoden für die Überwachung bereit, um die Aktivierung und Registrierung von Sitzungsspeicher zu erkennen. Siehe auch Überprüfen der Definition und Initialisierung eines Sitzungsspeichers.
Registriert eine Callback-Funktion, wenn ein Sitzungsspeicher initialisiert wird. Legen Sie für Speicher, die mehrmals initialisiert werden, eine Callback-Verzögerung fest, damit die Callback-Funktion nur einmal aufgerufen wird:
Beispiel: Ein Sitzungsspeicher basiert auf einem JSON-Objekt und wird über eine JSON-Anfrage abgerufen. Die folgenden Initialisierungsszenarien sind möglich:
Wenn die Verzögerung auf true
oder eine Anzahl an Millisekunden festgelegt ist, wartet die Methode, bevor sie die Callback-Methode aufruft. Wenn ein anderes Initialisierungsereignis ausgelöst wird, bevor der Verzögerungszeitraum abgelaufen ist, wartet die Methode, bis der Verzögerungszeitraum ohne Initialisierungsereignis überschritten ist. So ist es möglich, zu warten, bis ein zweites Initialisierungsereignis ausgelöst wird, um die Callback-Funktion im Optimalfall aufzurufen.
Parameter
true
nutzt den Standardwert 200 ms
. Beim booleschen Wert false
oder einer negativen Zahl wird keine Verzögerung eingesetzt.Rückgabe
Kein zurückgegebener Wert
Registriert eine Callback-Funktion, wenn ein Sitzungsspeicher registriert wird. Das Registrierungsereignis tritt auf, wenn ein Speicher bei CQ_Analytics.ClientContextMgr registriert wird.
Parameter
Rückgabe
Kein zurückgegebener Wert
Ein nicht beständiger Sitzungsspeicher, der JSON-Daten enthält. Die Daten werden von einem externen JSONP-Dienst abgerufen. Mit der Methode getInstance
oder getRegisteredInstance
können Sie eine Instanz dieser Klasse erstellen.
Erweitert CQ_Analytics.JSONStore.
Informationen zu den geerbten Eigenschaften finden Sie unter CQ_Analytics.JSONStore und CQ_Analytics.SessionStore.
Informationen zu den geerbten Methoden finden Sie ebenfalls unter CQ_Analytics.JSONStore und CQ_Analytics.SessionStore.
Erstellt ein CQ_Analytics.JSONPStore-Objekt.
Parameter
Rückgabe
Das neue CQ_Analytics.JSONPStore-Objekt oder „null“, wenn storeName „null“ ist
Ruft die URL des JSONP-Dienstes ab, mit dem dieses Objekt JSON-Daten abruft.
Parameter
Ohne.
Rückgabe
Ein String, der die Dienst-URL repräsentiert, oder „null“, wenn keine Dienst-URL konfiguriert wurde.
Ruft den JSONP-Dienst auf. Die JSONP-URL ist die Dienst-URL, der ein Callback-Funktionsname vorangestellt wird.
Parameter
Rückgabe
Kein zurückgegebener Wert
Erstellt ein CQ_Analytics.JSONPStore-Objekt und registriert den Speicher bei ClientContext.
Parameter
Rückgabe
Das registrierte CQ_Analytics.JSONPStore-Objekt
Legt die URL des JSONP-Dienstes fest, der zum Abrufen der JSON-Daten genutzt werden soll.
Parameter
Rückgabe
Kein zurückgegebener Wert
Ein Container für ein JSON-Objekt. Erstellen Sie eine Instanz dieser Klasse, um einen nicht beständigen Sitzungsspeicher zu erstellen, der JSON-Daten enthält:
myjsonstore = new CQ_Analytics.JSONStore
Sie können eine Reihe von Daten definieren, die den Speicher nach der Initialisierung befüllen.
Erweitert CQ_Analytics.SessionStore.
Der Schlüssel, der den Speicher identifiziert. Mit der Methode getInstance
können Sie diesen Wert abrufen.
Der Name des Speichers. Mit der Methode getInstance
können Sie diesen Wert abrufen.
Informationen zu geerbten Methoden finden Sie unter CQ_Analytics.SessionStore.
Löscht die Sitzungsspeicherdaten und alle Initialisierungseigenschaften.
Parameter
Ohne.
Rückgabe
Kein zurückgegebener Wert
Erstellt ein CQ_Analytics.JSONStore-Objekt mit einem angegebenen Namen, das mit den angegebenen JSON-Daten initialisiert wird (ruft die initJSON-Methode auf).
Parameter
Rückgabe
Das CQ_Analytics.JSONStore-Objekt.
Ruft die Daten des Sitzungsspeichers im JSON-Format ab.
Parameter
Ohne.
Rückgabe
Ein Objekt, das die Speicherdaten im JSON-Format repräsentiert.
Löscht den Sitzungsspeicher und initialisiert ihn mit der Initialisierungseigenschaft. Legt die Initialisierungsmarkierung auf true
fest und löst dann die Ereignisse initialize
und update
aus.
Parameter
Ohne.
Rückgabe
Keine zurückgegebenen Daten
Erstellt Initialisierungseigenschaften von den Daten in einem JSON-Objekt. Sie können optional alle vorhandenen Initialisierungseigenschaften entfernen.
Die Namen der Eigenschaften werden aus der Hierarchie der Daten im JSON-Objekt abgeleitet. Der folgende Beispielcode repräsentiert ein JSON-Objekt:
{
A: "valueA",
B: {
B1: "valueBB1"
}
}
Für dieses Beispiel werden die folgenden Eigenschaften im Speicher erstellt:
A: "valueA"
B/B1: "valueBB1"
Parameter
Rückgabe
Kein zurückgegebener Wert
Erstellt ein CQ_Analytics.JSONStore-Objekt mit einem angegebenen Namen, das mit den angegebenen JSON-Daten initialisiert wird (ruft die initJSON-Methode auf). Das neue Objekt wird automatisch mit dem Clickstream Cloud Manager registriert.
Parameter
Rückgabe
Das CQ_Analytics.JSONStore-Objekt.
Löst Ereignisse aus und ermöglicht es, dass andere Objekte auf diese Ereignisse warten und auf sie reagieren. Klassen, die diese Klasse erweitern, können Ereignisse auslösen, die zum Aufrufen von Listenern führen.
Registriert einen Listener für ein Ereignis. Siehe auch Erstellen eines Listeners, der auf eine Aktualisierung des Sitzungsspeichers reagiert.
Parameter
Rückgabe
Kein zurückgegebener Wert
Entfernt den angegeben Ereignis-Handler für ein Ereignis.
Parameter
Rückgabe
Kein zurückgegebener Wert
Ein beständiger Container eines JSON-Objekts, der von einem Remote-JSONP-Dienst abgerufen wird.
Erweitert CQ_Analytics.PersistedJSONStore.
Informationen zu geerbten Methoden finden Sie auch unter CQ_Analytics.PersistedJSONStore.
Erstellt ein CQ_Analytics.PersistedJSONPStore-Objekt.
Parameter
Rückgabe
Das neue CQ_Analytics.PersistedJSONPStore-Objekt oder „null“, wenn storeName „null“ ist.
Ruft die URL des JSONP-Dienstes ab, mit dem dieses Objekt JSON-Daten abruft.
Parameter
Ohne.
Rückgabe
Ein String, der die Dienst-URL repräsentiert, oder „null“, wenn keine Dienst-URL konfiguriert wurde.
Ruft den JSONP-Dienst auf. Die JSONP-URL ist die Dienst-URL, der ein Callback-Funktionsname vorangestellt wird.
Parameter
Rückgabe
Kein zurückgegebener Wert
Erstellt ein CQ_Analytics.PersistedJSONPStore-Objekt und registriert den Speicher bei ClientContext.
Parameter
Rückgabe
Das registrierte CQ_Analytics.PersistedJSONPStore-Objekt
Legt die URL des JSONP-Dienstes fest, der zum Abrufen der JSON-Daten genutzt werden soll.
Parameter
Rückgabe
Kein zurückgegebener Wert
Ein beständiger Container eines JSON-Objekts.
Erweitert CQ_Analytics.PersistedSessionStore
.
Der Schlüssel, der den Speicher identifiziert. Mit der Methode getInstance
können Sie diesen Wert abrufen.
Der Name des Speichers. Mit der Methode getInstance
können Sie diesen Wert abrufen.
Informationen zu geerbten Methoden finden Sie auch unter CQ_Analytics.PersistedSessionStore.
Erstellt ein CQ_Analytics.PersistedJSONStore-Objekt mit einem angegebenen Namen, das mit den angegebenen JSON-Daten initialisiert wird (ruft die initJSON-Methode auf).
Parameter
Rückgabe
Das CQ_Analytics.PersistedJSONStore-Objekt.
Ruft die Daten des Sitzungsspeichers im JSON-Format ab.
Parameter
Ohne.
Rückgabe
Ein Objekt, das die Speicherdaten im JSON-Format repräsentiert.
Erstellt Initialisierungseigenschaften von den Daten in einem JSON-Objekt. Sie können optional alle vorhandenen Initialisierungseigenschaften entfernen.
Die Namen der Eigenschaften werden aus der Hierarchie der Daten im JSON-Objekt abgeleitet. Der folgende Beispielcode repräsentiert ein JSON-Objekt:
{
A: "valueA",
B: {
B1: "valueBB1"
}
}
Für dieses Beispiel werden die folgenden Eigenschaften im Speicher erstellt:
A: "valueA"
B/B1: "valueBB1"
Parameter
Rückgabe
Kein zurückgegebener Wert
Erstellt ein CQ_Analytics.PersistedJSONStore-Objekt mit einem angegebenen Namen, das mit den angegebenen JSON-Daten initialisiert wird (ruft die initJSON-Methode auf). Das neue Objekt wird automatisch mit dem ClientContext-Manager registriert.
Parameter
Rückgabe
Das CQ_Analytics.PersistedJSONStore-Objekt.
Ein Container mit Eigenschaften und Werten. Die Daten werden mit CQ_Analytics.SessionPersistence gespeichert. Erstellen Sie eine Instanz dieser Klasse, um einen beständigen Sitzungsspeicher zu erstellen:
mypersistedstore = new CQ_Analytics.PersistedSessionStore
Erweitert CQ_Analytics.SessionStore.
Der Standardwert ist key
.
Informationen zu geerbten Methoden finden Sie unter CQ_Analytics.SessionStore.
Wenn die geerbten Methoden clear
, setProperty
, setProperties
, removeProperty
zum Ändern der Speicherdaten genutzt werden, werden die Änderungen automatisch gespeichert, es sei denn, die geänderten Eigenschaften werden als „nicht beständig“ markiert.
Ruft die Eigenschaft STOREKEY
ab.
Parameter
Ohne
Rückgabe
Der Wert der Eigenschaft STOREKEY
.
Bestimmt, ob eine Dateneigenschaft gespeichert wird.
Parameter
Rückgabe
Der boolesche Wert true
, wenn die Eigenschaft gespeichert wird, und der Wert false
, wenn der Wert keine beständige Eigenschaft ist.
Behält den Sitzungsspeicher bei. Der standardmäßige Persistenzmodus nutzt den Browser localStorage
mit ClientSidePersistence
als Name (window.localStorage.set("ClientSidePersistance", store);
)
Wenn localStorage nicht verfügbar oder nicht beschreibbar ist, wird der Speicher als Eigenschaft des Fensters gespeichert.
Löst nach Abschluss das Ereignis persist
aus.
Parameter
Ohne
Rückgabe
Kein zurückgegebener Wert
Entfernt alle Dateneigenschaften aus dem Speicher und behält den Speicher bei. Löst optional nach Abschluss kein udpate
-Ereignis aus.
Parameter
update
nicht ausgelöst. Beim Wert false
wird das update-Ereignis ausgelöst.Rückgabe
Kein zurückgegebener Wert
Markiert eine Dateneigenschaft als nicht beständig.
Parameter
Rückgabe
Kein Rückgabewert
CQ_Analytics.SessionStore repräsentiert einen Sitzungsspeicher. Erstellen Sie eine Instanz dieser Klasse, um einen Sitzungsspeicher zu erstellen:
mystore = new CQ_Analytics.SessionStore
Erweitert CQ_Analytics.Observable.
Der Name des Sitzungsspeichers. Mit getName können Sie den Wert dieser Eigenschaft abrufen.
Fügt eine Eigenschaft und einen Wert zu den Initialisierungsdaten des Sitzungsspeichers hinzu.
Mit loadInitProperties können Sie die Initialisierungswerte zu den Sitzungsspeicherdaten hinzufügen.
Parameter
Rückgabe
Kein zurückgegebener Wert
Entfernt alle Dateneigenschaften aus dem Speicher.
Parameter
Ohne.
Rückgabe
Kein Rückgabewert
Gibt die Speicherdaten zurück. Schließt optional Namenseigenschaften aus den Daten aus. Ruft die init
-Methode auf, wenn die Dateneigenschaft des Speichers nicht vorhanden ist.
Parameter
excluded: (optional) ein Array von Eigenschaftsnamen, die aus den zurückgegebenen Daten ausgeschlossen werden sollen
Rückgabe
Ein Objekt von Eigenschaften und deren Werten
Ruft den Wert einer Dateneigenschaft ab.
Parameter
Rückgabe
Der Wert der Dateneigenschaft. Gibt null
zurück, wenn der Sitzungsspeicher keine Eigenschaft des angegebenen Namens enthält.
Gibt den Namen des Sitzungsspeichers zurück.
Parameter
Ohne.
Rückgabe
Ein Stringwert, der den Speichernamen repräsentiert
Gibt den Wert einer Eigenschaft zurück. Der Wert wird als Roheigenschaft oder XSS-gefilterter Wert zurückgegeben. Ruft die init
-Methode auf, wenn die Dateneigenschaft des Speichers nicht vorhanden ist.
Parameter
Rückgabe
Der Wert der Dateneigenschaft.
Gibt die Namen der Eigenschaften zurück, die der Sitzungsspeicher enthält. Ruft die init
-Methode auf, wenn die Dateneigenschaft des Speichers nicht vorhanden ist.
Parameter
excluded: (optional) ein Array von Eigenschaftsnamen, die bei den Ergebnissen weggelassen werden sollen
Rückgabe
Ein Array von Stringwerten, die die Namen der Sitzungseigenschaften repräsentieren
Gibt den Sitzungsspeicher zurück, der dem aktuellen Objekt angehängt ist.
Parameter
Ohne.
Rückgabe
this
Markiert den Speicher als initialisiert und löst das initialize
-Ereignis aus.
Parameter
Ohne.
Rückgabe
Kein zurückgegebener Wert
Gibt an, ob der Sitzungsspeicher initialisiert wurde.
Parameter
Ohne.
Rückgabe
Der Wert true
, wenn der Speicher initialisiert wurde, und der Wert false
, wenn der Speicher nicht initialisiert wurde.
Fügt die Eigenschaften eines angegebenen Objekts zu den Initialisierungsdaten des Sitzungsspeichers hinzu. Optional werden die Objektdaten auch zu den Speicherdaten hinzugefügt.
Parameter
Rückgabe
Kein zurückgegebener Wert
Entfernt eine Eigenschaft vom Sitzungsspeicher. Löst nach Abschluss das Ereignis update
aus. Ruft die init
-Methode auf, wenn die Dateneigenschaft des Speichers nicht vorhanden ist.
Parameter
Rückgabe
Kein zurückgegebener Wert
Stellt die ursprünglichen Werte des Datenspeichers wieder her. Die Standardimplementierung entfernt einfach alle Daten. Löst nach Abschluss das Ereignis update
aus.
Parameter
Ohne.
Rückgabe
Kein zurückgegebener Wert
Legt die Werte mehrerer Eigenschaften fest. Löst nach Abschluss das Ereignis update
aus. Ruft die init
-Methode auf, wenn die Dateneigenschaft des Speichers nicht vorhanden ist.
Parameter
Rückgabe
Kein zurückgegebener Wert
Legt den Wert einer Eigenschaft fest. Löst nach Abschluss das Ereignis update
aus. Ruft die init
-Methode auf, wenn die Dateneigenschaft des Speichers nicht vorhanden ist.
Parameter
Rückgabe
Kein zurückgegebener Wert