Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
iconfalse

{

       type: XXX"eventType"

       originIddata: YYY{}

       data:{}originId: "originName"

}

SDC generated events

Name

Type

When

Data

UI state

Description

Window out

WINDOW_OUT

Before SDC closes plugin,

The event is sent on all events below except VERSION_CHANGE and check out

none

Moves out of the plugin scope

The event is posted by SDC once the plugin window is going to be closed because of user action.

Version change

VERSION_CHANGE

After SDC retrieves item

New item version and UUID

The plugin is displayed on screen.

The event is posted by SDC once context version is changed by the user.

Check in

CHECK_IN

Before SDC closes plugin

none

SDC opens the catalog.

The event is posted by SDC once the context is being checked by the user.

Check out

CHECK_OUT

After SDC successful checkout the item

New item version and UUID

The plugin is displayed on screen.

The event is posted by SDC once the context is being check out by the user.

Submit for testing

SUBMIT_FOR_TESTING

Before submitting for testing is executed

none

SDC opens the catalog.

The event is posted by SDC once the context is being submitted for testing by the user.

Undo check out

UNDO_CHECK_OUT

After SDC executed the undo check out.

item version and UUID

SDC opens the catalog.

The event is posted by SDC once the context is being undone by the user.

Window out event example


Info
iconfalse

{

    type: "WINDOW_OUT"

    data:

    originoriginId: "sdc-hub"

    data:

}


 

Version change event example


Info
iconfalse

{

    type: "VERSION_CHANGE    origin: "sdc-hub"

    data: {

         uuid: a21af8a1daa948f78e30f9b269a253ba ,

         version:1.1

    }

    originId: "sdc-hub"

}

Check in event example


Info
iconfalse

{

    type: "CHECK_IN"

    origindata:

originId: "sdc-hub"

    data:

}

Submit for testing event example


Info
iconfalse

{

type: "SUBMIT_FOR_TESTING"

data:

originoriginId: "sdc-hub"

data:

}


Undo check out event example

Info
iconfalse

{

    type: SUBMIT_FOR_TESTING    origin: "sdc-hub"CHECK_OUT"

    data: {

         uuid: a21af8a1daa948f78e30f9b269a253ba ,

         version:1.1

    }

    originId: "sdc-hub"

}



Designer events

Name

Type

Description

Ready

READY

The event is posted by the plugin once it is ready.

Action completed

ACTION_COMPLETED

The event is sent by the plugin after receiving an event from SDC that the plugin added to the eventsToWait list in order to notify SDC to continue with its flow.

...

Info
iconfalse

{

    type: READY

    origindata:

originId: "pluginName"

    data:

}


Action completed event example

...

Info
iconfalse

{

    type: ACTION_COMPLETED

    origindata:

originId: "pluginName"    data:

}


Security TBD

Need to add solution for the iframe authorization and authentication.

...