Universella redigeringshändelser events

Lär dig mer om de olika händelser som den universella redigeraren skickar och som du kan använda för att reagera på innehåll eller användargränssnittsändringar i din fjärrapp.

Introduktion introduction

Program kan ha olika krav för sid- och komponentuppdateringar. Därför skickar den universella redigeraren definierade händelser till fjärrprogram. Om fjärrprogrammet inte har någon anpassad händelseavlyssnare för den skickade händelsen körs en fallback-händelseavlyssnare som tillhandahålls av paketet universal-editor-cors.

Alla händelser anropas på det DOM-element som påverkas på fjärrsidan. Händelser bubblar upp till elementet BODY där standardhändelseavlyssnaren som tillhandahålls av paketet universal-editor-cors är registrerad. Det finns händelser för innehållet och händelserna för användargränssnittet.

Alla händelser följer en namngivningskonvention.

Till exempel aue:content-update och aue:ui-select

Händelser inkluderar nyttolasten för begäran och svaret och aktiveras när motsvarande anrop lyckas. Mer information om samtal och exempel på deras nyttolaster finns i dokumentet Universal Editor Call.

Händelser för innehållsuppdatering content-events

aue:content-add content-add

Händelsen aue:content-add utlöses när en ny komponent läggs till i en behållare.

Nyttolasten är innehåll från Universal Editor, med reservinnehåll från komponentdefinitionen.

{
    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

Händelsen aue:content-details utlöses när en komponent läses in i egenskapsfältet.

Nyttolasten är komponentens innehåll och eventuellt dess 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

Händelsen aue:content-move utlöses när en komponent flyttas.

Nyttolasten är komponenten, källbehållaren och målbehållaren.

{
    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

Händelsen aue:content-patch utlöses när en komponents data uppdateras i egenskapsfältet.

Nyttolasten är en JSON-korrigering av de uppdaterade egenskaperna.

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

ljud:content-remove content-remove

Händelsen aue:content-remove aktiveras när en komponent tas bort från en behållare.

Nyttolasten är objekt-ID för den borttagna komponenten.

{
    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

Händelsen aue:content-update aktiveras när egenskaperna för en komponent uppdateras i sitt sammanhang.

Nyttolasten är det uppdaterade värdet.

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

Passing Payloads passing-payloads

För alla innehållsuppdateringshändelser skickas den begärda nyttolasten samt svarsnyttolasten till händelsen. Till exempel för ett uppdateringssamtal:

Begär nyttolast:

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

Svarsnyttolast

{
    "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-händelser ui-events

aue:ui-publish ui-publish

Händelsen aue:ui-publish aktiveras när innehåll publiceras (med anrop på BODY-nivå).

Nyttolasten är en lista över artikel-ID:n och deras publiceringsstatus.

aue:ui-select ui-select

Händelsen aue:ui-select utlöses när en komponent väljs.

Nyttolasten är objekt-ID, objektegenskaper och objekttyp för den valda komponenten.

{
    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

Händelsen aue:ui-preview aktiveras när sidans redigeringsläge ändras till Förhandsgranska.

Nyttolasten är tom för den här händelsen.

{
    details: {}
}

aue:ui-edit ui-edit

Händelsen aue:ui-edit aktiveras när sidans redigeringsläge ändras till Redigera.

Nyttolasten är tom för den här händelsen.

{
    details: {}
}

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

Händelsen aue:ui-viewport-change aktiveras när visningsrutans storlek ändras.

Nyttolasten är vyportens dimensioner.

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

aue:initierad initialized

Händelsen aue:initialized aktiveras för att fjärrsidan ska kunna känna till att den har lästs in i Universell redigerare.

Nyttolasten är tom för den här händelsen.

{
    details: {}
}

Händelseavlyssnare för reserv fallback-listeners

Innehållsuppdateringar content-update-fallbacks

UI-händelser ui-event-fallbacks

Ytterligare resurser additional-resources