ContextHub Javascript API 참조

주의

AEM 6.4가 확장 지원이 종료되었으며 이 설명서는 더 이상 업데이트되지 않습니다. 자세한 내용은 기술 지원 기간. 지원되는 버전 찾기 여기.

ContextHub Javascript API는 ContextHub 구성 요소가 페이지에 추가되었습니다.

ContextHub 상수

ContextHub Javascript API가 정의하는 상수 값입니다.

이벤트 상수

다음 표에는 ContextHub 저장소에 대해 발생하는 이벤트 이름이 나와 있습니다. 참조 - ContextHub.Utils.Eventing.

상수	설명	값
ContextHub.Constants.EVENT_NAMESPACE	ContextHub의 이벤트 네임스페이스	ch
ContextHub.Constants.EVENT_ALL_STORES_READY	모든 필수 저장소가 등록되고 초기화되며 사용할 준비가 되었음을 나타냅니다	모든 상점에서 사용 가능
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY	지정된 시간 제한 내에 모든 저장소가 초기화되지 않았음을 나타냅니다	부분 준비
ContextHub.Constants.EVENT_STORE_REGISTERED	스토어가 등록되면 실행됩니다.	스토어 등록
ContextHub.Constants.EVENT_STORE_READY	저장소가 작동할 준비가 되었음을 나타냅니다. 데이터를 가져올 때 실행되는 JSONP 저장소를 제외하고 등록 후 즉시 트리거됩니다.	스토어 준비
ContextHub.Constants.EVENT_STORE_UPDATED	저장소가 지속성을 업데이트할 때 실행됩니다	저장 업데이트됨
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME	지속성 컨테이너 이름	ContextHubPersistence
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY	원시 JSON 결과가 저장되는 특정 지속성 키 이름을 저장합니다	/_/raw 응답
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY	JSON 데이터를 가져오는 시점을 나타내는 특정 타임스탬프를 저장합니다	/_/response-time
ContextHub.Constants.SERVICE_LAST_URL_KEY	마지막 호출 동안 사용된 JSON 서비스의 특정 URL을 저장합니다	/_/url
ContextHub.Constants.IS_CONTAINER_EXPANDED	ContextHub의 UI가 확장되었는지 여부를 나타냅니다	/_/container-expanded

UI 이벤트 상수

다음 표에는 ContextHub UI에 대해 발생하는 이벤트 이름이 나와 있습니다.

상수	설명	값
ContextHub.Constants.EVENT_UI_MODE_REGISTERED	모드가 등록되면 실행됩니다	ui 모드 등록
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED	모드가 등록되지 않은 경우 실행됩니다	ui-mode-unregister
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED	모드 렌더러가 등록되면 실행됩니다	ui-mode-renderer-registered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED	모드 렌더러가 등록되지 않은 경우 실행됩니다	ui-mode-renderer-unregister
ContextHub.Constants.EVENT_UI_MODE_ADDED	새 모드가 추가되면 실행됩니다	ui-mode-added
ContextHub.Constants.EVENT_UI_MODE_REMOVED	모드가 제거되면 실행됩니다	ui 모드 제거됨
ContextHub.Constants.EVENT_UI_MODE_SELECTED	사용자가 모드를 선택하면 실행됩니다	ui 모드 선택
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED	새 모듈이 등록되면 실행됩니다	ui 모듈 등록
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED	모듈이 등록되지 않은 경우 실행됩니다	ui-module-unregister
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED	모듈 렌더러가 등록될 때 실행됩니다	ui-module-renderer-registered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED	모듈 렌더러가 등록되지 않은 경우 실행됩니다	ui-module-renderer-unregister
ContextHub.Constants.EVENT_UI_MODULE_ADDED	새 모듈이 추가되면 실행됩니다	ui-module-added
ContextHub.Constants.EVENT_UI_MODULE_REMOVED	모듈이 제거되면 실행됩니다	ui-module-removed
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED	UI 컨테이너가 페이지에 추가되면 실행됩니다	ui-container-added
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED	ContextHub UI가 열려 있을 때 실행됩니다	ui-container-opened
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED	ContextHub UI가 축소될 때 실행됩니다	ui-container-closed
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED	속성이 수정될 때 실행됩니다	ui-property-modified
ContextHub.Constants.EVENT_UI_RENDERED	ContextHub UI가 렌더링될 때마다(예: 속성 변경 후) 실행됩니다	ui 렌더링
ContextHub.Constants.EVENT_UI_INITIALIZED	UI 컨테이너가 초기화될 때 실행됩니다	ui 초기화
ContextHub.Constants.ACTIVE_UI_MODE	활성 UI 모드를 나타냅니다	/_/active-ui-mode

ContextHub Javascript API 참조

ContextHub 개체는 모든 저장소에 액세스할 수 있도록 합니다.

함수(ContextHub)

getAllStores()

등록된 모든 ContextHub 저장소를 반환합니다.

이 함수에는 매개 변수가 없습니다.

반환

모든 ContextHub 저장소를 포함하는 객체입니다. 각 저장소는 스토어와 동일한 이름을 사용하는 개체입니다.

예

다음 예제에서는 모든 스토어를 검색한 다음 지리적 위치 스토어를 검색합니다.

var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation;

getStore(name)

저장소를 Javascript 개체로 검색합니다.

매개변수

이름: 스토어가 등록된 이름입니다.

반환

저장소를 나타내는 개체입니다.

예

다음 예제에서는 지리적 위치 저장소를 검색합니다.

var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment

ContextHub 세그먼트를 나타냅니다. ContextHub.SegmentEngine.SegmentManager를 사용하여 세그먼트를 가져옵니다.

함수(ContextHub.ContextEngine.Segment)

getName()

세그먼트 이름을 문자열 값으로 반환합니다.

getPath()

세그먼트 정의의 저장소 경로를 문자열 값으로 반환합니다.

ContextHub.SegmentEngine.SegmentManager

ContextHub 세그먼트에 대한 액세스 권한을 제공합니다.

함수(ContextHub.SegmentEngine.SegmentManager)

getResolvedSegments()

현재 컨텍스트에서 해결된 세그먼트를 반환합니다. 이 함수에는 매개 변수가 없습니다.

반환

ContextHub.SegmentEngine.Segment 개체의 배열입니다.

ContextHub.Store.Core

ContextHub 저장소의 기본 클래스입니다.

속성(ContextHub.Store.Core)

이벤트

A ContextHub.Utils.Eventing 개체. 이벤트를 저장할 함수를 바인딩하는 데 이 개체를 사용합니다. 기본값 및 초기화에 대한 자세한 내용은 init(name,config).

이름

저장소의 이름입니다.

지속성

ContextHub.Utils.Persistence 개체입니다. 기본값 및 초기화에 대한 자세한 내용은 init(name,config).

함수(ContextHub.Store.Core)

addAllItems(tree, options)

데이터 개체 또는 배열을 저장소 데이터와 병합합니다. 개체나 배열에 있는 각 키/값 쌍이 저장소에 추가됩니다( setItem ):

개체: 키는 속성 이름입니다.
배열: 키는 배열 지표입니다.

값은 객체가 될 수 있습니다.

매개변수

트리: (개체 또는 배열) 저장소에 추가할 데이터입니다.
옵션: (개체) setItem 함수에 전달되는 옵션 개체 자세한 내용은 options 매개 변수 setItem(key,value,options).

반환

A boolean 값:

값 true 데이터 개체가 저장되었음을 나타냅니다.
값 false 데이터 저장소가 변경되지 않음을 나타냅니다.

addReference(key, anotherKey)

한 키에서 다른 키로 참조를 만듭니다. 키는 자신을 참조할 수 없습니다.

매개변수

키: 참조하는 키 anotherKey.
다른 키: 이 키는 key.

반환

A boolean 값:

값 true 참조가 추가되었음을 나타냅니다.
값 false 참조가 추가되지 않았음을 나타냅니다.

announceReadiness()

트리거 ready 이 저장소에 대한 이벤트입니다. 이 함수에는 매개 변수가 없으며 값을 반환하지 않습니다.

clean()

저장소에서 모든 데이터를 제거합니다. 함수에는 매개 변수 및 반환 값이 없습니다.

getItem(key)

키와 연결된 값을 반환합니다.

매개변수

키: (문자열) 값을 반환할 키입니다.

반환

키의 값을 나타내는 개체입니다.

getKeys(includeInternals)

저장소에서 키를 검색합니다. 선택적으로 ContextHub 프레임워크에서 내부적으로 사용되는 키를 검색할 수 있습니다.

매개변수

includeInternals: 값 true 결과에 내부적으로 사용되는 키를 포함합니다. 이러한 키는 밑줄("_") 문자로 시작합니다. 기본값은 false입니다.

반환

키 이름의 배열( string 값).

getReferences()

저장소에서 참조를 검색합니다.

반환

참조하는 키를 참조된 키의 인덱스로 사용하는 배열입니다.

참조하는 키는 key 의 매개 변수 addReference 함수 위에 있어야 합니다.
참조된 키는 anotherKey 의 매개 변수 addReference 함수 위에 있어야 합니다.

getTree(includeInternals)

저장소에서 데이터 트리를 검색합니다. 선택적으로 ContextHub 프레임워크에서 내부적으로 사용하는 키/값 쌍을 포함할 수 있습니다.

매개변수

includeInternals: 값 true 결과에 내부적으로 사용된 키/값 쌍을 포함합니다. 이 데이터의 키는 밑줄("_") 문자로 시작합니다. 기본값은 false입니다.

반환

데이터 트리를 나타내는 개체입니다. 키는 개체의 속성 이름입니다.

init(name, config)

저장소를 초기화합니다.

저장소 데이터를 빈 개체로 설정합니다.
저장소 참조를 빈 개체로 설정합니다.
eventChannel 은 데이터입니다.이름, 위치 이름 은 저장소 이름입니다.
storeDataKey는 /store/입니다.이름, 위치 이름 은 저장소 이름입니다.

매개변수

이름: 저장소의 이름입니다.
구성: 구성 속성을 포함하는 객체입니다.
- eventDefer: 기본값은 32입니다.
- 이벤트: 다음 ContextHub.Utils.Eventing 이 저장소에 대한 개체입니다. 기본값은 ContextHub.events 개체가 사용하는 것입니다.
- 지속성: 이 저장소에 대한 ContextHub.Utils.Persistence 개체입니다. 기본값은 ContextHub.persistence 개체입니다.

isEventingPaused()

이 저장소에 대해 이벤트가 일시 중지되었는지 여부를 결정합니다.

반환

부울 값:

true: 이 저장소에 대해 이벤트가 트리거되지 않도록 이벤트가 일시 중지되었습니다.
false: 이벤트가 일시 중지되지 않아 이 저장소에 대해 이벤트가 트리거됩니다.

pauseEventing()

이벤트가 트리거되지 않도록 저장소에 대한 이벤트를 일시 중지합니다. 이 함수에는 매개 변수가 필요하지 않으며 값을 반환하지 않습니다.

removeItem(키, 옵션)

저장소에서 키/값 쌍을 제거합니다.

키가 제거되면 함수는 data 이벤트. 이벤트 데이터에는 저장소 이름, 제거된 키의 이름, 제거된 값, 키에 대한 새 값(null) 및 "제거"의 작업 유형이 포함됩니다.

선택적으로, data 이벤트.

매개변수

키: (문자열) 제거할 키의 이름입니다.
옵션: (객체) 옵션 객체입니다. 다음 개체 속성이 유효합니다.
- 자동: 값 true 는 data 이벤트. 기본값은 false입니다.

반환

A boolean 값:

값 true 키/값 쌍이 제거되었음을 나타냅니다.
값 false 키가 저장소에서 없으므로 데이터 저장소가 변경되지 않음을 나타냅니다.

removeReference(key)

저장소에서 참조를 제거합니다.

매개변수

키: 제거할 키 참조입니다. 이 매개 변수는 key 의 매개 변수 addReference 함수 위에 있어야 합니다.

반환

A boolean 값:

값 true 참조가 제거되었음을 나타냅니다.
값 false 키가 유효하지 않으며 저장소가 변경되지 않음을 나타냅니다.

reset(keepRemainingData)

저장소의 지속된 데이터의 초기 값을 재설정합니다. 선택적으로 저장소에서 다른 모든 데이터를 제거할 수 있습니다. 저장소가 다시 설정되는 동안 이벤트가 이 저장소에 대해 일시 중지되었습니다. 이 함수는 값을 반환하지 않습니다.

초기 값은 저장소 개체를 인스턴스화하는 데 사용되는 구성 개체의 initialValues 속성에 제공됩니다.

매개변수

keepRemainingData: (부울) true 값을 지정하면 비초기 데이터가 유지됩니다. false 값을 지정하면 초기 값을 제외하고 모든 데이터가 제거됩니다.

초기 값은 저장소 개체를 인스턴스화하는 데 사용되는 구성 개체의 initialValues 속성에 제공됩니다.

매개변수

keepRemainingData: (부울) true 값을 지정하면 비초기 데이터가 유지됩니다. false 값을 지정하면 초기 값을 제외하고 모든 데이터가 제거됩니다.

resolveReference(키, 다시 시도)

참조된 키를 검색합니다. 최적 일치 해결을 위해 사용할 반복 횟수를 지정할 수 있습니다(선택적).

매개변수

키: (문자열) 참조를 확인할 키입니다. 이 key 매개 변수는 key 의 매개 변수 addReference 함수 위에 있어야 합니다.
다시 시도: (숫자) 사용할 반복 횟수입니다.

반환

A string 참조된 키를 나타내는 값입니다. 참조가 해결되지 않으면, key 매개 변수가 반환됩니다.

resumeEventing()

이벤트가 트리거되도록 이 저장소에 대한 이벤트를 다시 시작합니다. 이 함수는 매개 변수를 정의하지 않으며 값을 반환하지 않습니다.

setItem(키, 값, 옵션)

키/값 쌍을 저장소에 추가합니다.

트리거 data 이벤트에 대한 값은 키에 현재 저장된 값과 다른 경우에만 발생합니다. 선택적으로 data 이벤트.

이벤트 데이터에는 저장소 이름, 키, 이전 값, 새 값 및 작업 유형이 포함됩니다 set.

매개변수

키: (문자열) 키의 이름입니다.
옵션: (객체) 옵션 객체입니다. 다음 개체 속성이 유효합니다.
- 자동: 값 true 는 data 이벤트. 기본값은 false입니다.
값: (개체) 키와 연결할 값입니다.

반환

A boolean 값:

값 true 데이터 개체가 저장되었음을 나타냅니다.
값 false 데이터 저장소가 변경되지 않음을 나타냅니다.

ContextHub.Store.JSONPStore

JSON 데이터를 포함하는 스토어. 데이터는 외부 JSONP 서비스에서 검색되거나, 선택적으로 JSON 데이터를 반환하는 서비스에서 검색됩니다. 를 사용하여 서비스 세부 사항을 지정합니다. init 이 클래스의 인스턴스를 만들 때 사용됩니다.

저장소는 메모리 내 지속성을 사용합니다(Javascript 변수). 데이터 저장 은 페이지 수명 동안에만 사용할 수 있습니다.

ContextHub.Store.JSONPStore가 확장됩니다 ContextHub.Store.Core 및 은 해당 클래스의 함수를 상속합니다.

함수(ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

이 개체가 사용하는 JSONP 서비스에 연결하는 세부 정보를 구성합니다. 기존 구성을 업데이트하거나 바꿀 수 있습니다. 함수는 값을 반환하지 않습니다.

매개변수

serviceConfig: 다음 속성을 포함하는 객체입니다.
- 호스트: (문자열) 서버 이름 또는 IP 주소입니다.
- jsonp: (부울) true 값을 지정하면 서비스가 JSONP 서비스임을 나타내고, 그렇지 않으면 false를 나타냅니다. true인 경우 {callback: "ContextHub.Callback.Object.name} 개체가 service.params 개체에 추가됩니다.
- 매개 변수: (개체) 개체 속성으로 표시되는 URL 매개 변수입니다. 매개 변수 이름은 속성 이름이고 매개 변수 값은 속성 값입니다.
- 경로: (문자열) 서비스의 경로입니다.
- 포트: (번호) 서비스의 포트 번호입니다.
- 보안: (문자열 또는 부울) 서비스 URL에 사용할 프로토콜을 결정합니다.
  - auto: //
  - true: https://
  - false: https://
재정의: (부울). 값 true 기존 서비스 구성이 serviceConfig. 값 false 기존 서비스 구성 속성이 serviceConfig.

getRawResponse()

JSONP 서비스에 대한 마지막 호출 이후 캐시된 원시 응답을 반환합니다. 함수에는 매개 변수가 필요하지 않습니다.

반환

원시 응답을 나타내는 객체입니다.

getServiceDetails()

이 ContextHub.Store.JSONPStore 개체의 서비스 개체를 검색합니다. 서비스 개체에는 서비스 URL을 만드는 데 필요한 모든 정보가 들어 있습니다.

반환

다음 속성을 갖는 객체:

호스트: (문자열) 서버 이름 또는 IP 주소입니다.
jsonp: (부울) true 값을 지정하면 서비스가 JSONP 서비스임을 나타내고, 그렇지 않으면 false를 나타냅니다. true인 경우 {callback: "ContextHub.Callback.Object.name} 개체가 service.params 개체에 추가됩니다.
매개 변수: (개체) 개체 속성으로 표시되는 URL 매개 변수입니다. 매개 변수 이름은 속성 이름이고 매개 변수 값은 속성 값입니다.
경로: (문자열) 서비스의 경로입니다.
포트: (번호) 서비스의 포트 번호입니다.
보안: (문자열 또는 부울) 서비스 URL에 사용할 프로토콜을 결정합니다.
- auto: //
- true: https://
- false: https://

getServiceURL(resolve)

JSONP 서비스의 URL을 검색합니다.

매개변수

해결: (부울) URL에 확인된 매개 변수를 포함할지 여부를 결정합니다. 값 true 매개 변수 확인 및 false 그렇지 않습니다.

반환

A string 서비스 URL을 나타내는 값입니다.

init(name, config)

contextHub.Store.JSONPStore 개체를 초기화합니다.

매개변수

이름: (문자열) 저장소의 이름입니다.
구성: (객체) 서비스 속성을 포함하는 객체입니다. JSONPStore 개체는 service jsonp 서비스의 URL을 구성하는 개체:
- eventDefer: 32.
- 이벤트: 이 저장소에 대한 ContextHub.Utils.Eventing 개체입니다. 기본값은 입니다. ContextHub.eventing 개체.
- 지속성: 이 저장소에 대한 ContextHub.Utils.Persistence 개체입니다. 기본적으로 메모리 지속성이 사용됩니다(Javascript 개체).
- 서비스: (개체)
  - 호스트: (문자열) 서버 이름 또는 IP 주소입니다.
  - jsonp: (부울) true 값을 지정하면 서비스가 JSONP 서비스임을 나타내고, 그렇지 않으면 false를 나타냅니다. true면 {callback: "ContextHub.Callbacks.*Object.name*}개체가에 추가됩니다. service.params.
  - 매개 변수: (개체) 개체 속성으로 표시되는 URL 매개 변수입니다. 매개 변수 이름 및 값은 각각 개체 속성 이름 및 값입니다.
  - 경로: (문자열) 서비스의 경로입니다.
  - 포트: (번호) 서비스의 포트 번호입니다.
  - 보안: (문자열 또는 부울) 서비스 URL에 사용할 프로토콜을 결정합니다.
    - auto: //
    - true: https://
    - false: https://
  - timeout: (숫자) 시간 초과 전에 JSONP 서비스가 응답할 때까지 기다리는 시간(밀리초)입니다.
  - ttl: JSONP 서비스로 호출 사이에 경과되는 최소 시간(밀리초)입니다. (자세한 내용은 queryService 함수 위에 있어야 합니다.

queryService(다시 로드)

원격 JSONP 서비스를 쿼리하고 응답을 캐시합니다. 이 함수에 대한 이전 호출 이후의 시간이 config.service.ttl인 경우 서비스가 호출되지 않고, 캐시된 응답이 변경되지 않습니다. 원할 경우 서비스를 강제로 호출할 수 있습니다. 다음 config.service.ttl속성은 init 함수를 사용하여 저장소를 초기화합니다.

쿼리가 완료되면 준비 이벤트를 트리거합니다. JSONP 서비스 URL이 설정되지 않은 경우 함수는 아무 작업도 하지 않습니다.

매개변수

다시 로드: (부울) true 값을 지정하면 캐시된 응답을 제거하고 JSONP 서비스를 호출하게 합니다.

재설정

저장소의 지속된 데이터의 초기 값을 재설정한 다음 JSONP 서비스를 호출합니다. 선택적으로 저장소에서 다른 모든 데이터를 제거할 수 있습니다. 초기 값이 재설정되는 동안 이벤트가 이 저장소에 대해 일시 중지되었습니다. 이 함수는 값을 반환하지 않습니다.

초기 값은 저장소 개체를 인스턴스화하는 데 사용되는 구성 개체의 initialValues 속성에 제공됩니다.

매개변수

keepRemainingData: (부울) true 값을 지정하면 비초기 데이터가 유지됩니다. false 값을 지정하면 초기 값을 제외하고 모든 데이터가 제거됩니다.

resolveParameter(f)

지정된 매개 변수를 확인합니다.

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistentJSONPStore가 확장됩니다 ContextHub.Store.JSONPStore 따라서 해당 클래스의 모든 함수를 상속합니다. 그러나 JSONP 서비스에서 검색한 데이터는 ContextHub 지속성 구성에 따라 유지됩니다. (자세한 내용은 지속성 모드)

ContextHub.Store.PersistedStore

ContextHub.Store.PersistentStore가 확장됩니다 ContextHub.Store.Core 따라서 해당 클래스의 모든 함수를 상속합니다. 이 저장소의 데이터는 ContextHub 지속성 구성에 따라 유지됩니다.

ContextHub.Store.SessionStore

ContextHub.Store.SessionStore가 확장됩니다 ContextHub.Store.Core 따라서 해당 클래스의 모든 함수를 상속합니다. 이 저장소의 데이터는 메모리 내 지속성(Javascript 개체)을 사용하여 유지됩니다.

ContextHub.UI

UI 모듈 및 UI 모듈 렌더러를 관리합니다.

함수(ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

ContextHub에 UI 모듈 렌더러를 등록합니다. 렌더러를 등록하면 다음 작업을 수행할 수 있습니다 UI 모듈 만들기. 가능하면 이 함수를 사용하십시오 extending ContextHub.UI.BaseModuleRenderer 사용자 지정 UI 모듈 렌더러를 만들려면

매개변수

moduleType: (문자열) UI 모듈 렌더러에 대한 식별자입니다. 지정한 값을 사용하여 렌더러를 이미 등록한 경우에는 이 렌더러가 등록되기 전에 기존 렌더러가 등록되지 않습니다.
렌더러: (문자열) UI 모듈을 렌더링하는 클래스의 이름입니다.
dontRender: (부울) 를 로 설정합니다. true 렌더러를 등록한 후 ContextHub UI가 렌더링되지 않도록 하려면 다음을 수행하십시오. 기본값은 false입니다.

예

다음 예제에서는 렌더러를 contexthub.browserinfo 모듈 유형으로 등록합니다.

ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

쿠키와 상호 작용하는 유틸리티 클래스입니다.

exists(key)

쿠키가 있는지 여부를 결정합니다.

매개변수

키: A String 에는 테스트 중인 쿠키의 키가 포함되어 있습니다.

반환

A boolean true 값은 쿠키가 존재함을 나타냅니다.

예

if (ContextHub.Utils.Cookie.exists("name")) {
   // conditionally-executed code
}

getAllItems(필터)

필터와 일치하는 키가 있는 모든 쿠키를 반환합니다.

매개변수

(선택 사항) 필터: 쿠키 키 일치 기준. 모든 쿠키를 반환하려면 값을 지정하지 않습니다. 지원되는 유형은 다음과 같습니다.
- 문자열: 문자열은 쿠키 키와 비교됩니다.
- 배열: 배열의 각 항목은 필터입니다.
- RegExp 개체: 개체의 테스트 함수를 사용하여 쿠키 키를 일치시킵니다.
- 함수 호출: 일치에 대한 쿠키 키를 테스트하는 함수입니다. 함수는 쿠키 키를 매개 변수로 사용하고 테스트가 일치를 확인하면 true를 반환해야 합니다.

반환

쿠키의 개체. 개체 속성은 쿠키 키이고 키 값은 쿠키 값입니다.

예

ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])

getItem(key)

쿠키 값을 반환합니다.

매개변수

키: 값에 사용할 쿠키의 키입니다.

반환

쿠키 값 또는 null 키에 대한 쿠키가 없는 경우.

예

ContextHub.Utils.Cookie.getItem("name");

getKeys(filter)

필터와 일치하는 기존 쿠키의 배열을 반환합니다.

매개변수

필터: 쿠키 키 일치 기준. 지원되는 유형은 다음과 같습니다.
- 문자열: 문자열은 쿠키 키와 비교됩니다.
- 배열: 배열의 각 항목은 필터입니다.
- RegExp 개체: 개체의 테스트 함수를 사용하여 쿠키 키를 일치시킵니다.
- 함수 호출: 일치에 대한 쿠키 키를 테스트하는 함수입니다. 함수는 쿠키 키를 매개 변수로 가져와 반환해야 합니다 true 테스트가 일치를 확인하는 경우

반환

각 문자열이 필터와 일치하는 쿠키의 키인 문자열의 배열입니다.

예

ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])

removeItem(키, 옵션)

쿠키를 제거합니다. 쿠키를 제거하려면 값이 이메일 문자열로 설정되고 만료 날짜가 현재 날짜 이전 날짜로 설정됩니다.

매개변수

키: A String 제거할 쿠키의 키를 나타내는 값입니다.
옵션: 쿠키 속성을 구성하기 위한 속성 값을 포함하는 객체입니다. 자세한 내용은 [setItem](/docs/experience-manager-64/developing/personlization/contexthub-api.html?lang=ko#setitem-key-value-options) 함수 내에 있어야 합니다. 다음 expires 속성은 영향을 주지 않습니다.

반환

이 함수는 값을 반환하지 않습니다.

예

ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);

setItem(키, 값, 옵션)

주어진 키와 값의 쿠키를 만들고 현재 문서에 쿠키를 추가합니다. 선택적으로, 쿠키의 속성을 구성하는 옵션을 지정할 수 있습니다.

매개변수

키: 쿠키의 키를 포함하는 문자열입니다.
값: 쿠키 값을 포함하는 문자열입니다.
옵션: (선택 사항) 쿠키 속성을 구성하는 다음 속성 중 하나를 포함하는 객체입니다.
- 만료: A date 또는 number 쿠키가 만료되는 시기를 지정하는 값입니다. 날짜 값은 만료 절대 시간을 지정합니다. 숫자(일 단위)는 만료 시간을 현재 시간과 숫자를 더한 값으로 설정합니다. 기본값은 undefined입니다.
- 보안: A boolean 를 지정하는 값 Secure 쿠키의 속성입니다. 기본값은 false입니다.
- 경로: A String 값으로 사용할 값 Path 쿠키의 속성입니다. 기본값은 undefined입니다.

반환

설정된 값이 있는 쿠키입니다.

예

ContextHub.Utils.Cookie.setItem("name", "mycookie", {
    expires: 3,
    domain: 'localhost',
    path: '/some/directory',
    secure: true
});

주어진 필터와 일치하는 모든 쿠키를 제거합니다. 쿠키는 getKeys 함수를 사용하여 일치하고 removeItem 함수를 사용하여 제거됩니다.

매개변수

필터: 다음 filter 호출에 사용할 인수 [getKeys](/docs/experience-manager-64/developing/personlization/contexthub-api.md#getkeys-filter) 함수 위에 있어야 합니다.
옵션: 다음 options 호출에 사용할 인수 [removeItem](/docs/experience-manager-64/developing/personlization/contexthub-api.md#removeitem-key-options) 함수 위에 있어야 합니다.

반환

이 함수는 값을 반환하지 않습니다.

ContextHub.Utils.Eventing

ContextHub 저장소 이벤트에 함수를 바인딩하고 바인딩 해제할 수 있습니다. 를 사용하여 저장소의 ContextHub.Utils.Eventing 개체에 액세스합니다 이벤트 저장소의 속성입니다.

함수(ContextHub.Utils.Eventing)

off(name, selector)

이벤트에서 함수를 바인딩하지 않습니다.

매개변수

이름: 다음 이벤트 이름 함수에 대한 바인딩을 해제합니다.
선택기: 바인딩을 식별하는 선택기입니다. (자세한 내용은 selector 매개 변수 on 및 한 번 함수 위에 있어야 합니다.

반환

이 함수는 값을 반환하지 않습니다.

on(name, handler, selector, triggerForPastEvents)

함수를 이벤트에 바인딩합니다. 함수는 이벤트가 발생할 때마다 호출됩니다. 선택적으로, 바인딩이 설정되기 전에 이전에 발생한 이벤트에 대해 함수를 호출할 수 있습니다.

매개변수

이름: (문자열) 이벤트 이름 함수에 바인딩하는 위치입니다.
핸들러: (함수) 이벤트에 바인딩할 함수입니다.
선택기: (문자열) 바인딩의 고유 식별자입니다. 를 사용하려는 경우 선택기를 사용하여 바인딩을 확인해야 합니다 off 바인딩을 제거하는 함수입니다.
triggerForPastEvents: (부울) 과거에 발생한 이벤트에 대해 핸들러를 실행할지 여부를 나타냅니다. 값 true 는 과거 이벤트에 대한 처리기를 호출합니다. 값 false 은 향후 이벤트를 위한 핸더를 호출합니다. 기본값은 true입니다.

반환

이 triggerForPastEvents 인수가 true로 지정하는 경우 이 함수는 boolean 과거 이벤트가 발생했는지 여부를 나타내는 값입니다.

true: 이전에 이벤트가 발생했으므로 처리기가 호출됩니다.
false: 이 이벤트는 과거에 발생하지 않았습니다.

If triggerForPastEvents is false로 설정되면 이 함수는 값을 반환하지 않습니다.

예

다음 예제에서는 함수를 지리적 위치 저장소의 데이터 이벤트에 바인딩합니다. 함수는 페이지의 요소를 저장소의 위도 데이터 항목에 대한 값으로 채웁니다.

<div class="location">
    <p>latitude: <span id="lat"></span></p>
</div>

<script>
    var geostore = ContextHub.getStore("geolocation");
    geostore.eventing.on(ContextHub.Constants.EVENT_DATA_UPDATE,getlat,"getlat");

    function getlat(){
       latitude = geostore.getItem("latitude");
       $("#lat").html(latitude);
    }
</script>

once(name, handler, selector, triggerForPastEvents)

함수를 이벤트에 바인딩합니다. 함수는 이벤트의 첫 번째 발생 시 한 번만 호출됩니다. 선택적으로, 바인딩이 설정되기 전에 이전에 발생한 이벤트에 대해 함수를 호출할 수 있습니다.

매개변수

이름: (문자열) 이벤트 이름 함수에 바인딩하는 위치입니다.
핸들러: (함수) 이벤트에 바인딩할 함수입니다.
선택기: (문자열) 바인딩의 고유 식별자입니다. 를 사용하려는 경우 선택기를 사용하여 바인딩을 확인해야 합니다 off 바인딩을 제거하는 함수입니다.
triggerForPastEvents: (부울) 과거에 발생한 이벤트에 대해 핸들러를 실행할지 여부를 나타냅니다. 값 true 는 과거 이벤트에 대한 처리기를 호출합니다. 값 false 은 향후 이벤트를 위한 핸더를 호출합니다. 기본값은 true입니다.

반환

이 triggerForPastEvents 인수가 true로 지정하는 경우 이 함수는 boolean 과거 이벤트가 발생했는지 여부를 나타내는 값입니다.

true: 이전에 이벤트가 발생했으므로 처리기가 호출됩니다.
false: 이 이벤트는 과거에 발생하지 않았습니다.

If triggerForPastEvents is false로 설정되면 이 함수는 값을 반환하지 않습니다.

ContextHub.Utils.inheritance

개체가 다른 개체의 속성과 메서드를 상속할 수 있도록 하는 유틸리티 클래스입니다.

함수(ContextHub.Utils.inheritance)

inherit(child, parent)

개체가 다른 개체의 속성과 메서드를 상속하도록 합니다.

매개변수

하위: (객체) 상속되는 객체입니다.
상위: (객체) 상속되는 속성과 메서드를 정의하는 객체입니다.

ContextHub.Utils.JSON

개체를 JSON 형식으로 직렬화하고 JSON 문자열을 객체로 deserialize하는 함수를 제공합니다.

함수(ContextHub.Utils.JSON)

parse(data)

문자열 값을 JSON으로 구문 분석하여 Javascript 개체로 변환합니다.

매개변수

데이터: JSON 형식의 문자열 값입니다.

반환

Javascript 개체.

예

코드 ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); 는 다음 개체를 반환합니다.

Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(data)

Javascript 값 및 개체를 JSON 형식의 문자열 값으로 serialize합니다.

매개변수

데이터: serialize할 값 또는 개체입니다. 이 함수는 부울, 배열, 숫자, 문자열 및 날짜 값을 지원합니다.

반환

직렬화된 문자열 값입니다. When data 은 R입니다 egExp 값을 지정하면 이 함수는 빈 개체를 반환합니다. When data 는 함수입니다. undefined.

예

다음 코드는 를 반환합니다 "{'city':'Basel','country':'Switzerland','population':'173330'}":

ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

ContextHub.Utils.JSON.tree

이 클래스를 사용하면 ContextHub 저장소에서 저장되거나 검색할 데이터 개체를 쉽게 조작할 수 있습니다.

함수(ContextHub.Utils.JSON.tree)

addAllItems()

데이터 개체의 복사본을 만들고 두 번째 개체의 데이터 트리에 추가합니다. 함수는 복사본을 반환하고 원본 개체 중 하나를 수정하지 않습니다. 두 개체의 데이터 트리에 동일한 키가 들어 있으면 두 번째 개체의 값이 첫 번째 개체의 값을 덮어씁니다.

매개변수

트리: 복사된 객체입니다.
secondTree: 개체의 복사본과 병합되는 개체 tree 개체.

반환

병합된 데이터가 포함된 객체입니다.

cleanup()

개체의 복사본을 만들고, 데이터 트리에서 값, null 값 또는 정의되지 않은 값이 들어 있지 않은 항목을 찾아 제거하고 복사본을 반환합니다.

매개변수

트리: 정리할 개체입니다.

반환

정리된 트리 사본.

getItem()

키에 대한 개체에서 값을 검색합니다.

매개변수

트리: 데이터 개체.
키: 검색할 값의 키입니다.

반환

키와 일치하는 값입니다. 키에 자식 키가 있으면 이 함수는 복잡한 개체를 반환합니다. 키의 값 유형이 undefined, null 가 반환됩니다.

예

다음 Javascript 개체를 고려하십시오.

myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

다음 예제 코드는 값을 반환합니다 260:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

다음 예제 코드는 하위 키가 있는 키의 값을 검색합니다.

ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

함수는 다음 개체를 반환합니다.

Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys()

개체의 데이터 트리에서 모든 키를 검색합니다. 선택적으로 특정 키의 하위 키만 검색할 수 있습니다. 검색된 키의 정렬 순서를 선택적으로 지정할 수도 있습니다.

매개변수

트리: 데이터 트리의 키를 검색할 객체입니다.
상위: (선택 사항) 하위 항목의 키를 검색할 데이터 트리의 항목 키입니다.
주문: (선택 사항) 반환된 키의 정렬 순서를 결정하는 함수입니다. (자세한 내용은 Array.prototype.sort ( Mozilla Developer Network)에서 생성합니다.

반환

키 배열입니다.

예

다음 개체를 고려해 보십시오.

myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

다음 ContextHub.Utils.JSON.tree.getKeys(myObject); 스크립트는 다음 배열을 반환합니다.

["/location", "/location/city", "/location/country", "/location/latitude", "/location/longitude", "/location/weather", "/location/weather/humidity", "/location/weather/precipitation", "/location/weather/temperature", "/location/weather/wind"]

removeItem()

지정된 객체의 복사본을 만들고 데이터 트리에서 지정된 분기를 제거하고 수정된 복사본을 반환합니다.

매개변수

트리: 데이터 개체.
키: 제거할 키입니다.

반환

키가 제거된 원본 데이터 개체의 사본입니다.

예

다음 개체를 고려해 보십시오.

myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

다음 예제 스크립트는 데이터 트리에서 /one/2/3/4 분기를 제거합니다.

myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

함수는 다음 개체를 반환합니다.

myObject {
  one: {
    foo: "bar"
  }
}

decrizeKey(key)

문자열 값을 정리하여 키로 사용할 수 있도록 합니다. 문자열을 정리하려면 다음 작업을 수행합니다.

연속된 여러 슬래시를 단일 슬래시로 줄입니다.
문자열의 시작 및 끝에서 공백을 제거합니다.
결과를 슬래시로 구분된 문자열 배열로 분할합니다.

결과 배열을 사용하여 사용 가능한 키를 만듭니다. 매개변수

키: 다음 string 세정처리

반환

일련의 string 각 문자열이 의 부분인 값 key 그것은 슬래시로 표시되었다. 정리된 키를 나타냅니다. 정리된 배열의 길이가 0인 경우 이 함수는 를 반환합니다 null.

예

다음 코드는 문자열을 정리하여 배열을 생성합니다 ["this", "is", "a", "path"], 그런 다음 키를 생성합니다 "/this/is/a/path" 스토리지 시스템:

var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(tree, key, value)

객체 사본의 데이터 트리에 키/값 쌍을 추가합니다. 데이터 트리에 대한 자세한 내용은 지속성.

매개변수

트리: 데이터 개체.
키: 추가할 값과 연결할 키입니다. 키는 데이터 트리에 있는 항목의 경로입니다. 이 함수 호출 ContextHub.Utils.JSON.tree.sanitize 를 추가하여 키를 가릴 수 있습니다.
값: 데이터 트리에 추가할 값입니다.

반환

의 사본 tree 를 포함하는 개체 key/ value 한 개.

예

다음 Javascript 코드를 고려하십시오.

var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

var myKey = "/user/location/details";

var myValue = {
      population: 173330,
      elevation: 260
     };

myObject = ContextHub.Utils.JSON.tree.setItem(myObject, myKey, myValue);

myObject 개체에는 다음 값이 있습니다.

ContextHub.Utils.storeCandidates

저장소 후보를 등록하고 등록된 저장소 후보자를 가져올 수 있습니다.

함수(ContextHub.Utils.store후보자)

getRegisteredCompanies(storeType)

저장소 후보로 등록된 저장소 유형을 반환합니다. 특정 저장소 유형 또는 모든 저장소 유형의 등록된 캔버스를 검색합니다.

매개변수

storeType: (문자열) 저장소 유형의 이름입니다. 자세한 내용은 storeType 의 매개 변수 ContextHub.Utils.storeCandidates.registerStoreCandidate 함수 위에 있어야 합니다.

반환

저장소 유형의 개체입니다. 객체 등록 정보는 저장소 유형 이름이고 등록 정보 값은 등록된 저장소 후보의 배열입니다.

getStoreFromCandiers(storeType)

등록된 후보로부터 저장소 유형을 반환합니다. 동일한 이름의 저장소 유형이 둘 이상 등록되면 함수는 우선 순위가 가장 높은 저장소 유형을 반환합니다.

매개변수

storeType: (문자열) 저장소 후보의 이름입니다. 자세한 내용은 storeType 의 매개 변수 ContextHub.Utils.storeCandidates.registerStoreCandidate 함수 위에 있어야 합니다.

반환

등록된 저장소 후보자를 나타내는 개체입니다. 요청한 저장소 유형이 등록되지 않은 경우 오류가 발생합니다.

getSupportedStoreTypes()

저장소 후보로 등록된 저장소 유형의 이름을 반환합니다. 이 함수에는 매개 변수가 필요하지 않습니다.

반환

각 문자열이 저장소 후보가 등록된 저장소 유형인 문자열 값의 배열입니다. 자세한 내용은 storeType 의 매개 변수 ContextHub.Utils.storeCandidates.registerStoreCandidate 함수 위에 있어야 합니다.

registerStoreCandidate(store, storeType, priority, apply)

이름과 우선 순위를 사용하여 저장소 개체를 저장소 후보로 등록합니다.

우선 순위는 같은 이름의 점포의 중요성을 나타내는 숫자입니다. 이미 등록된 상점 후보자와 같은 이름을 사용하여 상인등록을 하면 우선순위가 높은 후보가 사용된다. 상인등록을 할 때 상인은 같은 이름 등록된 상인보다 우선순위가 높은 경우에만 등록된다.

매개변수

저장: (개체) 저장소 후보로 등록할 저장소 개체입니다.
storeType: (문자열) 저장소 후보의 이름입니다. 이 값은 저장소 후보의 인스턴스를 만들 때 필요합니다.
우선 순위: (숫자) 상점 후보자의 우선순위.
적용: (함수) 현재 환경에서 저장소의 적용 가능성을 평가하는 를 호출하는 함수입니다. 함수는 true 스토어가 적용 가능한 경우 false 그렇지 않은 경우 기본값은 true를 반환하는 함수입니다. function() {return true;}

예

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);

Business.Adobe.com 리소스

Multichannel Communication Content Insights Responsive Forms Version History Customer Experience Management Digital Rights Management

ContextHub Javascript API 참조

ContextHub 상수

이벤트 상수

UI 이벤트 상수

ContextHub Javascript API 참조

함수(ContextHub)

getAllStores()

getStore(name)

ContextHub.SegmentEngine.Segment

함수(ContextHub.ContextEngine.Segment)

getName()

getPath()

ContextHub.SegmentEngine.SegmentManager

함수(ContextHub.SegmentEngine.SegmentManager)

getResolvedSegments()

ContextHub.Store.Core

속성(ContextHub.Store.Core)

이벤트

이름

지속성

함수(ContextHub.Store.Core)

addAllItems(tree, options)

addReference(key, anotherKey)

announceReadiness()

clean()

getItem(key)

getKeys(includeInternals)

getReferences()

getTree(includeInternals)

init(name, config)

isEventingPaused()

pauseEventing()

removeItem(키, 옵션)

removeReference(key)

reset(keepRemainingData)

resolveReference(키, 다시 시도)

resumeEventing()

setItem(키, 값, 옵션)

ContextHub.Store.JSONPStore

함수(ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

getRawResponse()

getServiceDetails()

getServiceURL(resolve)

init(name, config)

queryService(다시 로드)

재설정

resolveParameter(f)

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedStore

ContextHub.Store.SessionStore

ContextHub.UI

함수(ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

ContextHub.Utils.Cookie

함수(ContextHub.Utils.Cookie)

exists(key)

getAllItems(필터)

getItem(key)

getKeys(filter)

removeItem(키, 옵션)

setItem(키, 값, 옵션)

destroy(filter, options)

ContextHub.Utils.Eventing

함수(ContextHub.Utils.Eventing)

off(name, selector)

on(name, handler, selector, triggerForPastEvents)

once(name, handler, selector, triggerForPastEvents)

ContextHub.Utils.inheritance

함수(ContextHub.Utils.inheritance)

inherit(child, parent)

ContextHub.Utils.JSON

함수(ContextHub.Utils.JSON)

parse(data)

stringify(data)

ContextHub.Utils.JSON.tree

함수(ContextHub.Utils.JSON.tree)

addAllItems()

cleanup()

getItem()