Appels de l’éditeur universel calls
Découvrez les différents types d’appels effectués sur votre application par l’éditeur universel pour vous aider lors du débogage.
Vue d’ensemble overview
L’éditeur universel communique avec votre application instrumentée par le biais d’une série d’appels définis. Cette opération est transparente pour et n’a aucun impact sur l’expérience client finale.
Pour le développeur ou la développeuse, en revanche, comprendre ces appels et leur rôle peut s’avérer utile lors du débogage de l’application avec l’éditeur universel. Si l’application a été instrumentée et ne se comporte pas comme prévu, il peut être utile d’ouvrir l’onglet Réseau des outils de développement du navigateur et d’examiner les appels lors de la modification du contenu dans l’application.
- La payload de l’appel contient des informations sur les éléments mis à jour par l’éditeur, notamment l’identification de ce qui doit être mis à jour et la façon de le faire.
- La réponse comprend des informations précises sur les éléments mis à jour par le service d’éditeur. Cela permet de faciliter l’actualisation du contenu dans l’éditeur. Dans certains cas, comme lors d’un appel
move
, l’ensemble de la page doit être actualisé.
Une fois l’appel terminé avec succès, des événements sont déclenchés et incluent la payload de la requête et de la réponse, qui peut être personnalisée pour l’application. Pour plus d’informations, consultez le document Événements de l’éditeur universel.
Vous trouverez ci-dessous une liste des types d’appels effectués par l’éditeur vers l’application, accompagnée d’exemples de payloads et de réponses.
Mettre à jour update
Un appel update
se produit lors de la modification de contenu dans l’application à l’aide de l’éditeur universel. La update
conserve les modifications.
Sa payload contient des informations sur ce qui doit être écrit dans le JCR.
resource
: le chemin JCR à mettre à jourprop
: la propriété JCR en cours de mise à jourtype
: le type de valeur JCR de la propriété mise à jourvalue
: les données mises à jour
code language-json |
---|
|
code language-json |
---|
|
Détails details
Un appel details
se produit lors du chargement de l’application dans l’éditeur universel afin de récupérer le contenu de l’application.
Sa payload contient les données à restituer ainsi que des informations sur la signification de ces données (le schéma), afin qu’elles puissent être restituées dans l’éditeur universel.
- Pour un composant, l’éditeur universel récupère uniquement un objet
data
, car le schéma des données est défini dans l’application. - Pour les fragments de contenu, l’éditeur universel récupère également un objet
schema
, puisque le modèle de fragment de contenu est défini dans le JCR.
code language-json |
---|
|
code language-json |
---|
|
Ajouter add
Un appel add
se produit lors de l’ajout d’un nouveau composant dans l’application à l’aide de l’éditeur universel.
Sa payload comprend un objet path
contenant l’emplacement où le contenu doit être ajouté.
Elle comprend également un objet content
avec des objets supplémentaires pour les détails spécifiques aux points d’entrée du contenu à stocker pour chaque module externe. Par exemple, si votre application est basée sur le contenu d’AEM et de Magento, la payload contient un objet de données pour chaque système.
code language-json |
---|
|
code language-json |
---|
|
Déplacer move
Un appel move
se produit lorsque vous déplacez un composant dans votre application à l’aide de l’éditeur universel.
Sa payload comprend un objet from
définissant l’emplacement du composant et un objet to
définissant l’emplacement où il a été déplacé.
code language-json |
---|
|
code language-json |
---|
|
Supprimer remove
Un appel remove
se produit lorsque vous supprimez un composant dans votre application à l’aide de l’éditeur universel.
Sa payload inclut le chemin d’accès de l’objet supprimé.
code language-json |
---|
|
code language-json |
---|
|
Publier publish
Un appel publish
se produit lorsque vous cliquez sur le bouton Publier dans l’éditeur universel pour publier le contenu que vous avez modifié.
L’éditeur universel effectue une itération sur le contenu et génère une liste de références qui doivent également être publiées.
code language-json |
---|
|
code language-json |
---|
|