ContextHub JavaScript API 참조

마지막 업데이트: 2025년 2월 6일

주제:
개발
개인화

작성 대상:

관리자
개발자

ContextHub 구성 요소를 페이지에 추가하면 스크립트에서 ContextHub JavaScript API를 사용할 수 있습니다.

ContextHub 상수

ContextHub JavaScript API에서 정의하는 상수 값입니다.

이벤트 상수

다음 표에는 ContextHub 저장소에서 발생하는 이벤트의 이름이 나열되어 있습니다. ContextHub.Utils.Eventing도 참조하세요.

상수	설명	값
`ContextHub.Constants.EVENT_NAMESPACE`	ContextHub의 이벤트 네임스페이스	`ch`
`ContextHub.Constants.EVENT_ALL_STORES_READY`	필요한 모든 저장소가 등록되고 초기화되어 사용할 준비가 되었음을 나타냅니다.	`all-stores-ready`
`ContextHub.Constants.EVENT_STORES_PARTIALLY_READY`	지정된 시간 제한 내에 모든 저장소가 초기화되지 않았음을 나타냅니다.	`stores-partially-ready`
`ContextHub.Constants.EVENT_STORE_REGISTERED`	스토어가 등록되면 실행됨	`store-registered`
`ContextHub.Constants.EVENT_STORE_READY`	스토어가 작동할 준비가 되었음을 나타냅니다. JSONP 스토어를 제외하고 등록 직후 트리거되며 데이터를 가져올 때 실행됩니다.	`store-ready`
`ContextHub.Constants.EVENT_STORE_UPDATED`	스토어가 지속성을 업데이트할 때 실행됨	`store-updated`
`ContextHub.Constants.PERSISTENCE_CONTAINER_NAME`	지속성 컨테이너 이름	`ContextHubPersistence`
`ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY`	원시 JSON 결과가 저장되는 특정 지속성 키 이름을 저장합니다.	`/_/raw-response`
`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-mode-registered`
`ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED`	모드가 등록 취소되면 실행됩니다.	`ui-mode-unregistered`
`ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED`	모드 렌더러가 등록되면 실행됩니다.	`ui-mode-renderer-registered`
`ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED`	모드 렌더러가 등록 취소되면 실행됩니다.	`ui-mode-renderer-unregistered`
`ContextHub.Constants.EVENT_UI_MODE_ADDED`	새 모드가 추가되면 실행됩니다.	`ui-mode-added`
`ContextHub.Constants.EVENT_UI_MODE_REMOVED`	모드가 제거되면 실행됩니다.	`ui-mode-removed`
`ContextHub.Constants.EVENT_UI_MODE_SELECTED`	사용자가 모드를 선택하면 실행됩니다.	`ui-mode-selected`
`ContextHub.Constants.EVENT_UI_MODULE_REGISTERED`	새 모듈이 등록되면 실행됩니다.	`ui-module-registered`
`ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED`	모듈이 등록 취소되면 실행됩니다.	`ui-module-unregistered`
`ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED`	모듈 렌더러가 등록되면 실행됩니다.	`ui-module-renderer-registered`
`ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED`	모듈 렌더러가 등록 취소될 때 실행됨	`ui-module-renderer-unregistered`
`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-rendered`
`ContextHub.Constants.EVENT_UI_INITIALIZED`	UI 컨테이너가 초기화되면 실행됩니다.	`ui-initialized`
`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 개체로 검색합니다.

매개변수

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

반환

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

예

다음 예제에서는 geolocation 스토어를 검색합니다.

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)

이벤트

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

이름

스토어의 이름입니다.

지속성

ContextHub.Utils.Persistence 개체입니다. 기본값 및 초기화에 대한 자세한 내용은 init(name,config)을(를) 참조하십시오.

함수(ContextHub.Store.Core)

addAllItems(tree, options)

데이터 개체 또는 배열을 저장소 데이터와 병합합니다. 개체 또는 배열의 각 키/값 쌍은 setItem 함수를 통해 저장소에 추가됩니다.

개체: 키는 속성 이름입니다.
배열: 키는 배열 인덱스입니다.

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

매개변수

tree:(개체 또는 배열) 저장소에 추가할 데이터입니다.
options:(개체) setItem 함수에 전달되는 옵션 개체. 자세한 내용은 setItem(key,value,options)의 options 매개 변수를 참조하십시오.

반환

boolean 값:

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

addReference(key, anotherKey)

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

매개변수

key: anotherKey을(를) 참조하는 키입니다.
anotherkey: key에서 참조하는 키입니다.

반환

boolean 값:

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

announceReadiness()

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

clean()

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

getItem(key)

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

매개변수

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

반환

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

getKeys(includeInternals)

스토어에서 키를 검색합니다. 필요한 경우 ContextHub 프레임워크에서 내부적으로 사용되는 키를 검색할 수 있습니다.

매개변수

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

반환

키 이름의 배열입니다(string 값).

getReferences()

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

반환

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

참조 키는 addReference 함수의 key 매개 변수와 일치합니다.
참조된 키는 addReference 함수의 anotherKey 매개 변수에 해당합니다.

getTree(includeInternal)

스토어에서 데이터 트리를 검색합니다. 필요한 경우 ContextHub 프레임워크에서 내부적으로 사용하는 키/값 쌍을 포함할 수 있습니다.

매개변수

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

반환

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

init(name, config)

저장소를 초기화합니다.

저장소 데이터를 빈 개체로 설정합니다.
저장소 참조를 빈 개체로 설정합니다.
eventChannel은(는) data:<name>입니다. 여기서 <name>은(는) 저장소 이름입니다.
storeDataKey은(는) /store/<name>입니다. 여기서 <name>은(는) 저장소 이름입니다.

매개변수

name: 저장소의 이름입니다.
config: 구성 속성이 포함된 개체:
- eventDeferring: 기본값은 32입니다.
- eventing: 이 저장소에 대한 ContextHub.Utils.Eventing 개체입니다. 기본값은 ContextHub.eventing 개체가 사용하는 것입니다.
- persistence: 이 저장소의 ContextHub.Utils.Persistence 개체입니다. 기본값은 ContextHub.persistence 개체입니다.

isEventingPaused()

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

반환

부울 값:

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

pauseEventing()

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

removeItem(key, options)

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

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

선택적으로 data 이벤트가 트리거되는 것을 방지할 수 있습니다.

매개변수

key:(문자열) 제거할 키의 이름입니다.
options:(개체) 옵션의 개체입니다. 다음 개체 속성이 유효합니다.
- silent: true 값은 data 이벤트를 트리거하지 못하도록 합니다. 기본값은 false입니다.

반환

boolean 값:

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

removeReference(key)

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

매개변수

key: 제거할 키 참조입니다. 이 매개 변수는 addReference 함수의 key 매개 변수에 해당합니다.

반환

boolean 값:

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

reset(keepRemainingData)

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

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

매개변수

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

resolveReference(key, retry)

참조된 키를 검색합니다. 선택적으로 최상의 일치 문제를 해결하는 데 사용할 반복 횟수를 지정할 수 있습니다.

매개변수

key:(문자열) 참조를 확인할 키입니다. 이 key 매개 변수는 addReference 함수의 key 매개 변수와 일치합니다.
retry:(숫자) 사용할 반복 횟수입니다.

반환

참조된 키를 나타내는 string 값입니다. 참조가 확인되지 않으면 key 매개 변수의 값이 반환됩니다.

resumeEventing()

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

setItem(키, 값, 옵션)

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

키 값이 현재 키에 저장된 값과 다른 경우에만 data 이벤트를 트리거합니다. 선택적으로 data 이벤트가 트리거되는 것을 방지할 수 있습니다.

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

매개변수

key:(문자열) 키 이름입니다.
options:(개체) 옵션의 개체입니다. 다음 개체 속성이 유효합니다.
- silent: true 값을 사용하면 data 이벤트가 트리거되지 않습니다. 기본값은 false입니다.
value:(개체) 키와 연결할 값입니다.

반환

boolean 값:

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

ContextHub.Store.JSONPStore

JSON 데이터가 포함된 저장소입니다. 데이터는 외부 JSONP 서비스 또는 JSON 데이터를 반환하는 서비스에서 검색됩니다. 이 클래스의 인스턴스를 만들 때 init 함수를 사용하여 서비스 세부 정보를 지정하십시오.

스토어는 인메모리 지속성(JavaScript 변수)을 사용합니다. 저장 데이터는 페이지 수명 동안에만 사용할 수 있습니다.

ContextHub.Store.JSONPtore는 ContextHub.Store.Core을(를) 확장하고 해당 클래스의 함수를 상속합니다.

함수(ContextHub.Store.JSONPtore)

configureService(serviceConfig, override)

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

매개변수

serviceConfig: 다음 속성을 포함하는 개체:
- host: (문자열) 서버 이름 또는 IP 주소입니다.
- jsonp: (부울) 값이 true이면 서비스가 JSONP 서비스이고 그렇지 않으면 false입니다. true인 경우 {callback: "ContextHub.Callbacks.Object.name} 개체가 service.params 개체에 추가되었습니다.
- params: (개체) 개체 속성으로 표시되는 URL 매개 변수입니다. 매개 변수 이름은 속성 이름이고 매개 변수 값은 속성 값입니다.
- path: (문자열) 서비스 경로입니다.
- port: (숫자) 서비스의 포트 번호입니다.
- secure: (문자열 또는 부울) 서비스 URL에 사용할 프로토콜을 결정합니다.
  - auto: //
  - true: https://
  - false: http://
재정의:(부울). 값이 true이면 기존 서비스 구성이 serviceConfig의 속성으로 대체됩니다. 값이 false이면 기존 서비스 구성 속성이 serviceConfig의 속성과 병합됩니다.

getRawResponse()

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

반환

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

getServiceDetails()

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

반환

다음 속성을 갖는 객체:

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

getServiceURL(resolve)

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

매개변수

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

반환

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

init(name, config)

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

매개변수

name:(문자열) 저장소의 이름입니다.
config:(개체) 서비스 속성을 포함하는 개체입니다. JSONPtore 개체는 service 개체의 속성을 사용하여 JSONP 서비스의 URL을 구성합니다.
- eventDeferring: 32.
- eventing: 이 저장소의 ContextHub.Utils.Eventing 개체입니다. 기본값은 ContextHub.eventing 개체입니다.
- persistence: 이 저장소의 ContextHub.Utils.Persistence 개체입니다. 기본적으로 메모리 지속성이 사용됩니다(JavaScript 개체).
- service: (개체)
  - host: (문자열) 서버 이름 또는 IP 주소입니다.
  - jsonp: (부울) 값이 true이면 서비스가 JSONP 서비스이고 그렇지 않으면 false입니다. true이면 {callback: "ContextHub.Callbacks.*Object.name*}개체가 service.params에 추가됩니다.
  - params: (개체) 개체 속성으로 표시되는 URL 매개 변수입니다. 매개 변수 이름과 값은 각각 개체 속성 이름과 값입니다.
  - path: (문자열) 서비스 경로입니다.
  - port: (숫자) 서비스의 포트 번호입니다.
  - secure: (문자열 또는 부울) 서비스 URL에 사용할 프로토콜을 결정합니다.
    - auto: //
    - true: https://
    - false: http://
  - timeout: (숫자) 시간 제한 전에 JSONP 서비스가 응답할 때까지 기다리는 시간(밀리초)입니다.
    - ttl: JSONP 서비스 호출 사이에 경과되는 최소 시간(밀리초)입니다. (queryService 함수 참조).

queryService(다시 로드)

원격 JSONP 서비스를 쿼리하고 응답을 캐시합니다. 이 함수에 대한 이전 호출 이후의 시간이 config.service.ttl 값보다 작으면 서비스가 호출되지 않고 캐시된 응답이 변경되지 않습니다. 선택적으로 서비스를 강제로 호출할 수 있습니다. 저장소를 초기화하기 위해 init 함수를 호출할 때 config.service.ttl속성이 설정됩니다.

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

매개변수

reload:(부울) 값이 true이면 캐시된 응답이 제거되고 JSONP 서비스가 강제로 호출됩니다.

재설정

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

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

매개변수

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

resolveParameter(f)

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

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedJSONPStore은(는) ContextHub.Store.JSONPtore을(를) 확장하므로 해당 클래스의 모든 함수를 상속합니다. 그러나 JSONP 서비스에서 검색하는 데이터는 ContextHub 지속성 구성에 따라 지속됩니다. 지속성 모드 참조

ContextHub.Store.PersistedStore

ContextHub.Store.PersistedStore은(는) ContextHub.Store.Core을(를) 확장하므로 해당 클래스의 모든 함수를 상속합니다. 이 저장소의 데이터는 ContextHub 지속성 구성에 따라 유지됩니다.

ContextHub.Store.SessionStore

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

ContextHub.UI

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

함수(ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

UI 모듈 렌더러를 ContextHub에 등록합니다. 렌더러가 등록된 후에는 UI 모듈을 만들기하는 데 사용할 수 있습니다. 사용자 지정 UI 모듈 렌더러를 만들기 위해 ContextHub.UI.BaseModuleRenderer을(를) 확장할 때 이 함수를 사용합니다.

매개변수

moduleType:(문자열) UI 모듈 렌더러의 식별자입니다. 렌더러가 이미 지정된 값을 사용하여 등록된 경우, 이 렌더러가 등록되기 전에 기존 렌더러가 등록 취소되었습니다.
renderer:(문자열) UI 모듈을 렌더링하는 클래스의 이름입니다.
dontRender:(부울) 렌더러가 등록된 후 ContextHub UI가 렌더링되지 않도록 true(으)로 설정합니다. 기본값은 false입니다.

예

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

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

쿠키와 상호 작용하기 위한 유틸리티 클래스.

존재함(키)

쿠키가 존재하는지 여부를 결정합니다.

매개변수

key: 테스트 중인 쿠키의 키가 포함된 String입니다.

반환

boolean 값이 true이면 쿠키가 있음을 나타냅니다.

예

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

getAllItems(filter)

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

매개변수

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

반환

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

예

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

getItem(key)

쿠키 값을 반환합니다.

매개변수

key: 값을 원하는 쿠키의 키입니다.

반환

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

예

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

getKeys(filter)

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

매개변수

일치하는 쿠키 키에 대한 filter: 기준입니다. 지원되는 유형은 다음과 같습니다.
- 문자열: 문자열은 쿠키 키와 비교됩니다.
- 배열: 배열의 각 항목은 필터입니다.
- RegExp 개체: 개체의 테스트 함수는 쿠키 키를 일치시키는 데 사용됩니다.
- 함수: 일치 항목에 대한 쿠키 키를 테스트하는 함수입니다. 함수는 쿠키 키를 매개 변수로 사용하고 테스트에서 일치하는 것으로 확인되면 true을(를) 반환해야 합니다.

반환

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

예

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

removeItem(key, options)

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

매개변수

key: 제거할 쿠키의 키를 나타내는 String 값입니다.
options: 쿠키 특성을 구성하기 위한 속성 값을 포함하는 개체입니다. 자세한 내용은 setItem 함수를 참조하십시오. expires 속성은 영향을 주지 않습니다.

반환

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

예

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

setItem(키, 값, 옵션)

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

매개변수

key: 쿠키 키를 포함하는 문자열입니다.
value: 쿠키 값을 포함하는 문자열입니다.
options:(선택 사항) 쿠키 특성을 구성하는 다음 속성을 포함하는 개체입니다.
- expires: 쿠키가 만료되는 시기를 지정하는 date 또는 number 값입니다. 날짜 값은 절대 만료 시간을 지정합니다. 숫자(일)는 만료 시간을 현재 시간과 숫자를 더한 값으로 설정합니다. 기본값은 undefined입니다.
- secure: 쿠키의 Secure 특성을 지정하는 boolean 값입니다. 기본값은 false입니다.
- path: 쿠키의 Path 특성으로 사용할 String 값입니다. 기본값은 undefined입니다.

반환

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

예

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

지정된 필터와 일치하는 모든 쿠키를 제거합니다. 쿠키는 getKeys 함수를 사용하여 일치되고 removeItem 함수를 사용하여 제거됩니다.

매개변수

filter: getKeys 함수 호출에 사용할 filter 인수입니다.
options: removeItem 함수 호출에 사용할 options 인수입니다.

반환

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

ContextHub.Utils.Eventing

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

함수(ContextHub.Utils.Eventing)

off(name, selector)

이벤트에서 함수의 바인딩을 해제합니다.

매개변수

name: 함수를 바인딩 해제하는 이벤트의 이름입니다.
selector: 바인딩을 식별하는 선택기입니다. (on 및 once 함수에 대한 selector 매개 변수 참조).

반환

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

on(name, handler, selector, triggerForPastEvents)

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

매개변수

name:(문자열) 함수를 바인딩하는 이벤트의 이름입니다.
handler:(함수) 이벤트에 바인딩할 함수입니다.
selector:(문자열) 바인딩의 고유 식별자입니다. off 함수를 사용하여 바인딩을 제거하려면 선택기가 있어야 바인딩을 식별할 수 있습니다.
triggerForPastEvents:(부울) 이전에 발생한 이벤트에 대해 처리기를 실행할지 여부를 나타냅니다. true 값은 이전 이벤트에 대한 처리기를 호출합니다. false 값은 이후 이벤트에 대한 처리기를 호출합니다. 기본값은 true입니다.

반환

triggerForPastEvents 인수가 true이면 이 함수는 이벤트가 과거에 발생했는지 여부를 나타내는 boolean 값을 반환합니다.

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

triggerForPastEvents이(가) false이면 이 함수는 값을 반환하지 않습니다.

예

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

<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)

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

매개변수

name:(문자열) 함수를 바인딩하는 이벤트의 이름입니다.
handler:(함수) 이벤트에 바인딩할 함수입니다.
selector:(문자열) 바인딩의 고유 식별자입니다. off 함수를 사용하여 바인딩을 제거하려면 선택기가 있어야 바인딩을 식별할 수 있습니다.
triggerForPastEvents:(부울) 이전에 발생한 이벤트에 대해 처리기를 실행할지 여부를 나타냅니다. true 값은 이전 이벤트에 대한 처리기를 호출합니다. false 값은 이후 이벤트에 대한 처리기를 호출합니다. 기본값은 true입니다.

반환

triggerForPastEvents 인수가 true이면 이 함수는 이벤트가 과거에 발생했는지 여부를 나타내는 boolean 값을 반환합니다.

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

triggerForPastEvents이(가) false이면 이 함수는 값을 반환하지 않습니다.

ContextHub.Utils.inheritance

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

함수(ContextHub.Utils.inheritance)

inherit(하위, 상위)

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

매개변수

child:(개체) 상속되는 개체입니다.
parent:(개체) 상속된 속성과 메서드를 정의하는 개체입니다.

ContextHub.Utils.JSON

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

함수 (ContextHub.Utils.JSON)

parse(data)

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

매개변수

data: JSON 형식의 문자열 값입니다.

반환

JavaScript 개체.

예

코드:

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

다음 개체를 반환합니다.

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

stringify(data)

JavaScript 값 및 개체를 JSON 형식의 문자열 값으로 일련화합니다.

매개변수

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

반환

직렬화된 문자열 값입니다. data이(가) R egExp 값인 경우 이 함수는 빈 개체를 반환합니다. data이(가) 함수이면 undefined을(를) 반환합니다.

예

다음 코드:

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

반환:

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

ContextHub.Utils.JSON.tree

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

함수 (ContextHub.Utils.JSON.tree)

addAllItems()

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

매개변수

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

반환

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

cleanup()

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

매개변수

tree: 정리할 개체입니다.

반환

정리된 트리 사본.

getItem()

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

매개변수

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

반환

키에 해당하는 값입니다. 키에 자식 키가 있으면 이 함수는 복잡한 개체를 반환합니다. 키 값의 유형이 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()

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

매개변수

tree: 데이터 트리의 키를 검색할 개체입니다.
parent:(선택 사항) 데이터 트리에서 자식 항목의 키를 검색할 항목의 키입니다.
order:(선택 사항) 반환된 키의 정렬 순서를 결정하는 함수입니다. Mozilla 개발자 네트워크에서 Array.prototype.sort을(를) 참조하십시오.

반환

키 배열.

예

다음 객체를 고려하십시오.

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()

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

매개변수

tree: 데이터 개체입니다.
key: 제거할 키입니다.

반환

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

예

다음 객체를 고려하십시오.

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

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

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

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

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

sanitizeKey(키)

문자열 값을 정리하여 키로 사용할 수 있도록 합니다. 문자열을 정리하기 위해 이 함수는 다음 작업을 수행합니다.

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

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

매개변수

key: 삭제할 string입니다.

반환

각 문자열이 슬래시로 구분된 key의 일부인 string 값의 배열입니다. 정리된 키를 나타냅니다. 정리된 배열의 길이가 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: 추가하려는 값과 연결할 키입니다. 키는 데이터 트리에 있는 항목에 대한 경로입니다. 이 함수는 키를 추가하기 전에 ContextHub.Utils.JSON.tree.sanitize을(를) 호출하여 키를 정리합니다.
value: 데이터 트리에 추가할 값입니다.

반환

key/ value 쌍을 포함하는 tree 개체의 복사본입니다.

예

다음 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);

ContextHub.Utils.storeCandidates

스토어 후보를 등록하고 등록된 스토어 후보를 가져올 수 있습니다.

함수(ContextHub.Utils.storeCandidates)

getRegisteredCandidates(storeType)

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

매개변수

storeType:(문자열) 저장소 유형의 이름입니다. ContextHub.Utils.storeCandidates.registerStoreCandidate 함수의 storeType 매개 변수를 참조하십시오.

반환

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

getStoreFromCandidates(storeType)

등록된 후보에서 스토어 유형을 반환합니다. 같은 이름의 스토어 유형이 두 개 이상 등록되면 이 함수는 우선 순위가 가장 높은 스토어 유형을 반환합니다.

매개변수

storeType: (문자열) 저장소 후보의 이름입니다. ContextHub.Utils.storeCandidates.registerStoreCandidate 함수의 storeType 매개 변수를 참조하십시오.

반환

등록된 저장소 후보를 나타내는 개체입니다. 요청한 스토어 유형이 등록되지 않으면 오류가 발생합니다.

getSupportedStoreTypes()

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

반환

각 문자열이 저장소 후보가 등록된 storetype인 문자열 값의 배열입니다. ContextHub.Utils.storeCandidates.registerStoreCandidate 함수의 storeType 매개 변수를 참조하십시오.

registerStoreCandidate(store, storeType, priority, applies)

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

우선 순위는 같은 이름의 매장의 중요성을 나타내는 숫자이다. 이미 등록된 점포 후보자와 동일한 명칭을 사용하여 점포 후보자를 등록한 경우, 우선순위가 더 높은 후보를 이용한다. 점포 후보 등록 시 동명이등록 점포 후보보다 우선순위가 높은 경우에만 점포를 등록한다.

매개변수

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

예

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