27 Sites SDK 참조

Oracle Content Management JavaScript SDK(Sites SDK)에는 구성요소가 Oracle Content Management와 더 통합된 경험을 제공할 수 있도록 지원하는 함수 집합이 있습니다.

Sites SDK는 Oracle Content Management 서버에서 다운로드할 수 있습니다.

http://{server}/_sitesclouddelivery/renderer/app/sdk/js/sites.min.js

Sites API(애플리케이션 프로그래밍 인터페이스) 정의는 전역 객체 SitesSDK의 모든 정의된 네임스페이스를 다룹니다.

Sites SDK의 주 목적은 사용자가 애플리케이션을 빌드하고 관리하도록 하는 것입니다. 여러 기능을 제공합니다.

  • 인라인 프레임 및 도메인 경계를 넘은 통신

    • 구성요소 호스팅 위치에 관계없이 구성요소가 페이지와 통신할 수 있음

    • 페이지 모델 수명 주기에 참여:
      • 구성요소 생성

      • 저장된 속성으로 구성요소 렌더링

      • 구성요소 업데이트 및 변경사항 저장

      • 페이지에서 구성요소 삭제

    • 페이지에 사용할 구성요소 구성에 사용된 사용자정의 설정 저장 및 검색

    • 구성요소간 통신을 사용하여 트리거 및 작업 참여

  • 페이지에 형상 힌트(사용자정의 구성요소에는 적용되지 않음)

    • 구성요소가 지시할 때 페이지의 인라인 프레임 크기를 동적으로 조정할 수 있음

    • 결과적으로 구성요소가 페이지의 일부인 것처럼 보이고 구성요소 크기 조정 이벤트에 응답하여 페이지가 이동함(스크롤 막대 없음)

  • Oracle Content Management에서 호출될 때 구성요소 인지

    • 구성요소와 페이지 간의 통신에는 전용 키로 서명한 토큰이 관여합니다.

    • Sites SDK는 구성요소가 토큰을 디코딩하고 호출자 확인을 용이하게 합니다.

알려진 스크립트 경로를 제공하여 Sites SDK 함수를 포함합니다. 예를 들어, 다음과 같습니다.

<script type="text/javascript" 
src="<sdk_install_dir_path_prefix>/sites.min.js">
</script>

Sites SDK에는 다음 전역 객체가 있습니다.

  • SitesSDK

  • SitesSDK.Utils

SitesSDK

SitesSDK 전역 객체는 렌더링 및 설정 끝점에서 사용할 수 있습니다.

명령 작업

SitesSDK.getProperty(propertyName, callback)

호스트 사이트에서 명명된 속성 값을 가져옵니다.

SitesSDK.setProperty(propertyName, propertyValue)

명명된 속성 값을 propertyValue로 설정합니다.

SitesSDK.getSiteProperty(propertyName, callback)

호스트 사이트에서 명명된 사이트 속성 값을 가져옵니다. 예를 들어, 호스트 사이트에서 사용 중인 현재 테마 디자인을 인출할 수 있습니다.

SitesSDK.publish(messageType, payload)

서버에 메시지를 전송하고 messageType 및 JSON 객체를 페이로드로 수락합니다.

SitesSDK.subscribe(messageType, callback)

호스트 사이트에서 작업 할당된 메시지의 메시지 리스너입니다. 비동기 호출입니다. 이것은 JavaScript 콜백이므로 함수에 JavaScript 클로저를 사용하거나 함수를 적절히 바인딩하여 적합한 컨텍스트에 액세스할 수 있도록 해야 합니다.

SitesSDK.Utils

SitesSDK.Utils 네임스페이스에는 Oracle Content Management 구성요소의 모든 끝점에서 호출할 수 있는 유틸리티 함수가 있습니다. 이 네임스페이스는 원격 구성요소의 설정 패널에서 사용할 수 있지만 인라인 로컬 구성요소에는 제공되지 않습니다.

주의:

이 함수는 오라클이 공식적으로 지원하지 않으며 샘플 구현을 위한 것입니다. 사용자 책임하에 사용하십시오.
명령 작업

SitesSDK.Utils.Logger

Sites SDK에서 사용 중인 로거 객체를 반환합니다. 다음 중 하나로 로그 레벨을 설정할 수 있습니다.
  • debug

  • log

  • info

  • error

  • warn

SitesSDK.Utils.addSiteThemeDesign(cssUrl)

현재 사이트 테마 디자인을 구성요소에 추가합니다.

Utils.getStyle(elem,styleProp)

인라인 프레임의 높이를 계산하는 유틸리티 메소드입니다.