Interface: IRelativityFormsEnvelope

A data object used to communicate with Relativity Forms

Properties

dispatchEvent()?

optionaldispatchEvent: (event) => void

Relativity Forms dispatches their events this method

Parameters

• event: Event

Returns

void

---

getPreloadObjectIds()?

optionalgetPreloadObjectIds: () => number[]

A function which returns the artifact ID of the next document in the queue, or empty if the current document is the last in the queue.

Returns

number[]

---

modal?

optionalmodal: IRelativityFormsEnvelopeModal

Modal actions to listen for

---

navigate()?

optionalnavigate: (paylod, defaultNavigation) => void

A function which calls Relativity Internal's navigation function to navigate Hydro to other places when actions inside of the Coding Pane require it. For example, if a Single Object Field with a value is shown in read only mode, and links are enabled. More detail here: https://jira.kcura.com/browse/HYDRO-8984

Parameters

• paylod: any

• defaultNavigation: any

Returns

void

---

setConvenienceApi()?

optionalsetConvenienceApi: (convenienceAPI) => void

Relativity Forms passes the convenience api correlated to this envelope via this method

Parameters

• convenienceAPI: IRelativityFormsConvenienceAPI

Returns

void

---

settings?

optionalsettings: IRelativityFormsEnvelopeSettings

Settings that help configure the Relativity Form