FlowStarterPosition

Represents a workflow step for managing the starting position of a flow, with various timeout and notification options.

Properties

Name	Description
TimeoutOptions	Timeout options for managing delays and expiration settings for the starter position.
Caption	The caption dictionary representing localized captions for the flow object.
EnablePushNotification	Gets or sets a value indicating whether push notification is enabled.
ShowInFlowHistory	Specifies if the position should appear in the workflow history.
HideApporoverInHistory	Determines whether the approver should be hidden in the workflow history.
TimeoutHour	The number of hours specified for the timeout duration.
GeolocationOptions	Geolocation options associated with the starter position.
Id	The unique identifier of the starter position.
NotificationMessage	Gets the notification message associated with the message.
EventsToCheck	A list of events that need to be monitored for the starter position.
MailSubject	Gets the mail subject associated with the message.
Key	A unique identifier for the workflow step.
AutoOpenApprovalOption	Indicates if approval options should automatically open for this position.
TimeoutMinute	The number of minutes specified for the timeout duration.
Code	The code or username associated with the starter position.
Name	Name for the workflow step.
EnableSendMail	Gets or sets a value indicating whether sending mail is enabled.
Events	A read-only list of events linked to the starter position.
MailMessage	Gets the mail message associated with the message.
TimeoutDuration	The total timeout duration represented as a TimeSpan.
IsCustomMailMessage	Gets or sets a value indicating whether the mail message is custom.
CustomMailMessage	Gets the custom mail message associated with the message.
MessageOptions	Gets or sets the message options.
RequestIsNecessaryIfDocumentChanged	Specifies if a request is required when the associated document is modified.
Email	The email address of the user in the starter position.
Description	A description of the starter position, typically the full name of the user.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
Documents	A list of documents associated with the starter position.
CachedDMObjects	The cached document management objects related to the flow object.
WebNotificationOptions	Gets or sets the web notification options.
NotificationCaption	Gets the notification caption associated with the message.
Attachments	Gets the list of attachments associated with the message.
TypeCode	The type code associated with the flow object.
DoNotSendRequestIfProcessed	Indicates whether requests should be avoided if already processed.
CalculateUsingHolidays	Specifies if holidays should be considered in timeout calculations.
TimeoutDay	The number of days specified for the timeout duration.
CalculateUsingWorkingHours	Determines if working hours should be used in timeout calculations.
NotificationOptions	Gets or sets the push notification options.

Constructors

Name	Description
FlowStarterPosition(name, workflowData, workflowCodeInstance)	Constructor for the FlowStarterPosition class. Initializes a new instance of the FlowStarterPosition class.
FlowStarterPosition(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowStarterPosition class with a name, workflow data, and workflow code instance.
FlowStarterPosition(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowStarterPosition class.

Methods

Name	Description
SendWebNotification(payloadType,userInfo,requestItem)	Sends a web notification to a user.
GetStarterUserInfo()	Retrieves the user information for the starter position.
SendMail(requestItem)	Sends an email notification for the process request associated with the starter position.
Initialize()	Initializes the starter position with default settings.
ToLiquid()	Converts the starter position data into a format compatible with Liquid templates.
AddAttachment(value,type)	Adds an attachment to the mail message.
SendPushNotification(userInfo,requestItem)	Sends a push notification to a user.

Events

Name	Description
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.
OnAfterEvent(sender, args)	Occurs after the execution of the workflow step.
OnBeforeEvent(sender, args)	Occurs after the execution of the workflow step.
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.