Skip to content

Interface: IClientAPIProps

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

Hierarchy

  • IClientAPIProps

Summary

Properties

Properties

Optional actionBinding

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.


Optional appEventData

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


Optional bindingProperty

bindingProperty? : string

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


Optional cancelPendingActions

cancelPendingActions? : boolean

Whether the pending actions should be cancelled.


Optional contextItem

contextItem? : ContextItem


Optional eventSource

eventSource? : ExecuteSource

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


Optional filter

filter? : IFilterable

The filter deifinition for the filter modal page


Optional missingRequiredControls

missingRequiredControls? : Array‹any›

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


Optional newControlValue

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.


Optional pressedItem

pressedItem? : PressedItem

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