Events and notifications (IRPCEvents)
Reads and sets the user's notification switch, checks whether a user can receive notifications, and sends requests and custom notifications to users.
| gRPC service | MFiles.IRPCEvents |
|---|---|
| Book and level | Vault API, standard |
| Methods | 7 |
| Proto file | mfiles/IRPCEvents.proto |
Overview
Everything here ends in an e-mail notification, so it works only when notifications are enabled on the server and in the vault. Several methods are used mainly by M-Files clients.
- The caller's own on/off switch for notifications: GetNotificationConfiguration, SetNotificationConfiguration.
- Check that a user can receive notifications: TestMessageToUser.
- Send an e-mail with your own subject and body: SendCustomNotification.
- Send a request to users: CreateEventFreeRequest, CreateEventCheckInRequest.
Which events notify whom is defined by notification rules: see IRPCNotificationRules. All methods need a vault session. Users and groups are identified by their IDs in the vault.
Methods
| Method | Summary | Facts |
|---|---|---|
| CreateEventAssignRequest | Not available: fails with "Not implemented.". | write session returns metadata structure version |
| CreateEventCheckInRequest | Asks the user who has an object checked out to check it in. Used by M-Files clients; applications rarely call it. | write session returns metadata structure version |
| CreateEventFreeRequest | Sends a request with a free-text message to users and groups. Used by M-Files clients; applications rarely call it. | write session returns metadata structure version |
| GetNotificationConfiguration | Tells whether the caller has notifications turned on. | read session idempotent returns metadata structure version |
| SendCustomNotification | Sends an e-mail with the given subject and body to users, groups and e-mail addresses. | write session returns metadata structure version |
| SetNotificationConfiguration | Turns notifications on or off for the caller. | write session idempotent returns metadata structure version |
| TestMessageToUser | Checks whether a user can receive notifications, and fails with the reason when not. | write session returns metadata structure version |