IRPCEvents.GetNotificationConfiguration
Vault API / standard read session idempotent returns metadata structure version
Tells whether the caller has notifications turned on.
| Service | Events and notifications MFiles.IRPCEvents |
|---|---|
| gRPC method | /MFiles.IRPCEvents/GetNotificationConfiguration |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-notification-configuration |
| Request | GetNotificationConfigurationRequest |
| Response | GetNotificationConfigurationResponse |
| Book and level | Vault API, standard |
| Kind | read |
| 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.
- Only
is_enabledis used; the other flags are always false here.
Request: GetNotificationConfigurationRequest
No fields.
Response: GetNotificationConfigurationResponse
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 |
|---|---|---|
pflags | NOTIFICATIONFLAGS | The caller's notification switch. is_enabled is true when the caller receives notifications. |
pflags.all | bool | Specifies all flags set; Including any future flags. |
pflags.is_enabled | bool | Notifications enabled. |
pflags.send_digest | bool | Combine the day's notifications into a single message. |
pflags.exclude_self_triggered | bool | Exclude notifications of events caused by me. |
pflags.recurring | bool | Notifications are recurring (not only appear once per a matching object). |