Skip to main content

FlowStarterProperties

Represents the properties specific to a flow starter, including timeout options, events, and notifications.

Properties

NameDescription
MessageOptionsOptions for customizing messages related to the flow starter.
NotificationOptionsOptions for configuring push notifications in the flow starter.
DoNotSendRequestIfProcessedPrevents sending the request if it has already been processed.
HideApporoverInHistoryIndicates whether the approver should be hidden in the flow history.
AutoOpenApprovalOptionDetermines if the approval options should open automatically.
GeolocationOptionsOptions for geolocation settings in the flow starter.
EventButtonGroupIndicates whether event buttons should be grouped.
IsChangedIndicates whether any changes have been made to the workflow object in the code, showing if it has unsaved modifications.
EventsToCheckA list of events that should be checked by the flow starter.
RequestIsNecessaryIfDocumentChangedIndicates if a request is necessary when the document has been modified.
WebNotificationOptionsOptions for configuring web notifications in the flow starter.
TimeoutOptionsOptions related to the timeout behavior of the flow starter.
DocumentsA list of documents associated with the flow starter.
EventsA list of events related to the flow starter.
EventButtonsAlignmentSpecifies the alignment of event buttons.
ShowInFlowHistoryIndicates whether the flow starter should appear in the flow history.
CaptionA dictionary containing captions for workflow objects, mapping identifiers to their display names.

Constructors

NameDescription
FlowStarterProperties()Initializes a new instance of the FlowStarterProperties class.

Methods

NameDescription
ToLiquid()Converts the FlowStarterProperties object to a liquid-compatible format.