cabrillo.flowControl - Client

Cabrillo JS functions for managing the flow of a web view.

cabrillo.flowControl - flowEnded(String flowName)

Indicates to the client that the web flow is complete.

The mobile client can then take appropriate action, which typically is to close the web view.

Table 1. Parameters

Name	Type	Description
flowName	String	Optional. The name of the web flow to close.

Table 2. Returns

Type	Description
None

var flowName = 'Open Incident Flow';
cabrillo.flowControl.flowEnded(flowName);

cabrillo.flowControl - flowEndedWithUpdate(String flowName, boolean clientRefreshNeeded)

Indicates to the client that the web flow is complete and the client should update the native screens.

The mobile client can then take appropriate action, which typically is to close the web view.

Table 3. Parameters

Name	Type	Description
flowName	String	Optional. The name of the web flow to close.
clientRefreshNeeded	Boolean	Optional. Flag that indicates whether the client needs to refresh the displayed data. Valid values: true: The client needs to refresh the displayed data. false: The client doesn't need to refresh the displayed data. Default: false

Table 4. Returns

Type	Description
None

var flowName = 'Open Incident Flow';
var clientRefreshNeeded = true;
cabrillo.flowControl.flowEnded(flowName, clientRefreshNeeded);