IRPCNotificationRules.ModifyNotificationRule
Vault API / standard write session idempotent returns metadata structure version
Replaces a notification rule, identified by its id, with the given definition.
| Service | Notification rules MFiles.IRPCNotificationRules |
|---|---|
| gRPC method | /MFiles.IRPCNotificationRules/ModifyNotificationRule |
| HTTP (mf-http-grpc) | POST /grpc/v1/modify-notification-rule |
| Request | ModifyNotificationRuleRequest |
| Response | ModifyNotificationRuleResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Send the complete rule: read it with GetNotificationRules, change it and send it back. The subscriptions are replaced as a whole.
- Saving a private rule (
is_commonfalse) requiresmanage_private_notification_rules; saving a common rule requiresmanage_common_notification_rules. - An unknown
idfails with "Not found.". The same validation as in AddNotificationRule applies.
Request: ModifyNotificationRuleRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
utf8szrule | NotificationRule | The complete new definition of the rule. id identifies the rule to change. |
utf8szrule.id | int32 | The ID of the rule. Assigned by the server when the rule is created. |
utf8szrule.name | string | The name of the notification rule. |
utf8szrule.object_filter[] | repeated SearchCondition | 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). |
utf8szrule.object_filter[].expression | Expression | The left side of the condition: what is evaluated for each object, such as a property value, a status value or any field (full-text search). |
utf8szrule.object_filter[].type | ConditionType | The comparison operator. |
utf8szrule.object_filter[].value | TypedValue | The right side of the condition: the value to compare with. Its data type must suit the expression, for example a lookup for a lookup property, Boolean for STATUS_TYPE_IS_DELETED. |
utf8szrule.subscriptions[] | repeated EventSubscription | 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. |
utf8szrule.subscriptions[].type | EventType | The type of the event. [ switch_is( eventtype ) ] EventTypeSpecificDataUnion etsdu; //!< Additional event type -specific data as a union. |
utf8szrule.options | NOTIFICATIONFLAGS | 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. |
utf8szrule.options.all | bool | Specifies all flags set; Including any future flags. |
utf8szrule.options.is_enabled | bool | Notifications enabled. |
utf8szrule.options.send_digest | bool | Combine the day's notifications into a single message. |
utf8szrule.options.exclude_self_triggered | bool | Exclude notifications of events caused by me. |
utf8szrule.options.recurring | bool | Notifications are recurring (not only appear once per a matching object). |
utf8szrule.is_common | bool | True for a common rule that notifies the users and groups in recipients; false for a private rule of its owner. |
utf8szrule.recipients | AccessControlList | For a common rule, the users and groups to notify. Not used by private rules. |
utf8szrule.recipients.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
utf8szrule.recipients.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
utf8szrule.recipients.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
utf8szrule.recipients.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
utf8szrule.recipients.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
utf8szrule.recipients.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
utf8szrule.notification_days_of_week | uint32 | 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. |
Response: ModifyNotificationRuleResponse
No fields.
Related methods
- GetNotificationRules -- Gets the caller's private notification rules and the common rules that apply to the caller.
- AddNotificationRule -- Creates a notification rule and returns its ID.