Skip to main content

FlowObjectHasMessageOptions

Defines a base class with messaging options, allowing integration of mail, push notifications, and web notifications within workflow steps.

Properties

NameDescription
MessageOptionsGets or sets the message options.
NotificationOptionsGets or sets the push notification options.
KeyA unique identifier for the workflow step.
MailMessageGets the mail message associated with the message.
WorkflowCodeInstanceThe workflow code instance associated with the flow object.
CachedDMObjectsThe cached document management objects related to the flow object.
NotificationCaptionGets the notification caption associated with the message.
NotificationMessageGets the notification message associated with the message.
IsCustomMailMessageGets or sets a value indicating whether the mail message is custom.
MailSubjectGets the mail subject associated with the message.
EnableSendMailGets or sets a value indicating whether sending mail is enabled.
TypeCodeThe type code associated with the flow object.
AttachmentsGets the list of attachments associated with the message.
WebNotificationOptionsGets or sets the web notification options.
NameName for the workflow step.
EnablePushNotificationGets or sets a value indicating whether push notification is enabled.
CustomMailMessageGets the custom mail message associated with the message.
CaptionThe caption dictionary representing localized captions for the flow object.

Constructors

NameDescription
FlowObjectHasMessageOptions(name, workflowData, workflowCodeInstance)Constructor for the FlowObjectHasMessageOptions class. Initializes a new instance of the FlowObjectHasMessageOptions class.
FlowObjectHasMessageOptions(name,workflowData,workflowCodeInstance)Initializes a new instance of the FlowObjectHasMessageOptions class.

Methods

NameDescription
AddAttachment(value,type)Adds an attachment to the mail message.
SendPushNotification(userInfo,requestItem)Sends a push notification to a user.
SendWebNotification(payloadType,userInfo,requestItem)Sends a web notification to a user.

Events

NameDescription
OnBeforeExecution(sender, args)Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)Occurs after the execution of the workflow step.

Generic Types

NameDescription
TPropertiesGeneric type of properties.