JavaScript-API voor clientcontext
- Onderwerpen:
- Context Hub
Gemaakt voor:
- Developer
CAUTIONCQ_Analytics.ClientContextMgr
Het object CQ_Analytics.ClientContextMgr is een singleton dat een set zelfgeregistreerde sessiewinkels bevat en methoden biedt voor het registreren, voortzetten en beheren van de sessiewinkels.
Breidt CQ_Analytics.PersistedSessionStore uit.
Methoden
getRegisteredStore(name)
Retourneert een sessiearchief met een opgegeven naam. Zie ook Een sessiewinkel openen.
Parameters
- naam: Tekenreeks. De naam van de sessiewinkel.
Retourneert
Een CQ_Analytics.SessionStore-object dat de zittingsopslag van de opgegeven naam vertegenwoordigt. Retourneert null als er geen opslagplaats met de opgegeven naam bestaat.
register(sessionstore)
Registreert een zittingsopslag met de Context van de Cliënt. Hiermee worden gebeurtenissen in het opslagregister en de opslagperiode na voltooiing geactiveerd.
Parameters
- sessionstore: CQ_Analytics.SessionStore. Het sessieopslagobject dat moet worden geregistreerd.
Retourneert
Geen geretourneerde waarde.
CQ_Analytics.ClientContextUtils
Verstrekt methodes om op de activering en registratie van de zittingsopslag te luisteren. Zie ook Controleren of een Sessiewinkel is gedefinieerd en geïnitialiseerd.
Methoden
onStoreInitialized(storeName, callback, delay)
Registreert een callback functie die wordt geroepen wanneer een zittingsopslag wordt geïnitialiseerd. Voor opslag die verscheidene tijden worden geïnitialiseerd, specificeer een callback vertraging zodat de callback functie slechts eenmaal wordt geroepen:
- Wanneer de opslag tijdens de vertragingsperiode van een vorige initialisering wordt geïnitialiseerd, wordt de vorige functievraag geannuleerd, en de functie wordt opnieuw geroepen voor de huidige initialisering.
- Als de vertragingsperiode vervalt voordat een volgende initialisatie plaatsvindt, wordt de callback-functie twee keer uitgevoerd.
Een sessiewinkel is bijvoorbeeld gebaseerd op een JSON-object en opgehaald via een JSON-aanvraag. De volgende initialisatiescenario's zijn mogelijk:
- De aanvraag is voltooid, gegevens worden opgehaald en in de winkel geladen. In dit geval vindt de initialisatie eenmaal plaats.
- De aanvraag is mislukt (timeout). In dit geval gebeurt initialisatie niet en zijn er geen gegevens in de opslag.
- De opslag wordt vooraf gevuld met standaardwaarden (init-eigenschappen), maar de aanvraag mislukt (timeout). Er is slechts één initialisatie met standaardwaarden.
- De winkel is vooraf gevuld.
Wanneer de vertraging is ingesteld op true Voor een aantal milliseconden, wacht de methode alvorens de callback methode te roepen. Als een andere initialisatiegebeurtenis wordt geactiveerd voordat de vertraging wordt doorgegeven, wordt gewacht totdat de vertragingstijd is overschreden zonder initialisatiegebeurtenis. Dit laat het wachten op een tweede initialiseringsgebeurtenis toe om worden teweeggebracht en roept de callback functie in het meest optimale geval.
Parameters
- storeName: Tekenreeks. De naam van het sessiearchief om de listener toe te voegen.
- callback: Functie. De functie om op archiefinitialisatie te roepen.
- vertraging: Boolean of Number. De hoeveelheid tijd om de vraag aan de callback functie, in milliseconden te vertragen. Een booleaanse waarde van
truegebruikt de standaardvertraging van200 ms. Een booleaanse waarde vanfalseof een negatief getal zorgt ervoor dat geen vertraging wordt gebruikt.
Retourneert
Geen geretourneerde waarde.
onStoreRegistered(storeName, callback)
Registreert een callback functie die wordt geroepen wanneer een zittingsopslag wordt geregistreerd. De gebeurtenis register vindt plaats wanneer een winkel is geregistreerd bij CQ_Analytics.ClientContextMgr.
Parameters
- storeName: Tekenreeks. De naam van het sessiearchief om de listener toe te voegen.
- callback: Functie. De functie om op archiefinitialisatie te roepen.
Retourneert
Geen geretourneerde waarde.
CQ_Analytics.JSONPStore
Een niet-voortgezette sessiewinkel die JSON-gegevens bevat. De gegevens worden teruggewonnen van de externe dienst JSONP. Gebruik de getInstance of getRegisteredInstance methode om een instantie van deze klasse te maken.
Breidt CQ_Analytics.JSONStore uit.
Eigenschappen
Zie CQ_Analytics.JSONStore en CQ_Analytics.SessonStore voor geërfte eigenschappen.
Methoden
Zie ook CQ_Analytics.JSONStore en CQ_Analytics.SessonStore voor geërfte methodes.
getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback)
Maakt een CQ_Analytics.JSONPStore-object.
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters. Als er geen storeName is opgegeven, retourneert de methode null.
- serviceURL: Tekenreeks. De URL van de JSONP-service
- dynamicData: (Optioneel) Object. JSON-gegevens die aan de initialisatiegegevens van de winkel moeten worden toegevoegd voordat de callback-functie wordt aangeroepen.
- deferLoading: (Optioneel) Booleaans. De waarde true voorkomt dat de JSONP-service bij het maken van objecten wordt aangeroepen. Een waarde van vals veroorzaakt de dienst JSONP om worden geroepen.
- loadingCallback: (Optioneel) String. De naam van de functie om voor verwerking het voorwerp te roepen JSONP dat de dienst JSONP terugkeert. De callback functie moet één enkele parameter bepalen die een voorwerp CQ_Analytics.JSONPStore is.
Retourneert
Het nieuwe object CQ_Analytics.JSONPStore of null als storeName null is.
getServiceURL()
Hiermee wordt de URL opgehaald van de JSONP-service die dit object gebruikt om JSON-gegevens op te halen.
Parameters
Geen.
Retourneert
Een tekenreeks die de service-URL vertegenwoordigt, of null als er geen service-URL is geconfigureerd.
load(serviceURL, dynamicData, callback)
Roept de dienst JSONP aan. JSONP URL is de dienst URL die met een bepaalde callback functienaam wordt achtervoegd.
Parameters
- serviceURL: (Optioneel) String. De JSONP-service die moet worden aangeroepen. De waarde null zorgt ervoor dat de reeds geconfigureerde service-URL wordt gebruikt. Een waarde die niet gelijk is aan null, stelt de JSONP-service in die voor dit object moet worden gebruikt. (Zie setServiceURL.)
- dynamicData: (Optioneel) Object. JSON-gegevens die aan de initialisatiegegevens van de winkel moeten worden toegevoegd voordat de callback-functie wordt aangeroepen.
- callback: (Optioneel) String. De naam van de functie om voor verwerking het voorwerp te roepen JSONP dat de dienst JSONP terugkeert. De callback functie moet één enkele parameter bepalen die een voorwerp CQ_Analytics.JSONPStore is.
Retourneert
Geen geretourneerde waarde.
registerNewInstance(storeName, serviceURL, dynamicData, callback)
Maakt een CQ_Analytics.JSONPStore-object en registreert de winkel met Client-context.
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters. Als er geen storeName is opgegeven, retourneert de methode null.
- serviceURL: (Optioneel) String. De URL van de JSONP-service.
- dynamicData: (Optioneel) Object. JSON-gegevens die aan de initialisatiegegevens van de winkel moeten worden toegevoegd voordat de callback-functie wordt aangeroepen.
- callback: (Optioneel) String. De naam van de functie om voor verwerking het voorwerp te roepen JSONP dat de dienst JSONP terugkeert. De callback functie moet één enkele parameter bepalen die een voorwerp CQ_Analytics.JSONPStore is.
Retourneert
Het geregistreerde object CQ_Analytics.JSONPStore.
setServiceURL(serviceURL)
Plaatst URL van de dienst JSONP voor het terugwinnen van JSON- gegevens te gebruiken.
Parameters
- serviceURL: Tekenreeks. De URL van de JSONP-service die JSON-gegevens levert
Retourneert
Geen geretourneerde waarde.
CQ_Analytics.JSONStore
Een container voor een JSON-object. Maak een instantie van deze klasse om een niet-voortgezette sessiewinkel te maken die JSON-gegevens bevat:
myjsonstore = new CQ_Analytics.JSONStore
U kunt een reeks gegevens bepalen die de opslag bij initialisatie bevolkt.
Breidt CQ_Analytics.SessionStore uit.
Eigenschappen
STOREKEY
De sleutel die de opslag identificeert. Gebruik de getInstance methode om deze waarde op te halen.
STORENAME
De naam van de winkel. Gebruik de getInstance methode om deze waarde op te halen.
Methoden
Zie ook CQ_Analytics.SessionStore voor overerfde methoden.
clear()
Verwijdert de gegevens van de zittingsopslag en verwijdert alle initialiseringseigenschappen.
Parameters
Geen.
Retourneert
Geen geretourneerde waarde.
getInstance(storeName, jsonData)
Maakt een CQ_Analytics.JSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan).
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters.
- jsonData: Object. Een object dat JSON-gegevens bevat.
Retourneert
Het object CQ_Analytics.JSONStore.
getJSON()
Haalt de gegevens van de sessieopslag op in JSON-indeling.
Parameters
Geen.
Retourneert
Een object dat de opslaggegevens in JSON-indeling vertegenwoordigt.
init()
Wist de zittingsopslag en initialiseert het met het initialiseringsbezit. Hiermee wordt de initialisatiemarkering ingesteld op true en dan de initialize en update gebeurtenissen.
Parameters
Geen.
Retourneert
Geen geretourneerde gegevens.
initJSON(jsonData, doNotClear)
Maakt initialisatie-eigenschappen van de gegevens in een JSON-object. U kunt desgewenst alle bestaande initialisatie-eigenschappen verwijderen.
De namen van de eigenschappen worden afgeleid van de hiërarchie van de gegevens in het JSON-object. De volgende voorbeeldcode vertegenwoordigt een JSON-object:
{
A: "valueA",
B: {
B1: "valueBB1"
}
}
In dit voorbeeld worden de volgende eigenschappen gemaakt in de winkel:
A: "valueA"
B/B1: "valueBB1"
Parameters
- jsonData: Een JSON-object dat de gegevens bevat die moeten worden opgeslagen.
- doNotClear: Bij de waarde true blijven de bestaande initialisatie-eigenschappen behouden en worden de eigenschappen toegevoegd die zijn afgeleid van het JSON-object. Bij de waarde false worden de bestaande initialisatie-eigenschappen verwijderd voordat de eigenschappen uit het JSON-object worden toegevoegd.
Retourneert
Geen geretourneerde waarde.
registerNewInstance(storeName, jsonData)
Maakt een CQ_Analytics.JSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan). Het nieuwe object wordt automatisch geregistreerd bij Clickstream Cloud Manager.
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters.
- jsonData: Object. Een object dat JSON-gegevens bevat.
Retourneert
Het object CQ_Analytics.JSONStore.
CQ_Analytics.Observable
Hiermee worden gebeurtenissen geactiveerd en kunnen andere objecten naar deze gebeurtenissen luisteren en reageren. Klassen die deze klasse uitbreiden, kunnen gebeurtenissen doorlopen waardoor listeners worden aangeroepen.
Methoden
addListener (gebeurtenis, effect, bereik)
Registreert een listener voor een gebeurtenis. Zie ook Listener maken om te reageren op een update voor een sessiewinkel.
Parameters
- gebeurtenis: Tekenreeks. De naam van de gebeurtenis waarnaar moet worden geluisterd.
- fct: Functie. De functie die wordt aangeroepen wanneer de gebeurtenis plaatsvindt.
- bereik: (Optioneel) Object. Het bereik waarin de handlerfunctie moet worden uitgevoerd. De context van de handlerfunctie 'this'.
Retourneert
Geen geretourneerde waarde.
removeListener (gebeurtenis, fct)
Verwijdert de opgegeven gebeurtenishandler voor een gebeurtenis.
Parameters
- gebeurtenis: Tekenreeks. De naam van de gebeurtenis.
- fct: Functie. De gebeurtenishandler.
Retourneert
Geen geretourneerde waarde.
CQ_Analyics.PersistedJSONPStore
Een persistente container van een JSON-object dat is opgehaald van een externe JSONP-service.
Breidt CQ_Analytics.PersistedJSONStore uit.
Methoden
Zie ook CQ_Analytics.PersistedJSONStore voor geërfte methodes.
getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback)
Maakt een CQ_Analytics.PersistedJSONPStore-object.
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters. Als er geen storeName is opgegeven, retourneert de methode null.
- serviceURL: Tekenreeks. De URL van de JSONP-service
- dynamicData: (Optioneel) Object. JSON-gegevens die aan de initialisatiegegevens van de winkel moeten worden toegevoegd voordat de callback-functie wordt aangeroepen.
- deferLoading: (Optioneel) Booleaans. De waarde true voorkomt dat de JSONP-service bij het maken van objecten wordt aangeroepen. Een waarde van vals veroorzaakt de dienst JSONP om worden geroepen.
- loadingCallback: (Optioneel) String. De naam van de functie om voor verwerking het voorwerp te roepen JSONP dat de dienst JSONP terugkeert. De callback functie moet één enkele parameter bepalen die een voorwerp CQ_Analytics.JSONPStore is.
Retourneert
Het nieuwe object CQ_Analytics.PersistedJSONPStore of null als storeName null is.
getServiceURL()
Hiermee wordt de URL opgehaald van de JSONP-service die dit object gebruikt om JSON-gegevens op te halen.
Parameters
Geen.
Retourneert
Een tekenreeks die de service-URL vertegenwoordigt, of null als er geen service-URL is geconfigureerd.
load(serviceURL, dynamicData, callback)
Roept de dienst JSONP aan. JSONP URL is de dienst URL die met een bepaalde callback functienaam wordt achtervoegd.
Parameters
- serviceURL: (Optioneel) String. De JSONP-service die moet worden aangeroepen. De waarde null zorgt ervoor dat de reeds geconfigureerde service-URL wordt gebruikt. Een waarde die niet gelijk is aan null, stelt de JSONP-service in die voor dit object moet worden gebruikt. (Zie setServiceURL.)
- dynamicData: (Optioneel) Object. JSON-gegevens die aan de initialisatiegegevens van de winkel moeten worden toegevoegd voordat de callback-functie wordt aangeroepen.
- callback: (Optioneel) String. De naam van de functie om voor verwerking het voorwerp te roepen JSONP dat de dienst JSONP terugkeert. De callback functie moet één enkele parameter bepalen die een voorwerp CQ_Analytics.JSONPStore is.
Retourneert
Geen geretourneerde waarde.
registerNewInstance(storeName, serviceURL, dynamicData, callback)
Maakt een CQ_Analytics.PersistedJSONPStore-object en registreert de winkel met Client-context.
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters. Als er geen storeName is opgegeven, retourneert de methode null.
- serviceURL: (Optioneel) String. De URL van de JSONP-service.
- dynamicData: (Optioneel) Object. JSON-gegevens die aan de initialisatiegegevens van de winkel moeten worden toegevoegd voordat de callback-functie wordt aangeroepen.
- callback: (Optioneel) String. De naam van de functie om voor verwerking het voorwerp te roepen JSONP dat de dienst JSONP terugkeert. De callback functie moet één enkele parameter bepalen die een voorwerp CQ_Analytics.JSONPStore is.
Retourneert
Het geregistreerde object CQ_Analytics.PersistedJSONPStore.
setServiceURL(serviceURL)
Plaatst URL van de dienst JSONP voor het terugwinnen van JSON- gegevens te gebruiken.
Parameters
- serviceURL: Tekenreeks. De URL van de JSONP-service die JSON-gegevens levert
Retourneert
Geen geretourneerde waarde.
CQ_Analytics.PersistedJSONStore
Een persistente container van een JSON-object.
Uitbreidingen CQ_Analytics.PersistedSessionStore.
Eigenschappen
STOREKEY
De sleutel die de opslag identificeert. Gebruik de getInstance methode om deze waarde op te halen.
STORENAME
De naam van de winkel. Gebruik de getInstance methode om deze waarde op te halen.
Methoden
Zie ook CQ_Analytics.PersistedSessionStore voor overerfde methoden.
getInstance(storeName, jsonData)
Maakt een CQ_Analytics.PersistedJSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan).
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters.
- jsonData: Object. Een object dat JSON-gegevens bevat.
Retourneert
Het object CQ_Analytics.PersistedJSONStore.
getJSON()
Haalt de gegevens van de sessieopslag op in JSON-indeling.
Parameters
Geen.
Retourneert
Een object dat de opslaggegevens in JSON-indeling vertegenwoordigt.
initJSON(jsonData, doNotClear)
Maakt initialisatie-eigenschappen van de gegevens in een JSON-object. U kunt desgewenst alle bestaande initialisatie-eigenschappen verwijderen.
De namen van de eigenschappen worden afgeleid van de hiërarchie van de gegevens in het JSON-object. De volgende voorbeeldcode vertegenwoordigt een JSON-object:
{
A: "valueA",
B: {
B1: "valueBB1"
}
}
In dit voorbeeld worden de volgende eigenschappen gemaakt in de winkel:
A: "valueA"
B/B1: "valueBB1"
Parameters
- jsonData: Een JSON-object dat de gegevens bevat die moeten worden opgeslagen.
- doNotClear: Bij de waarde true blijven de bestaande initialisatie-eigenschappen behouden en worden de eigenschappen toegevoegd die zijn afgeleid van het JSON-object. Bij de waarde false worden de bestaande initialisatie-eigenschappen verwijderd voordat de eigenschappen uit het JSON-object worden toegevoegd.
Retourneert
Geen geretourneerde waarde.
registerNewInstance(storeName, jsonData)
Maakt een CQ_Analytics.PersistedJSONStore-object met een opgegeven naam en geïnitialiseerd met de opgegeven JSON-gegevens (roept de methode initJSON aan). Het nieuwe object wordt automatisch geregistreerd bij Client Context Manager.
Parameters
- storeName: Tekenreeks. De naam die als eigenschap STORENAME moet worden gebruikt. De waarde van het bezit STOREKEY wordt geplaatst aan storeName met alle karakters in hoofdletters.
- jsonData: Object. Een object dat JSON-gegevens bevat.
Retourneert
Het object CQ_Analytics.PersistedJSONStore.
CQ_Analytics.PersistedSessionStore
Een container met eigenschappen en waarden. De gegevens blijven bestaan met CQ_Analytics.SessionPersistence. Maak een instantie van deze klasse om een persisted session store te maken:
mypersistedstore = new CQ_Analytics.PersistedSessionStore
Breidt CQ_Analytics.SessionStore uit.
Eigenschappen
STOREKEY
De standaardwaarde is key.
Methoden
Zie CQ_Analytics.SessionStore voor overerfde methoden.
Wanneer de overerfde methoden clear, setProperty, setProperties, removeProperty worden gebruikt om de opslaggegevens te wijzigen, worden de wijzigingen automatisch doorgevoerd, tenzij de gewijzigde eigenschappen als notPersisted worden gemarkeerd.
getStoreKey()
Hiermee wordt het dialoogvenster STOREKEY eigenschap.
Parameters
Geen
Retourneert
De waarde van de STOREKEY eigenschap.
isPersisted(name)
Hiermee wordt bepaald of een gegevenseigenschap wordt gepresteerd.
Parameters
- naam: Tekenreeks. De naam van de eigenschap.
Retourneert
Een Booleaanse waarde van true als de eigenschap aanhoudt, en een waarde van false als de waarde geen blijvend bezit is.
persist()
Houdt de zittingsopslag voort. De standaardpersistentiemodus gebruikt browser localStorage gebruiken ClientSidePersistence als de naam ( window.localStorage.set("ClientSidePersistance", store);)
Als localStorage niet beschikbaar of schrijfbaar is, dan wordt de opslag voortgeduurd als bezit van het venster.
Hiermee wordt het persist gebeurtenis na voltooiing.
Parameters
Geen
Retourneert
Geen geretourneerde waarde.
reset(delayEvent)
Hiermee verwijdert u alle gegevenseigenschappen uit de winkel en gaat u door met de winkel. Optioneel wordt het dialoogvenster udpate gebeurtenis na voltooiing.
Parameters
- delayEvent: De waarde true voorkomt het
update-gebeurtenis worden geactiveerd. Een waarde vanfalsezorgt dat de updategebeurtenis wordt gestart.
Retourneert
Geen geretourneerde waarde.
setNonPersisted(name)
Hiermee wordt een gegevenseigenschap gemarkeerd als niet voortgezet.
Parameters
- naam: Tekenreeks. The name of the property that is not to be persisted.
Retourneert
Geen retourwaarde.
CQ_Analytics.SessionStore
CQ_Analytics.SessionStore vertegenwoordigt een zittingsopslag. Maak een instantie van deze klasse om een sessiewinkel te maken:
mystore = new CQ_Analytics.SessionStore
Breidt CQ_Analytics.Observable uit.
Eigenschappen
STORENAME
De naam van de sessiewinkel. Gebruik getName om de waarde van deze eigenschap op te halen.
Methoden
addInitProperty(name, value)
Voegt een bezit en een waarde aan de de initialisatiegegevens van de zittingsopslag toe.
Gebruik loadInitProperties om de gegevens van de zittingsopslag met de initialisatiewaarden te bevolken.
Parameters
- naam: Tekenreeks. De naam van de eigenschap die moet worden toegevoegd.
- waarde: Tekenreeks. De waarde van de eigenschap die moet worden toegevoegd.
Retourneert
Geen geretourneerde waarde.
clear()
Hiermee verwijdert u alle gegevenseigenschappen uit de opslagruimte.
Parameters
Geen.
Retourneert
Geen retourwaarde.
getData(uitgesloten)
Retourneert de opslaggegevens. Hiermee worden naameigenschappen eventueel uitgesloten van de gegevens. roept de init methode als het gegevensbezit van de opslag niet bestaat.
Parameters
uitgesloten: (Optioneel) Een array met namen van eigenschappen die worden uitgesloten van de geretourneerde gegevens.
Retourneert
Een object met eigenschappen en hun waarden.
getInitProperty(name)
Hiermee wordt de waarde van een eigenschap data opgehaald.
Parameters
- naam: Tekenreeks. The name of the data property to retrieve.
Retourneert
De waarde van de eigenschap data. Returns null als de zittingsopslag geen bezit van de bepaalde naam bevat.
getName()
Retourneert de naam van de sessiewinkel.
Parameters
Geen.
Retourneert
Een tekenreekswaarde die staat voor de winkelnaam.
getProperty(name, raw)
Retourneert de waarde van een eigenschap. De waarde wordt geretourneerd als de onbewerkte eigenschap of de XSS-gefilterde waarde. roept de init methode als het gegevensbezit van de opslag niet bestaat.
Parameters
- naam: Tekenreeks. The name of the data property to retrieve.
- raw: Booleaans. De waarde true zorgt ervoor dat de waarde van de onbewerkte eigenschap wordt geretourneerd. Bij de waarde false wordt de geretourneerde waarde XSS-gefilterd.
Retourneert
De waarde van de eigenschap data.
getPropertyNames(uitgesloten)
Retourneert de namen van de eigenschappen die de sessieopslag bevat. roept de init methode als het gegevensbezit van de opslag niet bestaat.
Parameters
uitgesloten: (Optioneel) Een array met namen van eigenschappen die uit de resultaten moeten worden weggelaten.
Retourneert
Een array met tekenreekswaarden die staan voor de namen van de sessieeigenschappen.
getSessionStore()
Retourneert de sessiewinkel die aan het huidige object is gekoppeld.
Parameters
Geen.
Retourneert
dit
init()
Hiermee wordt de winkel gemarkeerd als geïnitialiseerd en wordt de knop initialize gebeurtenis.
Parameters
Geen.
Retourneert
Geen geretourneerde waarde.
isInitialized()
Geeft aan of de opslag van sessies is geïnitialiseerd.
Parameters
Geen.
Retourneert
Een waarde van true als de winkel is geïnitialiseerd, en een waarde van false als de winkel niet is geïnitialiseerd.
loadInitProperties(obj, setValues)
Voegt de eigenschappen van een bepaald voorwerp aan de initialisatiegegevens van de zittingsopslag toe. Optioneel worden de objectgegevens ook toegevoegd aan de opslaggegevens.
Parameters
- obj: Een object dat opsombare eigenschappen bevat.
- setValues: Indien waar (true), worden de eigenschappen obj toegevoegd aan de opslaggegevens van de sessie als de opslaggegevens nog geen eigenschap met dezelfde naam bevatten. Wanneer de waarde false is, worden geen gegevens toegevoegd aan de opslaggegevens van de sessie.
Retourneert
Geen geretourneerde waarde.
removeProperty(name)
Hiermee wordt een eigenschap uit de sessieopslag verwijderd. Hiermee wordt het update gebeurtenis na voltooiing. roept de init methode als het gegevensbezit van de opslag niet bestaat.
Parameters
- naam: Tekenreeks. De naam van de eigenschap die moet worden verwijderd.
Retourneert
Geen geretourneerde waarde.
reset()
Hiermee herstelt u de oorspronkelijke waarden van de gegevensopslag. De standaardimplementatie verwijdert eenvoudig alle gegevens. Hiermee wordt het update gebeurtenis na voltooiing.
Parameters
Geen.
Retourneert
Geen geretourneerde waarde.
setProperties(eigenschappen)
Stelt de waarden van meerdere eigenschappen in. Hiermee wordt het update gebeurtenis na voltooiing. roept de init methode als het gegevensbezit van de opslag niet bestaat.
Parameters
- Eigenschappen: Object. Een object dat opsombare eigenschappen bevat. Elke eigenschapsnaam en -waarde wordt toegevoegd aan de winkel.
Retourneert
Geen geretourneerde waarde.
setProperty(name, value)
Hiermee wordt de waarde van een eigenschap ingesteld. Hiermee wordt het update gebeurtenis na voltooiing. roept de init methode als het gegevensbezit van de opslag niet bestaat.
Parameters
- naam: Tekenreeks. De naam van de eigenschap.
- waarde: Tekenreeks. Waarde eigenschap.
Retourneert
Geen geretourneerde waarde.