Interface: ICodingCard

Class for the coding card

Extends

Properties

buttons

readonlybuttons: IRelativityFormsEnvelopeCustomButtonSettings[]

Returns all the registered buttons on the layout

cardActivated()?

optionalcardActivated: (api, card) => void

Called after the card is activated in a dock.

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

ICardInstance.cardActivated

cardCanDeactivate()?

optionalcardCanDeactivate: (api, card) => boolean

Called before the card deactivates to check if it is safe to do so

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

boolean

Inherited from

ICardInstance.cardCanDeactivate

cardDeactivated()?

optionalcardDeactivated: (api, card) => void

Called after the card is deactivated in a dock.

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

ICardInstance.cardDeactivated

cardError()?

optionalcardError: (api, card, err) => void

Called whenever an error occurs while managing the card

Parameters

• api: IReviewInterfaceApi

• card: ICard

• err: Error

Returns

void

Inherited from

ICardInstance.cardError

cardLoaded()?

optionalcardLoaded: (api, card, target) => void | Promise<void>

Called after the card content has loaded

Parameters

• api: IReviewInterfaceApi

• card: ICard

• target: HTMLElement

Returns

void | Promise<void>

Inherited from

ICardInstance.cardLoaded

cardLoadState()?

optionalcardLoadState: (api, card, saveData) => void

Called to restore the state of the card

Parameters

• api: IReviewInterfaceApi

• card: ICard

• saveData: ICardCustomState

Returns

void

Inherited from

ICardInstance.cardLoadState

cardMaximized()?

optionalcardMaximized: (api, card) => void

Called when the card is maximized

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

ICardInstance.cardMaximized

cardResized()?

optionalcardResized: (api, card) => void

Called when the card is resized

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

ICardInstance.cardResized

cardRestored()?

optionalcardRestored: (api, card) => void

Called when the card is no longer maximized

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void

Inherited from

ICardInstance.cardRestored

cardSaveState()?

optionalcardSaveState: (api, card) => ICardCustomState

Called to save the state of the card

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

ICardCustomState

Inherited from

ICardInstance.cardSaveState

cardUnloaded()?

optionalcardUnloaded: (api, card) => void | Promise<void>

Called before the card content is unloaded

Parameters

• api: IReviewInterfaceApi

• card: ICard

Returns

void | Promise<void>

Inherited from

ICardInstance.cardUnloaded

isEditMode

isEditMode: boolean

True if card is in Edit mode, false otherwise.

isLoaded

isLoaded: boolean

True if card is loaded, false otherwise.

Methods

addButton()

addButton(buttonToAdd): void

Adds a button to the layout toolbar

Parameters

• buttonToAdd: IRelativityFormsEnvelopeCustomButtonSettings

Returns

void

applyCopyFromPreviousAsync()

applyCopyFromPreviousAsync(): Promise<void>

Applies Copied Values to Coding Card Fields. Assumed SaveAndNextAsync is called to save fields.

Returns

Promise<void>

cancelAsync()

cancelAsync(): Promise<void>

Updates the Relativity Form to be in view mode

Returns

Promise<void>

editAsync()

editAsync(): Promise<void>

Updates the Relativity Form to be in edit mode

Returns

Promise<void>

getConvenienceAPI()

getConvenienceAPI(): IRelativityFormsConvenienceAPI

Gets the current reference to the coding card's Convenience API.

Returns

IRelativityFormsConvenienceAPI

getRelativityFormsEnvelope()

getRelativityFormsEnvelope(): IRelativityFormsEnvelope

Gets an envelope with settings and functions to call for Relativity Forms.

Returns

IRelativityFormsEnvelope

removeButton()

removeButton(buttonId): void

Removes a button from the layout toolbar

Parameters

• buttonId: string

Returns

void

saveAndBackAsync()

saveAndBackAsync(): Promise<boolean>

Saves the current state of the Relativity Forms fields and returns the user to the document list

Returns

Promise<boolean>

Returns whether the save and navigation was successful

saveAndNextAsync()

saveAndNextAsync(...rest): Promise<boolean>

Saves the current state of the Relativity Forms fields and navigates to the next document in the queue

Parameters

• ...rest: any[]

Returns

Promise<boolean>

Returns whether the save and navigation was successful

saveAsync()

saveAsync(stayInEditMode?): Promise<boolean>

Saves the current state of the Relativity Forms fields

Parameters

• stayInEditMode?: boolean

(optional) Whether to stay in edit mode after Relativity Forms save. Defaults to false

Returns

Promise<boolean>

Returns whether the save was successful