FlowPushNotification
Represents a workflow step for managing push notifications, including settings and delivery logic.
Properties
| Name | Description |
|---|---|
| Caption | The caption dictionary representing localized captions for the flow object. |
| Key | A unique identifier for the workflow step. |
| Name | Name for the workflow step. |
| Subject | The multilanguage subject of the push notification. |
| IsEnabled | Determines whether push notifications are enabled for this step. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| Message | The multilanguage message body of the push notification. |
| TypeCode | The type code associated with the flow object. |
| Users | A list of resolved users who will receive the notification. |
| Members | The configuration for members who will receive the push notification. |
Constructors
| Name | Description |
|---|---|
| FlowPushNotification(name, workflowData, workflowCodeInstance) | Constructor for the FlowPushNotification class. Initializes a new instance of the FlowPushNotification class. |
| FlowPushNotification(name, workflowData, workflowCodeInstance) | Initializes a new instance of the FlowPushNotification class with a name, workflow data, and workflow code instance. |
Methods
| Name | Description |
|---|---|
| SendPushNotification(userInfo, requestItem) | Sends a push notification to a specified user based on a process request item. |
| AddConstantPosition(id) | Adds a position to the push notification's recipient list using its ID. |
| ClearMembers() | Clears all members from the push notification's recipient configuration. |
| AddConstantUser(id) | Adds a user to the push notification's recipient list using their ID. |
| AddConstantPosition(id, code, description) | Adds a position to the push notification's recipient list using its ID, code, and description. |
| Initialize() | Initializes the push notification step with default settings. |
| AddConstantUser(id, code, name) | Adds a user to the push notification's recipient list using their ID, code, and name. |
Events
| Name | Description |
|---|---|
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |