FlowStarterPosition Methods
An object defining methods for the FlowStarterPosition class.
SendWebNotification(payloadType,userInfo,requestItem)
Sends a web notification to a user.
Parameters:
payloadType (required): MessagePayloadType
The type of the web notification payload.
userInfo (required): UserInfo
The user to whom the web notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
GetStarterUserInfo()
Retrieves the user information for the starter position.
Returns:
Type: UserInfo
Returns the user information for the starter position.
This is a sync method. Method runs synchronously.
SendMail(requestItem)
Sends an email notification for the process request associated with the starter position.
Parameters:
requestItem (required): ProcessRequestItem
The process request item triggering the email notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
Initialize()
Initializes the starter position with default settings.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
ToLiquid()
Converts the starter position data into a format compatible with Liquid templates.
Returns:
Type: object
Returns the starter position data as an object.
This is a sync method. Method runs synchronously.
AddAttachment(value,type)
Adds an attachment to the mail message.
Parameters:
value (required): string
Value of the attachment.
type (required): MailAttachmentType
Type of the attachment.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SendPushNotification(userInfo,requestItem)
Sends a push notification to a user.
Parameters:
userInfo (required): UserInfo
The user to whom the push notification will be sent.
requestItem (required): ProcessRequestItem
The process request item associated with the notification.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.