Chiamate all’editor universale calls
Scopri i diversi tipi di chiamate effettuate all’app dall’editor universale per facilitarti il debug.
Panoramica overview
L’editor universale comunica con l’app dotata di strumenti tramite una serie di chiamate definite. Questo è trasparente per l’esperienza dell’utente finale e non ha alcun effetto su di essa.
Tuttavia, per lo sviluppatore, comprendere queste chiamate e come funzionano può essere utile durante il debug dell’applicazione quando si utilizza l’editor universale. Se hai dotato di strumenti l’app e il comportamento non è quello previsto, può essere utile aprire la scheda Rete degli strumenti per sviluppatori nel browser e controllare le chiamate mentre modifichi il contenuto nell’app.
- Il payload della chiamata contiene i dettagli di ciò che viene aggiornato dall’editor, tra cui l’identificazione dell’elemento da aggiornare e come aggiornarlo.
- La Risposta include i dettagli di ciò che è stato esattamente aggiornato dal servizio editor. Questo consente di facilitare l’aggiornamento del contenuto nell’editor. In alcuni casi, come una chiamata
move, è necessario aggiornare l’intera pagina.
Una volta completata correttamente una chiamata, vengono attivati gli eventi che includono il payload della richiesta e della risposta, che può essere personalizzato per la tua app. Per maggiori dettagli, consulta il documento Eventi dell’editor universale.
Di seguito è riportato un elenco dei tipi di chiamate effettuate dall’editor universale all’app, con esempi di payload e risposte.
Aggiornare update
Una chiamata update si verifica quando modifichi il contenuto nell’app utilizzando l’editor universale. update mantiene le modifiche.
Il relativo payload include dettagli su cosa riscrivere nel JCR.
resource: percorso JCR da aggiornareprop: proprietà JCR in fase di aggiornamentotype: tipo di valore JCR della proprietà in fase di aggiornamentovalue: dati aggiornati
| code language-json |
|---|
|
| code language-json |
|---|
|
Dettagli details
Una chiamata details si verifica durante il caricamento dell’app nell’editor universale per recuperare il contenuto dell’app.
Il suo payload include i dati da sottoporre a rendering, nonché dettagli di cosa rappresentano i dati (lo schema) in modo che possano essere sottoposti a rendering nell’editor universale.
- Per un componente, l’editor universale recupera solo un oggetto
data, poiché lo schema dei dati è definito nell’app. - Per i frammenti di contenuto, l’editor universale recupera anche un oggetto
schemapoiché il modello per frammenti di contenuto è definito nel JCR.
| code language-json |
|---|
|
| code language-json |
|---|
|
Aggiungere add
Una chiamata add si verifica quando inserisci un nuovo componente nell’app utilizzando l’editor universale.
Il suo payload include un oggetto path contenente la posizione in cui aggiungere il contenuto.
Include, inoltre, un oggetto content con oggetti aggiuntivi per i dettagli specifici dell’endpoint del contenuto da archiviare per ogni plug-in. Ad esempio, se l’app è basata su contenuti di AEM e Magento, il payload conterrà un oggetto dati per ciascun sistema.
| code language-json |
|---|
|
| code language-json |
|---|
|
Spostare move
Una chiamata move si verifica quando si sposta un componente all’interno dell’app utilizzando l’editor universale.
Il suo payload include un oggetto from che definisce dove si trovava il componente e un oggetto to che definisce dove è stato spostato.
| code language-json |
|---|
|
| code language-json |
|---|
|
Rimuovere remove
Una chiamata remove si verifica quando si elimina un componente all’interno dell’app tramite l’editor universale.
Il suo payload include il percorso dell’oggetto rimosso.
| code language-json |
|---|
|
| code language-json |
|---|
|
Pubblicare publish
Una chiamata publish si verifica quando si fa clic sul pulsante Pubblica nell’editor universale per pubblicare il contenuto modificato.
L’editor universale scorre il contenuto e genera un elenco di riferimenti che devono essere pubblicati.
| code language-json |
|---|
|
| code language-json |
|---|
|