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: "<connection>",
item: "<item>",
},
},
},
});

Message

NameDescriptionType
obj_idThe object whose event subscriptions to retrieve, as an ObjID object.ObjID

Return type

NameDescriptionType
subscriptionsThe event subscriptions for the object, as an array of EventSubscription objects.EventSubscription[]

Example

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