...
Param | Description |
userId | The id of the user logged into SDC. |
userRole | The role of the connected user, options ADMIN, DESIGNER, TESTER, OPS, GOVERNOR. |
displayType | The type of view the plugin is opened in tab/context. |
contextType | The type of the context where the plugin is opened: VF/CP/VL/VFC/SERVICE |
uuid | Unique id of the context the designer plugin is opened in. |
lifecycleState | The state the context /resource or service are currently in: CERTIFIED/ NOT_CERTIFIED_CHECKIN/ NOT_CERTIFIED_CHECKOUT; |
isOwner | A Boolean value describing if the logged user is the owner/lastUpdator of the resource/service. |
version | The version of the item displayed. |
parentUrl | The URL of the SDC the plugin is opened in. used to subscribe to the event bus in SDC. |
eventsClientId | The name with which the plugin needs to register with to the event bus. |
...
| Info | ||
|---|---|---|
| ||
{ type: "CHECK_IN" data: originId: "sdc-hub" } |
Check out event example
| Info | ||
|---|---|---|
| ||
{ type: "_CHECK_OUT" data: { uuid: a21af8a1daa948f78e30f9b269a253ba , version:1.1 } originId: "sdc-hub" } |
Submit for testing event example
...
| Info | ||
|---|---|---|
| ||
{ type: "UNDO_CHECK_OUT" data: { uuid: a21af8a1daa948f78e30f9b269a253ba , version:1.1 } originId: "sdc-hub" } |
...
Ready event example
| Info | ||
|---|---|---|
| ||
{ type: "READY" data: originId: "pluginName" } |
...
Action completed event example
| Info | ||
|---|---|---|
| ||
{ type: "ACTION_COMPLETED" data: originId: "pluginName" } |
...
more information in the Appendix.