IRPCObjectOperations.GetDocEventSubscriptions

View as Markdown

Vault API / core read session or assertion idempotent returns metadata structure version

Gets the caller's event subscriptions for an object.

ServiceObjects, versions, properties and files MFiles.IRPCObjectOperations
gRPC method/MFiles.IRPCObjectOperations/GetDocEventSubscriptions
HTTP (mf-http-grpc)POST /grpc/v1/get-doc-event-subscriptions
RequestGetDocEventSubscriptionsRequest
ResponseGetDocEventSubscriptionsResponse
Book and levelVault API, core
Kindread
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Request: GetDocEventSubscriptionsRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
obj_idObjIDThe object ID. (represented by ObjID struct.)
obj_id.typeint32The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID).
obj_id.item_idItemIDThe ID of the object within its type, in item_id.internal_id.
obj_id.item_id.internal_idint32The ID of the object or value list item.
obj_id.item_id.external_repository_idExternalRepositoryIDUsed only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault.

Response: GetDocEventSubscriptionsResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
subscriptions[]repeated EventSubscriptionReceives the results.
subscriptions[].typeEventTypeThe type of the event. [ switch_is( eventtype ) ] EventTypeSpecificDataUnion etsdu; //!< Additional event type -specific data as a union.