Client Context JavaScript API client-context-javascript-api

CQ_Analytics.ClientContextMgr cq-analytics-clientcontextmgr

CQ_Analytics.ClientContextMgr 개체는 자가 등록된 세션 저장소 집합을 포함하는 단일 항목이며, 세션 저장소를 등록, 유지 및 관리하는 방법을 제공합니다.

CQ_Analytics.PersistedSessionStore를 확장합니다.

메서드 methods

getRegisteredStore(name) getregisteredstore-name

지정된 이름의 세션 저장소를 반환합니다. 참조: 세션 저장소 액세스.

매개변수

반환

지정된 이름의 세션 저장소를 나타내는 CQ_Analytics.SessionStore 개체. 반환 null 지정된 이름의 저장소가 없는 경우.

register(sessionstore) register-sessionstore

Client Context에 세션 저장소를 등록합니다. 완료 시 storeregister 및 storeupdate 이벤트를 실행합니다.

매개변수

반환

반환된 값이 없습니다.

CQ_Analytics.ClientContextUtils cq-analytics-clientcontextutils

세션 저장소 활성화 및 등록에 대한 수신 대기 방법을 제공합니다. 참조: 세션 저장소가 정의 및 초기화되었는지 확인.

메서드 methods-1

onStoreInitialized(storeName, callback, delay) onstoreinitialized-storename-callback-delay

세션 저장소가 초기화될 때 호출되는 콜백 함수를 등록합니다. 여러 번 초기화된 저장소의 경우 콜백 함수를 한 번만 호출하도록 콜백 지연을 지정합니다.

예를 들어 세션 저장소는 JSON 개체를 기반으로 하며 JSON 요청을 통해 검색됩니다. 다음과 같은 초기화 시나리오가 가능합니다.

지연이 (으)로 설정된 경우 true 메서드가 callback 메서드를 호출하기 전에 몇 밀리초 동안 대기합니다. 지연이 전달되기 전에 다른 초기화 이벤트가 트리거되면 초기화 이벤트 없이 지연 시간이 초과될 때까지 대기합니다. 이렇게 하면 두 번째 초기화 이벤트가 트리거될 때까지 기다렸다가 가장 적합한 경우에 콜백 함수를 호출할 수 있습니다.

매개변수

반환

반환된 값이 없습니다.

onStoreRegistered(storeName, callback) onstoreregistered-storename-callback

세션 저장소가 등록될 때 호출되는 콜백 함수를 등록합니다. register 이벤트는 스토어가 등록될 때 발생합니다. CQ_Analytics.ClientContextMgr.

매개변수

반환

반환된 값이 없습니다.

CQ_Analytics.JSONPtore cq-analytics-jsonpstore

JSON 데이터를 포함하는 지속되지 않는 세션 저장소입니다. 데이터는 외부 JSONP 서비스에서 검색됩니다. 사용 getInstance 또는 getRegisteredInstance 메서드를 사용하여 이 클래스의 인스턴스를 만듭니다.

CQ_Analytics.JSONStore를 확장합니다.

속성 properties

상속된 등록 정보는 CQ_Analytics.JSONSstore 및 CQ_Analytics.SessonStore 를 참조하십시오.

메서드 methods-2

상속된 메서드에 대해서는 CQ_Analytics.JSONSstore 및 CQ_Analytics.SessonStore 도 참조하십시오.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback) getinstance-storename-serviceurl-dynamicdata-deferloading-loadingcallback

CQ_Analytics.JSONPtore 개체를 만듭니다.

매개변수

반환

새 CQ_Analytics.JSONPStore 개체 또는 storeName이 null인 경우 null입니다.

getServiceURL() getserviceurl

이 개체가 JSON 데이터를 검색하는 데 사용하는 JSONP 서비스의 URL을 검색합니다.

매개변수

없음.

반환

서비스 URL을 나타내는 문자열이거나, 서비스 URL이 구성되지 않은 경우 null입니다.

load(serviceURL, dynamicData, callback) load-serviceurl-dynamicdata-callback

JSONP 서비스를 호출합니다. JSONP URL은 콜백 함수 이름 부여가 붙은 서비스 URL입니다.

매개변수

반환

반환된 값이 없습니다.

registerNewInstance(storeName, serviceURL, dynamicData, callback) registernewinstance-storename-serviceurl-dynamicdata-callback

CQ_Analytics.JSONPtore 개체를 만들고 Client Context에 저장소를 등록합니다.

매개변수

반환

등록된 CQ_Analytics.JSONPStore 개체입니다.

setServiceURL(serviceURL) setserviceurl-serviceurl

JSON 데이터 검색에 사용할 JSONP 서비스의 URL을 설정합니다.

매개변수

반환

반환된 값이 없습니다.

CQ_Analytics.JSONStore cq-analytics-jsonstore

JSON 개체의 컨테이너입니다. JSON 데이터를 포함하는 지속되지 않는 세션 저장소를 만들려면 이 클래스의 인스턴스를 만듭니다.

myjsonstore = new CQ_Analytics.JSONStore

초기화 시 저장소를 채우는 데이터 세트를 정의할 수 있습니다.

CQ_Analytics.SessionStore를 확장합니다.

속성 properties-1

STOREKEY storekey

스토어를 식별하는 키입니다. 사용 getInstance 메서드를 사용하여 이 값을 검색합니다.

STORENAME storename

스토어의 이름입니다. 사용 getInstance 메서드를 사용하여 이 값을 검색합니다.

메서드 methods-3

상속된 메서드에 대해서는 CQ_Analytics.SessionStore 도 참조하십시오.

clear() clear

세션 저장소 데이터를 제거하고 모든 초기화 속성을 제거합니다.

매개변수

없음.

반환

반환된 값이 없습니다.

getInstance(storeName, jsonData) getinstance-storename-jsondata

지정된 이름으로 CQ_Analytics.JSONStore 개체를 만들고 지정된 JSON 데이터로 초기화됩니다(initJSON 메서드 호출).

매개변수

반환

CQ_Analytics.JSONStore 개체.

getJSON() getjson

세션 저장소의 데이터를 JSON 형식으로 검색합니다.

매개변수

없음.

반환

저장소 데이터를 JSON 형식으로 나타내는 개체입니다.

init() init

세션 저장소를 지우고 초기화 속성으로 초기화합니다. 초기화 플래그를 다음으로 설정합니다. true 그런 다음 을 실행합니다. initialize 및 update 이벤트.

매개변수

없음.

반환

반환된 데이터가 없습니다.

initJSON(jsonData, doNotClear) initjson-jsondata-donotclear

JSON 개체의 데이터에서 초기화 속성을 만듭니다. 선택적으로 기존 초기화 등록 정보를 모두 제거할 수 있습니다.

속성 이름은 JSON 개체에 있는 데이터의 계층에서 파생됩니다. 다음 예제 코드는 JSON 개체를 나타냅니다.

{
A: "valueA",
B: {
     B1: "valueBB1"
    }
}

이 예제의 경우 스토어에 다음 속성이 만들어집니다.

A: "valueA"
B/B1: "valueBB1"

매개변수

반환

반환된 값이 없습니다.

registerNewInstance(storeName, jsonData) registernewinstance-storename-jsondata

지정된 이름으로 CQ_Analytics.JSONStore 개체를 만들고 지정된 JSON 데이터로 초기화됩니다(initJSON 메서드 호출). 새 개체는 Clickstream Cloud Manager에 자동으로 등록됩니다.

매개변수

반환

CQ_Analytics.JSONStore 개체.

CQ_Analytics.Observable cq-analytics-observable

이벤트를 실행하고 다른 개체가 이러한 이벤트를 수신하고 반응할 수 있도록 합니다. 이 클래스를 확장하는 클래스는 리스너를 호출하게 하는 이벤트를 실행할 수 있습니다.

메서드 methods-4

addListener(event, fct, scope) addlistener-event-fct-scope

이벤트에 대한 리스너를 등록합니다. 참조: 세션 저장소 업데이트에 대한 리스너 생성.

매개변수

반환

반환된 값이 없습니다.

removeListener(event, fct) removelistener-event-fct

이벤트에 대해 지정된 이벤트 처리기를 제거합니다.

매개변수

반환

반환된 값이 없습니다.

CQ_Analyics.PersistedJSONPtore cq-analyics-persistedjsonpstore

원격 JSONP 서비스에서 검색한 JSON 개체의 지속된 컨테이너입니다.

CQ_Analytics.PersistedJSONStore를 확장합니다.

메서드 methods-5

상속된 메서드에 대해서는 CQ_Analytics.PersistedJSONStore 도 참조하십시오.

getInstance(storeName, serviceURL, dynamicData, deferLoading, loadingCallback) getinstance-storename-serviceurl-dynamicdata-deferloading-loadingcallback-1

CQ_Analytics.PersistedJSONPtore 개체를 만듭니다.

매개변수

반환

새 CQ_Analytics.PersistedJSONPtore 개체 또는 storeName이 null인 경우 null입니다.

getServiceURL() getserviceurl-1

이 개체가 JSON 데이터를 검색하는 데 사용하는 JSONP 서비스의 URL을 검색합니다.

매개변수

없음.

반환

서비스 URL을 나타내는 문자열이거나, 서비스 URL이 구성되지 않은 경우 null입니다.

load(serviceURL, dynamicData, callback) load-serviceurl-dynamicdata-callback-1

JSONP 서비스를 호출합니다. JSONP URL은 콜백 함수 이름 부여가 붙은 서비스 URL입니다.

매개변수

반환

반환된 값이 없습니다.

registerNewInstance(storeName, serviceURL, dynamicData, callback) registernewinstance-storename-serviceurl-dynamicdata-callback-1

CQ_Analytics.PersistedJSONPtore 개체를 만들고 Client Context에 저장소를 등록합니다.

매개변수

반환

등록된 CQ_Analytics.PersistedJSONPtore 개체입니다.

setServiceURL(serviceURL) setserviceurl-serviceurl-1

JSON 데이터 검색에 사용할 JSONP 서비스의 URL을 설정합니다.

매개변수

반환

반환된 값이 없습니다.

CQ_Analytics.PersistedJSONStore cq-analytics-persistedjsonstore

JSON 개체의 지속된 컨테이너입니다.

확장 CQ_Analytics.PersistedSessionStore.

속성 properties-2

STOREKEY storekey-1

스토어를 식별하는 키입니다. 사용 getInstance 메서드를 사용하여 이 값을 검색합니다.

STORENAME storename-1

스토어의 이름입니다. 사용 getInstance 메서드를 사용하여 이 값을 검색합니다.

메서드 methods-6

상속된 메서드에 대해서는 CQ_Analytics.PersistedSessionStore 도 참조하십시오.

getInstance(storeName, jsonData) getinstance-storename-jsondata-1

지정된 이름으로 CQ_Analytics.PersistedJSONStore 개체를 만들고 지정된 JSON 데이터로 초기화됩니다(initJSON 메서드 호출).

매개변수

반환

CQ_Analytics.PersistedJSONStore 개체.

getJSON() getjson-1

세션 저장소의 데이터를 JSON 형식으로 검색합니다.

매개변수

없음.

반환

저장소 데이터를 JSON 형식으로 나타내는 개체입니다.

initJSON(jsonData, doNotClear) initjson-jsondata-donotclear-1

JSON 개체의 데이터에서 초기화 속성을 만듭니다. 선택적으로 기존 초기화 등록 정보를 모두 제거할 수 있습니다.

속성 이름은 JSON 개체에 있는 데이터의 계층에서 파생됩니다. 다음 예제 코드는 JSON 개체를 나타냅니다.

{
A: "valueA",
B: {
     B1: "valueBB1"
    }
}

이 예제의 경우 스토어에 다음 속성이 만들어집니다.

A: "valueA"
B/B1: "valueBB1"

매개변수

반환

반환된 값이 없습니다.

registerNewInstance(storeName, jsonData) registernewinstance-storename-jsondata-1

지정된 이름으로 CQ_Analytics.PersistedJSONStore 개체를 만들고 지정된 JSON 데이터로 초기화됩니다(initJSON 메서드 호출). 새 개체는 Client Context Manager에 자동으로 등록됩니다.

매개변수

반환

CQ_Analytics.PersistedJSONStore 개체.

CQ_Analytics.PersistedSessionStore cq-analytics-persistedsessionstore

속성 및 값의 컨테이너입니다. 데이터는 CQ_Analytics.SessionPersistence를 사용하여 지속됩니다. 이 클래스의 인스턴스를 만들어 지속 세션 저장소를 만듭니다.

mypersistedstore = new CQ_Analytics.PersistedSessionStore

CQ_Analytics.SessionStore를 확장합니다.

속성 properties-3

STOREKEY storekey-2

기본값은 입니다. key.

메서드 methods-7

상속된 메서드에 대해서는 CQ_Analytics.SessionStore 를 참조하십시오.

상속된 메서드인 경우 clear, setProperty, setProperties, removeProperty 는 저장소 데이터를 변경하는 데 사용되며, 변경된 속성에 notPersisted 플래그가 지정되지 않는 한 변경 사항이 자동으로 유지됩니다.

getStoreKey() getstorekey

를 검색합니다. STOREKEY 속성.

매개변수

없음

반환

값 STOREKEY 속성.

isPersisted(name) ispersisted-name

데이터 속성이 유지되는지 여부를 결정합니다.

매개변수

반환

부울 값 true 속성이 지속되는 경우 값 false 값이 지속된 속성이 아닌 경우.

persist() persist

세션 저장소를 유지합니다. 기본 지속성 모드에서는 브라우저를 사용합니다. localStorage 사용 ClientSidePersistence 이름()으로 window.localStorage.set("ClientSidePersistance", store);)

localStorage를 사용할 수 없거나 쓸 수 없는 경우 저장소는 창의 속성으로 유지됩니다.

를 실행합니다. persist 완료 시 이벤트입니다.

매개변수

없음

반환

반환된 값이 없습니다.

reset(deferEvent) reset-deferevent

저장소에서 모든 데이터 속성을 제거하고 저장소를 유지합니다. 필요한 경우 를 실행하지 않습니다. udpate 완료 시 이벤트입니다.

매개변수

반환

반환된 값이 없습니다.

setNonPersisted(name) setnonpersisted-name

데이터 속성에 지속되지 않은 것으로 플래그를 지정합니다.

매개변수

반환

반환 값이 없습니다.

CQ_Analytics.SessionStore cq-analytics-sessionstore

CQ_Analytics.SessionStore는 세션 저장소를 나타냅니다. 세션 저장소를 만들려면 이 클래스의 인스턴스를 만듭니다.

mystore = new CQ_Analytics.SessionStore

CQ_Analytics.Observable을 확장합니다.

속성 properties-4

STORENAME storename-2

세션 저장소의 이름입니다. getName을 사용하여 이 속성의 값을 검색합니다.

메서드 methods-8

addInitProperty(name, value) addinitproperty-name-value

세션 저장소 초기화 데이터에 속성 및 값을 추가합니다.

loadInitProperties를 사용하여 세션 저장소 데이터를 초기화 값으로 채웁니다.

매개변수

반환

반환된 값이 없습니다.

clear() clear-1

저장소에서 모든 데이터 속성을 제거합니다.

매개변수

없음.

반환

반환 값이 없습니다.

getData(제외됨) getdata-excluded

저장소 데이터를 반환합니다. 선택적으로, 에서는 데이터에서 이름 속성을 제외합니다. 호출 init 저장소의 데이터 속성이 없는 경우 메서드입니다.

매개변수

제외됨: (선택 사항) 반환된 데이터에서 제외할 속성 이름의 배열입니다.

반환

속성 및 해당 값의 객체입니다.

getInitProperty(name) getinitproperty-name

데이터 속성의 값을 검색합니다.

매개변수

반환

데이터 속성의 값입니다. 반환 null 세션 저장소에 지정된 이름의 속성이 없는 경우입니다.

getName() getname

세션 저장소의 이름을 반환합니다.

매개변수

없음.

반환

저장소 이름을 나타내는 문자열 값입니다.

getProperty(name, raw) getproperty-name-raw

속성 값을 반환합니다. 이 값은 원시 속성 또는 XSS 필터 값으로 반환됩니다. 호출 init 저장소의 데이터 속성이 없는 경우 메서드입니다.

매개변수

반환

데이터 속성의 값입니다.

getPropertyNames(제외됨) getpropertynames-excluded

세션 저장소에 포함된 속성의 이름을 반환합니다. 호출 init 저장소의 데이터 속성이 없는 경우 메서드입니다.

매개변수

제외됨: (선택 사항) 결과에서 생략할 속성 이름의 배열입니다.

반환

세션 속성 이름을 나타내는 문자열 값의 배열입니다.

getSessionStore() getsessionstore

현재 개체에 첨부된 세션 저장소를 반환합니다.

매개변수

없음.

반환

이

init() init-1

저장소를 초기화된 것으로 표시하고 를 실행합니다. initialize 이벤트.

매개변수

없음.

반환

반환된 값이 없습니다.

isInitialized() isinitialized

세션 저장소 초기화 여부를 나타냅니다.

매개변수

없음.

반환

값 true 저장소가 초기화되고 값이 false 저장소가 초기화되지 않은 경우.

loadInitProperties(obj, setValues) loadinitproperties-obj-setvalues

지정된 개체의 속성을 세션 저장소의 초기화 데이터에 추가합니다. 선택적으로 개체 데이터도 저장소 데이터에 추가됩니다.

매개변수

반환

반환된 값이 없습니다.

removeProperty(name) removeproperty-name

세션 저장소에서 속성을 제거합니다. 를 실행합니다. update 완료 시 이벤트입니다. 호출 init 저장소의 데이터 속성이 없는 경우 메서드입니다.

매개변수

반환

반환된 값이 없습니다.

reset() reset

데이터 저장소의 초기 값을 복원합니다. 기본 구현은 모든 데이터를 제거합니다. 를 실행합니다. update 완료 시 이벤트입니다.

매개변수

없음.

반환

반환된 값이 없습니다.

setProperties(properties) setproperties-properties

여러 속성의 값을 설정합니다. 를 실행합니다. update 완료 시 이벤트입니다. 호출 init 저장소의 데이터 속성이 없는 경우 메서드입니다.

매개변수

반환

반환된 값이 없습니다.

setProperty(name, value) setproperty-name-value

속성의 값을 설정합니다. 를 실행합니다. update 완료 시 이벤트입니다. 호출 init 저장소의 데이터 속성이 없는 경우 메서드입니다.

매개변수

반환

반환된 값이 없습니다.