Includes methods for creating pop-up windows running the Relativity Forms API. These functions are available under the `convenienceApi.relativityFormsPopup` namespace.
Methods
- openAdd(config) ⇒
Object
- Open a Relativity Forms popup in add mode
- openEdit(config) ⇒
Object
- Open a Relativity Forms popup in edit mode
- openView(config) ⇒
Object
- Open a Relativity Forms popup in view mode
Properties Details
openAdd(config) ⇒ Object
Open a Relativity Forms popup in add mode
Returns: Object
- a popupControlApi object
Param |
Type |
Description |
config |
Object
|
Relativity Forms popup configuration object |
config.workspaceId |
Number
|
ID of the workspace |
config.artifactTypeId |
Number
|
artifact type ID of the object |
config.parentArtifactId |
Number
|
parent artifact ID of the object |
config.associatedArtifactId |
Number | undefined |
Associate artifact ID of the object. |
config.connectorFieldArtifactId |
Number | String | undefined |
Connector field artifact ID of the object. |
config.layoutId |
Number
|
artifact ID of the layout to use in the form |
config.eventHandlerFactory |
function
|
function for creating event handlers within the popup |
openEdit(config) ⇒ Object
Open a Relativity Forms popup in edit mode
Returns: Object
- a popupControlApi object
Param |
Type |
Description |
config |
Object
|
Relativity Forms popup configuration object |
config.workspaceId |
Number
|
ID of the workspace |
config.artifactTypeId |
Number
|
artifact type ID of the object |
config.artifactId |
Number
|
artifact ID of the object |
config.layoutId |
Number
|
artifact ID of the layout to use in the form |
config.eventHandlerFactory |
function
|
function for creating event handlers within the popup |
openView(config) ⇒ Object
Open a Relativity Forms popup in view mode
Returns: Object
- a popupControlApi object
Param |
Type |
Description |
config |
Object
|
Relativity Forms popup configuration object |
config.workspaceId |
Number
|
ID of the workspace |
config.artifactTypeId |
Number
|
artifact type ID of the object |
config.artifactId |
Number
|
artifact ID of the object |
config.layoutId |
Number
|
artifact ID of the layout to use in the form |
config.eventHandlerFactory |
function
|
function for creating event handlers within the popup |