IRPCEventHandlersAdmin.GetVaultEventHandlers
Administration API / specialized admin session idempotent
Gets all event handlers of the vault, with their code.
| Service | Event handlers MFiles.IRPCEventHandlersAdmin |
|---|---|
| gRPC method | /MFiles.IRPCEventHandlersAdmin/GetVaultEventHandlers |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-vault-event-handlers |
| Request | GetVaultEventHandlersRequest |
| Response | GetVaultEventHandlersResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session and the vault right
change_metadata_structure; a normal user gets "Access denied.". - Returns active and inactive handlers, including those registered by vault applications.
- Returns an empty list when the server license does not include event handlers.
Request: GetVaultEventHandlersRequest
No fields.
Response: GetVaultEventHandlersResponse
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 |
|---|---|---|
values[] | repeated InternalEventHandler | The event handlers of the vault. See InternalEventHandler. |
values[].event_type | InternalEventType | The event type the handler is associated with. |
values[].sort_index | int32 | The sort index defines the order in which the event handlers are executed in response to an event. |
values[].is_active | bool | True when this handler is active and is executed in response to events. |
values[].description | string | Description of the event handler. A user friendly identifier for the event handler. |
values[].code | string | The actual code for the event handler that is executed in response an event.. |
values[].guid | string | GUID for the event handler. |