27 Αναφορά SDK τοποθεσιών

Το JavaScript SDK (SDK Τοποθεσιών) του Oracle Content Management έχει ένα σύνολο συναρτήσεων που επιτρέπουν στα συστατικά στοιχεία να έχουν μια πιο ενοποιημένη εμπειρία με το Oracle Content Management.

Το SDK Τοποθεσιών είναι διαθέσιμο για λήψη από τον Oracle Content Management server:

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

Οι ορισμοί του API (Sites Application Programming Interface) καλύπτουν όλους τους καθορισμένους χώρους ονομάτων του καθολικού αντικειμένου SitesSDK:

Ο κύριος σκοπός του SDK Τοποθεσιών είναι να επιτρέπει στους χρήστες να κατασκευάζουν και να διαχειρίζονται εφαρμογές. Παρέχει αρκετές λειτουργίες:

Επικοινωνία στα όρια τομέα και ενσωματωμένων πλαισίων
- Επιτρέπει σε ένα συστατικό στοιχείο να επικοινωνεί με μια σελίδα ανεξάρτητα πού φιλοξενείται το συστατικό στοιχείο
- Περιλαμβάνει συμμετοχή στον κύκλο ζωής μοντέλου σελίδων:
  - δημιουργία του συστατικού στοιχείου
  - απόδοση του συστατικού στοιχείου με αποθηκευμένες ιδιότητες
  - ενημέρωση του συστατικού στοιχείου και αποθήκευση αυτών των αλλαγών
  - διαγραφή του συστατικού στοιχείου από τη σελίδα
- Αποθηκεύει και ανακτά προσαρμοσμένες ρυθμίσεις που χρησιμοποιούνται για τη διαμόρφωση ενός συστατικού στοιχείου για χρήση σε μια σελίδα
- Χρησιμοποιεί επικοινωνία μεταξύ των συστατικών στοιχείων για συμμετοχή σε εναύσματα και ενέργειες
Υποδείξεις γεωμετρίας σε μια σελίδα (δεν ισχύει για προσαρμοσμένα συστατικά στοιχεία)
- Επιτρέπει σε μια σελίδα να αλλάξει δυναμικά το μέγεθος το ενσωματωμένο πλαίσιο όταν της ζητηθεί από ένα συστατικό στοιχείο
- Έχει ως αποτέλεσμα ένα συστατικό στοιχείο να εμφανίζεται ως τμήμα μιας σελίδας και στη σελίδα να μετακινείται ως απόκριση σε συμβάντα αλλαγής μεγέθους του συστατικού στοιχείου (χωρίς γραμμές κύλισης)
Αναγνώριση συστατικού στοιχείου όταν καλείται από το Oracle Content Management
- Η επικοινωνία μεταξύ ενός συστατικού στοιχείου και μιας σελίδας περιέχει ένα διακριτικό που έχει υπογραφή από ένα ιδιωτικό κλειδί.
- Το SDK Τοποθεσιών επιτρέπει σε ένα συστατικό στοιχείο να αποκωδικοποιεί το διακριτικό και διευκολύνει την επαλήθευση του καλούντος.

Μπορείτε να συμπεριλάβετε τις συναρτήσεις του SDK Τοποθεσιών παρέχοντας μια γνωστή διαδρομή της δέσμης ενεργειών. Για παράδειγμα:

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

Το SDK Τοποθεσιών έχει αυτά τα καθολικά αντικείμενα:

SitesSDK
SitesSDK.Utils

SitesSDK

Το καθολικό αντικείμενο SitesSDK μπορεί να χρησιμοποιηθεί σε τελικά σημεία απόδοσης και ρυθμίσεων.

Εντολή	Εργασία
SitesSDK.getProperty(propertyName, callback)	Λαμβάνει την τιμή της καθορισμένης ιδιότητας από την τοποθεσία κεντρικού υπολογιστή.
SitesSDK.setProperty(propertyName, propertyValue)	Ορίζει την τιμή της καθορισμένης ιδιότητας σε `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Λαμβάνει μια τιμή καθορισμένης ιδιότητας τοποθεσίας από μια τοποθεσία κεντρικού υπολογιστή. Για παράδειγμα, μπορεί να λάβει την τρέχουσα σχεδίαση θέματος που χρησιμοποιείται από την τοποθεσία κεντρικού υπολογιστή.
SitesSDK.publish(messageType, payload)	Στέλνει ένα μήνυμα στον server και αποδέχεται ένα `messageType` και ένα αντικείμενο JSON ως ωφέλιμο φορτίο.
SitesSDK.subscribe(messageType, callback)	Μια λειτουργία ακρόασης μηνυμάτων για μηνύματα που αποστέλλονται από την τοποθεσία του κεντρικού υπολογιστή. Η κλήση είναι ασύγχρονη. Αυτές είναι επανακλήσεις JavaScript, οπότε η συνάρτηση θα πρέπει να χρησιμοποιήσει το JavaScript Closure ή να δεσμεύσει κατάλληλα τη συνάρτηση για να εξασφαλίσει ότι έχει πρόσβαση στο κατάλληλο περιβάλλον.

SitesSDK.Utils

Ο χώρος ονομάτων SitesSDK.Utils έχει συναρτήσεις βοηθητικών προγραμμάτων που μπορούν να κληθούν από όλα τα τελικά σημεία ενός συστατικού στοιχείου του Oracle Content Management. Αυτός ο χώρος ονομάτων είναι διαθέσιμος για τον πίνακα ρυθμίσεων για ένα απομακρυσμένο συστατικό στοιχείο, αλλά όχι για το ενσωματωμένο τοπικό συστατικό στοιχείο.

Προσοχή:

Αυτές οι συναρτήσεις δεν υποστηρίζονται επίσημα από την Oracle, προορίζονται ως δείγματα υλοποιήσεων. Χρησιμοποιήστε τις με δική σας ευθύνη.

Εντολή	Εργασία
SitesSDK.Utils.Logger	Επιστρέφει το αντικείμενο της λειτουργίας καταγραφής που χρησιμοποιείται από το SDK Τοποθεσιών. Το επίπεδο καταγραφής μπορεί να οριστεί σε ένα από τα ακόλουθα: εντοπισμός σφαλμάτων καταγραφή πληροφορίες σφάλμα προειδοποίηση
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Προσθέτει την τρέχουσα σχεδίαση θέματος τοποθεσίας σε ένα συστατικό στοιχείο.
Utils.getStyle(elem,styleProp)	Μια μέθοδος βοηθητικού προγράμματος που υπολογίζει το ύψος του ενσωματωμένου πλαισίου.