Skip to content

Interface: IClientAPIProps

Predefinied properties that can be interacted with in rules via a ClientAPI object.

Summary

Properties

Class Properties

Inherited Properties

Currently none inherited from the parent class(es).

Methods

Class Methods

Currently none in this class.

Inherited Methods

Currently none inherited from the parent class(es).

Properties

actionBinding?

optional actionBinding?: any

the binding to be used by the current action. For example, a navigation action would set this to pass on the binding for the next page which is navigated to.

appEventData?

optional appEventData?: any

Get the data which provides additional information about an app event such as an app launch or exit, if such an event just occurred.

bindingProperty?

optional bindingProperty?: string

the property name being bound, one of the property names in a section definition

cancelPendingActions?

optional cancelPendingActions?: boolean

Whether the pending actions should be cancelled.

contextItem?

optional contextItem?: ContextItem

eventData?

optional eventData?: any

Gets additional information about an event that’s triggered, if such an event just occurred. This property is only populated when ClientAPI is an event; otherwise, it returns null. Always check if this property returns a null before using it.

eventSource?

optional eventSource?: ExecuteSource

The source of control, toolbar item or action bar item that was most recently pressed on this page.

filter?

optional filter?: IFilterable

The filter deifinition for the filter modal page

missingRequiredControls?

optional missingRequiredControls?: any[]

After running a CheckRequiredFields action, this property holds a list of any controls whose value was found to be missing when required.

newControlValue?

optional newControlValue?: any

This property holds the new value of a control, if the value is from a rule, it chnages to the new result from the rule.

pressedItem?

optional pressedItem?: PressedItem

The control, toolbar item or action bar item that was most recently pressed on this page.

pressedItemOverride?

optional pressedItemOverride?: PressedItem

The override for control, toolbar item or action bar item that was most recently pressed on this page.

pressedItemPosition?

optional pressedItemPosition?: string

The control, toolbar item or action bar item that was most recently pressed on this page.