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 Application Programming Interface (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 Closure หรือเชื่อมโยงฟังก์ชันให้เหมาะสมเพื่อให้แน่ใจว่ามีสิทธิ์เข้าใช้คอนเท็กซ์ที่ถูกต้อง

SitesSDK.Utils

เนมสเปซ SitesSDK.Utils มีฟังก์ชันยูทิลิตีที่จุดสิ้นสุดทั้งหมดขององค์ประกอบ Oracle Content Management สามารถเรียกได้ มีเนมสเปซนี้สำหรับแผงข้อมูลการตั้งค่าขององค์ประกอบระยะไกล แต่ไม่ใช่สำหรับองค์ประกอบในระบบแบบอินไลน์

ข้อควรระวัง:

Oracle ไม่ได้รองรับฟังก์ชันเหล่านี้อย่างเป็นทางการ โดยกำหนดเป็นตัวอย่างการใช้งาน การใช้งานถือเป็นความเสี่ยงของคุณเอง
คำสั่ง งาน

SitesSDK.Utils.Logger

แสดงออบเจกต์ตัวล็อกที่ Sites SDK ใช้งานอยู่ สามารถตั้งค่ารหัสล็อกเป็นค่าใดค่าหนึ่งดังนี้
  • ดีบัก

  • ล็อก

  • ข้อมูล

  • ข้อผิดพลาด

  • คำเตือน

SitesSDK.Utils.addSiteThemeDesign(cssUrl)

เพิ่มการออกแบบธีมของไซต์ปัจจุบันในองค์ประกอบ

Utils.getStyle(elem,styleProp)

วิธียูทิลิตีที่คำนวณความสูงของเฟรมแบบอินไลน์