Skip to main content

GetDocEventSubscriptions

Gets the event subscriptions of a document (for the current user).

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.GetDocEventSubscriptions({
obj_id: {
type: 0,
item_id: {
internal_id: 0,
external_repository_id: {
connection: "<!< The external repository connection identifier.>",
item: "<item>",
},
},
},
});

Message

NameDescriptionType
obj_idThe object ID as JSON. (represented by MF_ObjID struct.)ObjID

Return type

NameDescriptionType
subscriptionsReceives the results as JSON array (represented by MF_EventSubscription struct).EventSubscription[]

Example

{
"subscriptions": [] /* Array of EventSubscription */
}