ContextHub JavaScript API 참조 contexthub-javascript-api-reference

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

ContextHub 상수 contexthub-constants

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

이벤트 상수 event-constants

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

UI 이벤트 상수 ui-event-constants

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

ContextHub JavaScript API 참조 contexthub-javascript-api-reference-2

ContextHub 개체는 모든 저장소에 대한 액세스를 제공합니다.

함수(ContextHub) functions-contexthub

getAllStores() getallstores

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

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

반환

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

예

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

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

getStore(name) getstore-name

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

매개변수

반환

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

예

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

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

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

ContextHub 세그먼트를 나타냅니다. 세그먼트를 가져오려면 ContextHub.SegmentEngine.SegmentManager를 사용합니다.

함수(ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment

getName() getname

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

getPath() getpath

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

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

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

함수(ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

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

반환

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

ContextHub.Store.Core contexthub-store-core

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

속성(ContextHub.Store.Core) properties-contexthub-store-core

이벤트 eventing

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

이름 name

스토어의 이름입니다.

지속성 persistence

ContextHub.Utils.Persistence 개체입니다. 기본값 및 초기화에 대한 자세한 내용은 [init(name,config)](https://experienceleague.adobe.com/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.html?lang=ko#init-name-config).을(를) 참조하십시오

함수(ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(tree, options) addallitems-tree-options

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

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

매개변수

반환

boolean 값:

addReference(key, anotherKey) addreference-key-anotherkey

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

매개변수

반환

boolean 값:

announceReadiness() announcereadiness

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

clean() clean

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

getItem(key) getitem-key

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

매개변수

반환

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

getKeys(includeInternals) getkeys-includeinternals

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

매개변수

반환

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

getReferences() getreferences

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

반환

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

getTree(includeInternal) gettree-includeinternals

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

매개변수

반환

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

init(name, config) init-name-config

저장소를 초기화합니다.

매개변수

isEventingPaused() iseventingpaused

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

반환

부울 값:

pauseEventing() pauseeventing

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

removeItem(key, options) removeitem-key-options

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

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

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

매개변수

반환

boolean 값:

removeReference(key) removereference-key

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

매개변수

반환

boolean 값:

reset(keepRemainingData) reset-keepremainingdata

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

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

매개변수

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

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

매개변수

resolveReference(key, retry) resolvereference-key-retry

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

매개변수

반환

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

resumeEventing() resumeeventing

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

setItem(키, 값, 옵션) setitem-key-value-options

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

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

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

매개변수

반환

boolean 값:

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

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

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

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

함수(ContextHub.Store.JSONPtore) functions-contexthub-store-jsonpstore

configureService(serviceConfig, override) configureservice-serviceconfig-override

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

매개변수

getRawResponse() getrawresponse

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

반환

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

getServiceDetails() getservicedetails

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

반환

다음 속성을 갖는 객체:

getServiceURL(resolve) getserviceurl-resolve

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

매개변수

반환

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

init(name, config) init-name-config-1

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

매개변수

queryService(다시 로드) queryservice-reload

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

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

매개변수

재설정 reset

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

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

매개변수

resolveParameter(f) resolveparameter-f

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

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

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

ContextHub.Store.PersistedStore contexthub-store-persistedstore

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

ContextHub.Store.SessionStore contexthub-store-sessionstore

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

ContextHub.UI contexthub-ui

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

함수(ContextHub.UI) functions-contexthub-ui

registerRenderer(moduleType, renderer, dontRender) registerrenderer-moduletype-renderer-dontrender

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

매개변수

예

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

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

ContextHub.Utils.Cookie contexthub-utils-cookie

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

함수 (ContextHub.Utils.Cookie) functions-contexthub-utils-cookie

존재함(키) exists-key

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

매개변수

반환

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

예

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

getAllItems(filter) getallitems-filter

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

매개변수

반환

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

예

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

getItem(key) getitem-key-1

쿠키 값을 반환합니다.

매개변수

반환

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

예

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

getKeys(filter) getkeys-filter

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

매개변수

반환

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

예

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

removeItem(key, options) removeitem-key-options-1

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

매개변수

반환

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

예

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

setItem(키, 값, 옵션) setitem-key-value-options-1

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

매개변수

반환

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

예

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

단축(필터, 옵션) vanish-filter-options

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

매개변수

반환

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

ContextHub.Utils.Eventing contexthub-utils-eventing

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

함수(ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off(name, selector) off-name-selector

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

매개변수

반환

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

on(name, handler, selector, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

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

매개변수

반환

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

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) once-name-handler-selector-triggerforpastevents

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

매개변수

반환

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

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

ContextHub.Utils.inheritance contexthub-utils-inheritance

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

함수(ContextHub.Utils.inheritance) functions-contexthub-utils-inheritance

inherit(하위, 상위) inherit-child-parent

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

매개변수

ContextHub.Utils.JSON contexthub-utils-json

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

함수 (ContextHub.Utils.JSON) functions-contexthub-utils-json

parse(data) parse-data

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

매개변수

반환

JavaScript 개체.

예

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

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

stringify(data) stringify-data

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

매개변수

반환

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

예

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

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

ContextHub.Utils.JSON.tree contexthub-utils-json-tree

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

함수 (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree

addAllItems() addallitems

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

매개변수

반환

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

cleanup() cleanup

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

매개변수

반환

정리된 트리 사본.

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

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

매개변수

반환

키 배열.

예

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

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

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

매개변수

반환

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

예

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

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(키) sanitizekey-key

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

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

반환

각 문자열이 슬래시로 구분된 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(트리, 키, 값) setitem-tree-key-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);

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

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

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

함수(ContextHub.Utils.storeCandidates) functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

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

매개변수

반환

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

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

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

매개변수

반환

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

getSupportedStoreTypes() getsupportedstoretypes

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

반환

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

registerStoreCandidate(store, storeType, priority, applies) registerstorecandidate-store-storetype-priority-applies

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

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

매개변수

예

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