Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRelativityFormsEnvelope

A data object used to communicate with Relativity Forms

Hierarchy

  • IRelativityFormsEnvelope

Index

Properties

Properties

Optional dispatchEvent

dispatchEvent: function

Relativity Forms dispatches their events this method

Type declaration

    • (event: Event): void

    • Parameters

      • event: Event

      Returns void

Optional getPreloadObjectIds

getPreloadObjectIds: function

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.

Type declaration

    • (): number[]

    • Returns number[]

Optional modal

modal: IRelativityFormsEnvelopeModal

Modal actions to listen for

Optional navigate

navigate: function

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

Type declaration

    • (paylod: any, defaultNavigation: any): void

    • Parameters

      • paylod: any
      • defaultNavigation: any

      Returns void

Optional setConvenienceApi

setConvenienceApi: function

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

Type declaration

Optional settings

settings: IRelativityFormsEnvelopeSettings

Settings that help configure the Relativity Form