Universal Editor-gebeurtenissen events

Leer over de verschillende gebeurtenissen die de Universele Redacteur verzendt die u kunt gebruiken om op inhoud of veranderingen UI in uw verre app te reageren.

Inleiding introduction

Toepassingen kunnen verschillende vereisten hebben voor pagina- of componentupdates. Daarom verzendt de Universele Redacteur bepaalde gebeurtenissen naar verre toepassingen. In het geval dat de verre toepassing geen luisteraar van de douanegebeurtenis voor de verzonden gebeurtenis heeft, wordt de luisteraar van de a ​ fallback gebeurtenis ​ verstrekt door het universal-editor-cors pakket uitgevoerd.

Alle gebeurtenissen worden aangeroepen op het betrokken DOM-element van de externe pagina. Gebeurtenissen beluisteren omhoog naar het element BODY waar de standaardgebeurtenislistener die door het universal-editor-cors -pakket wordt geboden, wordt geregistreerd. Er zijn gebeurtenissen voor de inhoud en de gebeurtenissen voor UI.

Alle gebeurtenissen volgen een naamgevingsconventie.

aue:content-update en aue:ui-select

De gebeurtenissen omvatten de lading van het verzoek en van de reactie en worden teweeggebracht zodra de overeenkomstige vraag succesvol is. Voor verdere details over vraag en voorbeelden van hun ladingen, gelieve te zien de de Universele Vraag van de Redacteur van het document 🔗.

Gebeurtenissen voor bijwerken van inhoud content-events

aue :content-add content-add

De gebeurtenis aue:content-add wordt geactiveerd wanneer een nieuwe component aan een container wordt toegevoegd.

De nuttige lading is inhoud van de Universele dienst van de Redacteur, met reserveinhoud van de componentendefinitie.

{
    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

De gebeurtenis aue:content-details wordt geactiveerd wanneer een component in het deelvenster Eigenschappen wordt geladen.

De nuttige lading is de inhoud van de component en naar keuze zijn 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

De gebeurtenis aue:content-move wordt geactiveerd wanneer een component wordt verplaatst.

De nuttige lading is de component, broncontainer, en doelcontainer.

{
    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

De gebeurtenis aue:content-patch wordt geactiveerd wanneer de gegevens van een component worden bijgewerkt in het deelvenster Eigenschappen.

De payload is een JSON-patch van de bijgewerkte eigenschappen.

{
    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

De gebeurtenis aue:content-remove wordt geactiveerd wanneer een component uit een container wordt verwijderd.

De lading is item-id van de verwijderde component.

{
    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

De gebeurtenis aue:content-update wordt geactiveerd wanneer de eigenschappen van een component in de context worden bijgewerkt.

De payload is de bijgewerkte waarde.

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

Payloads passeren passing-payloads

Voor alle update-gebeurtenissen voor de inhoud worden zowel de gevraagde payload als de antwoordlading aan de gebeurtenis doorgegeven. Bijvoorbeeld voor een updateoproep:

Payload aanvragen:

{
  "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!"
}

Respons 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"
        }
    ]
}

UI-gebeurtenissen ui-events

aue :ui-preview ui-preview

De aue:ui-preview gebeurtenis wordt teweeggebracht wanneer de het uitgeven wijze van de pagina in Voorproef wordt veranderd.

De payload is leeg voor deze gebeurtenis.

{
    details: {}
}

aue :ui-edit ui-edit

De aue:ui-edit gebeurtenis wordt teweeggebracht wanneer de het uitgeven wijze van de pagina wordt veranderd in geeft uit.

De payload is leeg voor deze gebeurtenis.

{
    details: {}
}

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

De gebeurtenis aue:ui-viewport-change wordt geactiveerd wanneer de grootte van de viewport wordt gewijzigd.

De nuttige lading is de afmetingen van viewport.

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

aue :initialized initialized

De gebeurtenis aue:initialized wordt geactiveerd om de externe pagina te laten weten dat deze is geladen in de Universal Editor.

De payload is leeg voor deze gebeurtenis.

{
    details: {}
}

Alternatieve gebeurtenislisteners fallback-listeners

Updates van inhoud content-update-fallbacks

UI-gebeurtenissen ui-event-fallbacks

Aanvullende bronnen additional-resources