Umbraco Workflow uses Notifications to allow you to hook into the processes for the backoffice. For example, you might want to execute some code every time an approval group is updated. Notifications allow you to do that. For more information on how Umbraco implements Notifications, see the Using Notifications article.
All notifications reside in the Umbraco.Workflow.Core.Notifications
namespace and are postfixed with Notification
.
Typically, available notifications exist in pairs, with a "before" and "after" notification. For example, the SettingsService
class publishes both a WorkflowSettingsSavingNotification
and a WorkflowSettingsSavedNotification
when settings are modified.
Which one you want to use depends on what you want to achieve. If you want to cancel the action, you will use the "before" notification and use the CancelOperation method on the notification to cancel it. If you want to execute some code after the settings have been updated, then you would use the "after" notification.
Notification | Members | Description |
---|---|---|
WorkflowContentReviewsConfigSavingNotification |
|
Published when ContentReviewService.SaveContentReviewConfig is called in the API. |
WorkflowContentReviewsConfigSavedNotification |
|
Published when ContentReviewService.SaveContentReviewConfig is called in the API after the entities have been saved. |
WorkflowContentReviewsEmailNotificationsSendingNotification |
|
Published when ContentReviewReminderEmailer.SendReviewReminders is called in the API before email notifications are sent. |
WorkflowContentReviewsEmailNotificationsSentNotification |
|
Published when ContentReviewReminderEmailer.SendReviewReminders is called in the API after email notifications are sent. |
WorkflowContentReviewsReviewingNotification |
|
Published when ContentReviewService.MarkAsReviewed is called in the API before the node review status is updated. |
WorkflowContentReviewsReviewedNotification |
|
Published when ContentReviewService.MarkAsReviewed is called in the API after the node review status is updated. |
Notification | Members | Description |
---|---|---|
WorkflowContentTypeConfigDeletingNotification |
|
Published when ConfigService.DeleteContentTypeConfig is called in the API before the config items are deleted. |
WorkflowContentTypeConfigDeletedNotification |
|
Published when ConfigService.DeleteContentTypeConfig is called in the API after the config items are deleted. |
WorkflowContentTypeConfigSavingNotification |
|
Published when ConfigService.UpdateContentTypeConfig is called in the API. |
WorkflowContentTypeConfigSavedNotification |
|
Published when ConfigService.UpdateContentTypeConfig is called in the API after the entities have been saved. |
WorkflowNodeConfigDeletingNotification |
|
Published when ConfigService.DeleteNodeConfig is called in the API before the config items are deleted. |
WorkflowNodeConfigDeletedNotification |
|
Published when ConfigService.DeleteNodeConfig is called in the API after the config items are deleted. |
WorkflowNodeConfigSavingNotification |
|
Published when ConfigService.UpdateNodeConfig is called in the API. |
WorkflowNodeConfigSavedNotification |
|
Published when ConfigService.UpdateNodeConfig is called in the API after the entities have been saved. |
Notification | Members | Description |
---|---|---|
WorkflowEmailNotificationsSendingNotification |
|
Published when NotificationsService.SendEmailNotifications is called in the API before email notifications are generated and sent. |
WorkflowEmailNotificationsSentNotification |
|
Published when WorkflowReminderEmailer.Send is called in the API after email notifications are sent. |
WorkflowEmailRemindersSendingNotification |
|
Published when NotificationsService.SendEmailReminders is called in the API before email notifications are generated and sent. |
WorkflowEmailRemindersSentNotification |
|
Published when WorkflowReminderEmailer.Send is called in the API after email notifications are sent. |
Notification | Members | Description |
---|---|---|
WorkflowGroupCreatingNotification |
|
Published when GroupService.CreateUserGroupAsync is called in the API before the entity is created. |
WorkflowGroupCreatedNotification |
|
Published when GroupService.CreateUserGroupAsync is called in the API after the entity has been created. |
WorkflowGroupDeletingNotification |
|
Published when GroupService.DeleteUserGroupAsync is called in the API before the group is deleted. |
WorkflowGroupDeletedNotification |
|
Published when GroupService.DeleteUserGroupAsync is called in the API after the group is deleted. |
WorkflowGroupSavingNotification |
|
Published when GroupService.UpdateUserGroupAsync is called in the API before the group is updated. |
WorkflowGroupSavedNotification |
|
Published when GroupService.UpdateUserGroupAsync is called in the API after the group is updated. |
Notification | Members | Description |
---|---|---|
WorkflowInstanceApprovingNotification |
|
Published when WorkflowProcess.ActionWorkflow is called in the API before the workflow stage is approved. |
WorkflowInstanceApprovedNotification |
|
Published when WorkflowProcess.ActionWorkflow is called in the API after the workflow stage is approved. |
WorkflowInstanceCancellingNotification |
|
Published when WorkflowProcess.ActionWorkflow is called in the API before the workflow stage is cancelled. |
WorkflowInstanceCancelledNotification |
|
Published when WorkflowProcess.ActionWorkflow is called in the API after the workflow stage is cancelled. |
WorkflowInstanceCompletedNotification |
|
Published when WorkflowProcess.HandleCompleteNow or WorkflowProcess.HandleCompleteLater is called in the API after the workflow is completed. |
WorkflowInstanceCreatingNotification |
|
Published when WorkflowProcess.InitiateWorkflow is called in the API before the workflow is initiated. |
WorkflowInstanceCreatedNotification |
|
Published when WorkflowProcess.InitiateWorkflow is called in the API after the workflow is initiated. |
WorkflowInstanceRejectingNotification |
|
Published when WorkflowProcess.ActionWorkflow is called in the API before the workflow stage is rejected. |
WorkflowInstanceRejectedNotification |
|
Published when WorkflowProcess.ActionWorkflow is called in the API after the workflow stage is rejected. |
WorkflowInstanceResubmittingNotification |
|
Published when WorkflowProcess.ResubmitWorkflow is called in the API before the workflow stage is resubmitted. |
WorkflowInstanceResubmittedNotification |
|
Published when WorkflowProcess.ResubmitWorkflow is called in the API after the workflow stage is resubmitted. |
WorkflowInstanceUpdatingNotification |
|
Base notification class for Approving, Cancelling, Creating, Rejecting, Resubmitting. Can be used in place of these, using the Action value to identify the executed workflow action. |
WorkflowInstanceUpdatedNotification |
|
Base notification class for Approved, Cancelled, Created, Rejected, Resubmitted. Can be used in place of these, using the Action value to identify the executed workflow action. |
WorkflowResubmitTaskCreatingNotification |
|
Published when WorkflowProcess.ResubmitWorkflow is called in the API before the workflow task is persisted. |
WorkflowResubmitTaskCreatedNotification |
|
Published when WorkflowProcess.ResubmitWorkflow is called in the API after the workflow task is persisted. |
WorkflowTaskCreatingNotification |
|
Published when WorkflowTaskManager.CreateApprovalTask is called in the API before the workflow task is persisted. |
WorkflowTaskCreatedNotification |
|
Published when WorkflowTaskManager.CreateApprovalTask is called in the API after the workflow task is persisted. |
WorkflowTaskUpdatingNotification |
|
Published when WorkflowTaskManager.ResubmitWorkflow is called in the API before the workflow task is updated. |
WorkflowTaskUpdatedNotification |
|
Published when WorkflowTaskManager.ResubmitWorkflow is called in the API after the workflow task is updated. |
Notification | Members | Description |
---|---|---|
WorkflowSettingsSavingNotification |
|
Published when SettingsService.UpdateSettings is called in the API before the settings are saved. |
WorkflowSettingsSavedNotification |
|
Published when SettingsService.UpdateSettings SavedEntities: Gets the collection of saved ISettings objects. |