Ereignisse des universellen Editors events

Erfahren Sie mehr über die verschiedenen Ereignisse, die der universelle Editor sendet und mit denen Sie auf Änderungen an Inhalten oder Benutzeroberfläche in Ihrer Remote-App reagieren können.

Einführung introduction

Anwendungen können unterschiedliche Anforderungen für Seiten- oder Komponentenaktualisierungen haben. Daher sendet der universelle Editor definierte Ereignisse an Remote-Anwendungen. Wenn die Remote-Anwendung keinen benutzerdefinierten Ereignis-Listener für das gesendete Ereignis hat, wird ein vom universal-editor-cors -Paket bereitgestellter Fallback-Ereignis-Listener ausgeführt.

Alle Ereignisse werden auf dem betroffenen DOM-Element der Remote-Seite aufgerufen. Ereignisse werden an das Element BODY übergeben, in dem der standardmäßige Ereignis-Listener, der vom universal-editor-cors -Paket bereitgestellt wird, registriert ist. Es gibt Ereignisse für den Inhalt und die Ereignisse für die Benutzeroberfläche.

Alle Ereignisse folgen einer Namenskonvention.

Beispiel: aue:content-update und aue:ui-select

Ereignisse umfassen die Payload der Anfrage und der Antwort und werden ausgelöst, sobald der entsprechende Aufruf erfolgreich war. Weitere Informationen zu Aufrufen und Beispielen für deren Payloads finden Sie im Dokument Universal Editor-Aufrufe.

Inhaltsaktualisierungsereignisse content-events

aue:content-add content-add

Das aue:content-add -Ereignis wird ausgelöst, wenn einem Container eine neue Komponente hinzugefügt wird.

Die Payload ist Inhalt vom Universal Editor-Dienst mit Fallback-Inhalt aus der Komponentendefinition.

{
    details: {
        request: request payload;   // what is sent to the service
        response: {                 // what is returned by the service
            resource: string;       // newly created content resource
            updates: [{
                resource: string;   // resource to update
                type: string;       // type of instrumentation
                content?: string;   // content to replace
            }]
        }
    }
}

aue:content-details content-details

Das aue:content-details -Ereignis wird ausgelöst, wenn eine Komponente in der Eigenschaftenleiste geladen wird.

Die Payload ist der Inhalt der Komponente und optional ihr Schema.

{
    details: {
        content: object             // content object
        model: [object]             // model object
        request: request payload;   // what is sent to the service
        response: response payload; // what is returned by the service
    }
}

aue:content-move content-move

Das aue:content-move -Ereignis wird ausgelöst, wenn eine Komponente verschoben wird.

Die Payload ist der Komponenten-, Quell-Container- und Ziel-Container.

{
    details: {
        from: string;                   // container we move the component from
        component: string;              // component we move
        to: string;                     // container we move the component to
        before: string;                    // before which component shall we place the component
        request: request payload;       // what is sent to the service
        response: response payload;     // what is returned by the service
    }
}

aue:content-patch content-patch

Das Ereignis aue:content-patch wird ausgelöst, wenn die Daten einer Komponente in der Eigenschaftenleiste aktualisiert werden.

Die Payload ist ein JSON-Patch der aktualisierten Eigenschaften.

{
    details: {
        patch: {
            name: string;               // attribute which is updated
            value: string;              // new value which is stored to the attribute
        },
        request: request payload;       // what is sent to the service
        response: response payload;     // what is returned by the service
    }
}

aue:content-remove content-remove

Das aue:content-remove -Ereignis wird ausgelöst, wenn eine Komponente aus einem Container entfernt wird.

Die Payload ist die Element-ID der entfernten Komponente.

{
    details: {
        resource: string;               // the resource which got removed
        request: request payload;       // what is sent to the service
        response: response payload;     // what is returned by the service
    }
}

aue:content-update content-update

Das aue:content-update -Ereignis wird ausgelöst, wenn die Eigenschaften einer Komponente im Kontext aktualisiert werden.

Die Payload ist der aktualisierte Wert.

{
    details: {
        value: string;                  // updated value
        request: request payload;       // what is sent to the service
        response: response payload;     // what is returned by the service
    }
}

Weitergeben von Payloads passing-payloads

Bei allen Inhaltsupdate-Ereignissen werden die angeforderte Payload sowie die Antwort-Payload an das Ereignis übergeben. Beispiel für einen Aktualisierungsaufruf:

Anfrage-Payload:

{
  "connections": [
    {
      "name": "aemconnection",
      "protocol": "aem",
      "uri": "https://author-p7452-e12433.adobeaemcloud.com"
    }
  ],
  "target": {
    "resource": "urn:aemconnection:/content/dam/wknd-shared/en/magazine/arctic-surfing/aloha-spirits-in-northern-norway/jcr:content/data/master",
    "type": "text",
    "prop": "title"
  },
  "value": "Alhoa Spirit Northern Norway!"
}

Antwort-Payload

{
    "updates": [
        {
            "resource": "urn:aemconnection:/content/dam/wknd-shared/en/magazine/arctic-surfing/aloha-spirits-in-northern-norway/jcr:content/data/master",
            "prop": "title",
            "type": "text"
        }
    ]
}

Benutzeroberflächen-Ereignisse ui-events

aue:ui-publish ui-publish

Das aue:ui-publish -Ereignis wird ausgelöst, wenn der Inhalt veröffentlicht wird (mit Aufruf auf BODY -Ebene).

Die Payload ist eine Liste von Element-IDs und ihrem Veröffentlichungsstatus.

aue:ui-select ui-select

Das aue:ui-select -Ereignis wird ausgelöst, wenn eine Komponente ausgewählt wird.

Die Payload ist die Element-ID, Elementeigenschaften und Elementtyp der ausgewählten Komponente.

{
    details: {
        resource: string;       // resource of the selected
        prop: string;           // prop of the selected
        type: string;           // type of the selected
        selected: boolean;      // was selected or unselected
    }
}

aue:ui-preview ui-preview

Das Ereignis aue:ui-preview wird ausgelöst, wenn der Bearbeitungsmodus der Seite in Vorschau geändert wird.

Die Payload für dieses Ereignis ist leer.

{
    details: {}
}

aue:ui-edit ui-edit

Das Ereignis aue:ui-edit wird ausgelöst, wenn der Bearbeitungsmodus der Seite in Bearbeiten geändert wird.

Die Payload für dieses Ereignis ist leer.

{
    details: {}
}

aue:ui-viewport-change ui-viewport-change

Das aue:ui-viewport-change -Ereignis wird ausgelöst, wenn die Darstellungsfeldgröße geändert wird.

Die Nutzlast ist die Abmessungen des Viewports.

{
    details: {
        height: number?;        // height of the viewport. Undefined when fullscreen
        width: number?;         // width of the viewport. Undefined when fullscreen
    }
}

aue:initialized initialized

Das aue:initialized -Ereignis wird ausgelöst, um der Remote-Seite mitzuteilen, dass sie erfolgreich im universellen Editor geladen wurde.

Die Payload für dieses Ereignis ist leer.

{
    details: {}
}

Fallback-Ereignis-Listener fallback-listeners

Inhaltsaktualisierungen content-update-fallbacks

Benutzeroberflächen-Ereignisse ui-event-fallbacks

Zusätzliche Ressourcen additional-resources