Erfahren Sie mehr über die verschiedenen Arten von Aufrufen, die der universelle Editor an Ihre App sendet, um Sie beim Debuggen zu unterstützen.
Überblick overview
Der universelle Editor kommuniziert mit Ihrer instrumentierten App über eine Reihe definierter Aufrufe. Dies ist für die Endbenutzenden transparent und hat keine Auswirkungen auf ihr Anwendererlebnis.
Für die Entwickelnden kann es jedoch nützlich sein, diese Aufrufe zu verstehen und zu wissen, was sie tun, wenn sie Ihre Anwendung mit dem universellen Editor debuggen. Wenn Sie Ihre Anwendung instrumentiert haben und sie sich nicht wie erwartet verhält, kann es hilfreich sein, die Registerkarte Netzwerk der Entwickler-Tools in Ihrem Browser zu öffnen und die Aufrufe zu inspizieren, während Sie Inhalte in Ihrer Anwendung bearbeiten.
Die Payload des Aufrufs enthält Details zu dem, was vom Editor aktualisiert wird, einschließlich der Angabe, was zu aktualisieren ist und wie es zu aktualisieren ist.
Die Antwort enthält Details darüber, was genau vom Editor-Dienst aktualisiert wurde. Dadurch soll die Aktualisierung des Inhalts im Editor erleichtert werden. In bestimmten Fällen, wie bei einem move-Aufruf, muss die gesamte Seite aktualisiert werden.
Nachdem ein Aufruf erfolgreich abgeschlossen wurde, werden Ereignisse mit der Anfrage- und Antwort-Payload ausgelöst, die für Ihre eigene App angepasst werden kann. Weitere Informationen finden Sie unter Ereignisse des universellen Editors.
Im Folgenden finden Sie eine Liste der Arten von Aufrufen, die der universelle Editor an Ihre App richtet, sowie Beispiele für Payloads und Antworten.
Update update
Ein update-Aufruf erfolgt, wenn Sie Inhalte in Ihrer App mit dem universellen Editor bearbeiten. update behält die Änderungen bei.
Die Payload enthält Details dazu, was an das JCR zurückgeschrieben werden soll.
resource: Der zu aktualisierende JCR-Pfad
prop: Die JCR-Eigenschaft, die aktualisiert werden soll
type: Der JCR-Werttyp der zu aktualisierenden Eigenschaft
Ein details-Aufruf erfolgt beim Laden Ihrer App im universellen Editor, um den Inhalt der App abzurufen.
Die Payload enthält die Daten, die gerendert werden sollen, sowie Details darüber, was die Daten darstellen (das Schema), damit sie im universellen Editor gerendert werden können.
Für eine Komponente ruft der universelle Editor nur ein data-Objekt ab, da das Schema der Daten in der App definiert ist.
Für Inhaltsfragmente ruft der universelle Editor ebenfalls ein schema-Objekt ab, da das Inhaltsfragmentmodell im JCR definiert ist.
{
"data": {
"jcr:primaryType": "nt:unstructured",
"jcr:title": "Tiny Toon Adventures",
"fileReference": "/content/dam/wknd-shared/en/adventures/riverside-camping-australia/adobestock-216674449.jpeg",
"cq:panelTitle": "WKND Adventures",
"actionsEnabled": "true",
"jcr:lastModifiedBy": "admin",
"titleFromPage": "false",
"jcr:description": "<p>With WKND Adventures, you don't just see the world you experinece it.</p>\r\n",
"jcr:lastModified": "Fri Jan 19 2024 11:05:59 GMT+0100",
"descriptionFromPage": "true",
"sling:resourceType": "wknd/components/teaser",
"textIsRich": "true",
"cq:styleIds": [
"1555543212672"
],
"actions": {
"jcr:primaryType": "nt:unstructured",
"item0": {
"jcr:primaryType": "nt:unstructured",
"link": "/content/wknd/language-masters/en/adventures",
"text": "View Trips"
}
}
}
}
Hinzufügen add
Ein add-Aufruf erfolgt, wenn Sie mit dem universellen Editor eine neue Komponente in Ihrer App platzieren.
Die Payload enthält ein path-Objekt, das den Pfad enthält, wo der Inhalt hinzugefügt werden soll.
Es enthält auch ein content-Objekt mit zusätzlichen Objekten für endpunktspezifische Details des zu speichernden Inhalts für jedes Plug-in. Wenn Ihre App beispielsweise auf Inhalten von AEM und Magento basiert, enthält die Payload ein Datenobjekt für jedes System.
Ein publish-Aufruf erfolgt, wenn Sie im universellen Editor auf die Schaltfläche Veröffentlichen klicken, um den von Ihnen bearbeiteten Inhalt zu veröffentlichen.
Der universelle Editor durchläuft den Inhalt und generiert eine Liste von Verweisen, die ebenfalls veröffentlicht werden müssen.
