IRPCEvents.SetNotificationConfiguration
Vault API / standard write session idempotent returns metadata structure version
Turns notifications on or off for the caller.
| Service | Events and notifications MFiles.IRPCEvents |
|---|---|
| gRPC method | /MFiles.IRPCEvents/SetNotificationConfiguration |
| HTTP (mf-http-grpc) | POST /grpc/v1/set-notification-configuration |
| Request | SetNotificationConfigurationRequest |
| Response | SetNotificationConfigurationResponse |
| 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
- Requires a vault session. No special vault rights are needed. Affects only the caller.
- Only
is_enabledmay be set; any other flag fails with "The parameter is incorrect.".
Request: SetNotificationConfigurationRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
flags | NOTIFICATIONFLAGS | Set is_enabled to true to receive notifications, or leave all flags unset to stop them. |
flags.all | bool | Specifies all flags set; Including any future flags. |
flags.is_enabled | bool | Notifications enabled. |
flags.send_digest | bool | Combine the day's notifications into a single message. |
flags.exclude_self_triggered | bool | Exclude notifications of events caused by me. |
flags.recurring | bool | Notifications are recurring (not only appear once per a matching object). |
Response: SetNotificationConfigurationResponse
No fields.