27 Référence au kit SDK Sites

Le kit SDK JavaScript Oracle Content Management (kit SDK Sites) dispose d'un ensemble de fonctions qui permettent d'intégrer davantage les composants à Oracle Content Management.

Vous pouvez télécharger le kit SDK Sites à partir du serveur Oracle Content Management :

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

Les définitions de l'API Sites couvrent tous les espaces de noms définis de l'objet global SitesSDK :

L'objectif principal du kit SDK Sites est de permettre aux utilisateurs de créer et de gérer des applications. Il fournit plusieurs fonctionnalités :

Communication entre les limites de domaine et de cadre incorporé
- Permet à un composant de communiquer avec une page peu importe où le composant est hébergé.
- Inclut la participation au cycle de vie du modèle de page :
  - création du composant,
  - affichage du composant avec les propriétés stockées,
  - mise à jour du composant et enregistrement de ces modifications,
  - suppression du composant de la page.
- Stocke et extrait les paramètres personnalisés utilisés pour configurer un composant sur une page.
- Utilise une communication entre les composants pour participer aux déclencheurs et aux actions.
Conseils de géométrie sur une page (non applicable aux composants personnalisés)
- Permet à une page de redimensionner de façon dynamique la cadre incorporé lorsqu'un composant le lui indique.
- Permet à un composant d'apparaître sur une page et à la page de se déplacer en réponse aux événements de redimensionnement de composant (aucune barre de défilement).
Reconnaissance de l'appel provenant d'Oracle Content Management par le composant
- La communication entre un composant et une page contient un jeton signé par une clé privée.
- Le kit SDK Sites permet au composant de décoder le jeton et de vérifier l'appelant.

Pour inclure les fonctions du kit SDK Sites, fournissez un chemin connu du script. Par exemple :

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

Le kit SDK Sites comprend ces objets globaux :

SitesSDK
SitesSDK.Utils

SitesSDK

L'objet global SitesSDK peut être utilisé dans les adresses d'affichage et de paramètres.

Commande	Tâche
SitesSDK.getProperty(propertyName, callback)	Obtient la valeur de la propriété nommée à partir du site hôte.
SitesSDK.setProperty(propertyName, propertyValue)	Définit la valeur de la propriété nommée sur `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Obtient une valeur de propriété de site nommée à partir du site hôte. Par exemple, elle peut extraire la conception de thème en cours utilisée par le site hôte.
SitesSDK.publish(messageType, payload)	Envoie un message au serveur et accepte un paramètre `messageType` et un objet JSON en tant que données traitées.
SitesSDK.subscribe(messageType, callback)	Processus d'écoute des messages répartis à partir du site hôte. L'appel est asynchrone. Il s'agit de callbacks JavaScript, la fonction doit donc utiliser une fermeture JavaScript ou lier correctement la fonction pour veiller à avoir accès au contexte approprié.

SitesSDK.Utils

L'espace de noms SitesSDK.Utils possède des fonctions d'utilitaire qui peuvent être appelées par toutes les adresses d'un composant Oracle Content Management. Cet espace de noms est disponible pour le panneau des paramètres d'un composant distant, mais pas d'un composant local incorporé.

Prudence :

Ces fonctions ne sont pas officiellement prises en charge par Oracle. Elles sont fournies uniquement à titre d'exemples d'implémentation. Si vous les utilisez, vous en assumez entièrement les risques.

Commande	Tâche
SitesSDK.Utils.Logger	Renvoie l'objet de journaliseur utilisé par le kit SDK Sites. Le niveau de journalisation peut être défini sur l'une des valeurs suivantes : debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Ajoute la conception de thème de site en cours à un composant.
Utils.getStyle(elem,styleProp)	Méthode d'utilitaire qui calcule la hauteur du cadre incorporé.