NotificationRule

Struct for a single notification rule.

Full name	`MFiles.NotificationRule`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`id`	`int32`	1	The ID of the rule. Assigned by the server when the rule is created.
`name`	`string`	2	The name of the notification rule.
`object_filter`	repeated `SearchCondition`	3	The search conditions that an object must meet for the rule to apply, combined with AND. The built-in rules include a "not deleted" condition (`STATUS_TYPE_IS_DELETED` equal to false).
`subscriptions`	repeated `EventSubscription`	4	The events that trigger a notification. A single `EVENT_TYPE_OBJECT_NOTIFICATION` subscription makes the rule filter-based: it then notifies about the objects that match `object_filter`.
`options`	`NOTIFICATIONFLAGS`	5	`is_enabled` turns the rule on, `send_digest` combines the day's notifications into one message, `exclude_self_triggered` leaves out events caused by the user, and `recurring` (filter-based rules only) repeats the notification for objects that still match.
`is_common`	`bool`	6	True for a common rule that notifies the users and groups in `recipients`; false for a private rule of its owner.
`recipients`	`AccessControlList`	7	For a common rule, the users and groups to notify. Not used by private rules.
`notification_days_of_week`	`uint32`	8	For filter-based rules, the days on which the rule is processed, as a bit mask: 1 Sunday, 2 Monday, 4 Tuesday, 8 Wednesday, 16 Thursday, 32 Friday, 64 Saturday. 127 means every day.

IRPCNotificationRules.AddNotificationRule -- Creates a notification rule and returns its ID.
IRPCNotificationRules.GetNotificationRules -- Gets the caller's private notification rules and the common rules that apply to the caller.
IRPCNotificationRules.ModifyNotificationRule -- Replaces a notification rule, identified by its id, with the given definition.

AddNotificationRuleRequest.utf8szrule -- The rule to create. Set name, subscriptions and usually object_filter and options.is_enabled; for a common rule also is_common and recipients. id is ignored.
ModifyNotificationRuleRequest.utf8szrule -- The complete new definition of the rule. id identifies the rule to change.
GetNotificationRulesResponse.rules -- The rules. Built-in common rules, such as "Assigned to me", have small fixed IDs.