Skip to main content

FollowObject

Starts or stops following the specified object. While the object is being followed, the current user will be notified if the object changes.

Syntax

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

Message

NameDescriptionType
obj_idThe object ID as JSON. (represented by MF_ObjID struct)ObjID
follow_stateTrue if the objects should be followed, false if not followed.boolean

Return type

NameDescriptionType

Example

{}