Skip to main content

RefreshObject

Description

Refreshes the specified object in the listing.

Syntax

// shellListing points to instance of IShellListing
const result = await shellListing.RefreshObject(
objID,
refreshFromServer,
updateRelatedObjects,
);

Parameters

NameOptionalityTypeDescription
objIDRequiredObjIDThe object to refresh.
refreshFromServerRequiredbooleanIf true, refreshes the data of the object from the server.
updateRelatedObjectsRequiredbooleanIf true, the related objects of the specified object are also updated.

Return type

TypeDescription
Promise < void >It returns promise<boolean> if action succeeds true otherwise false will be returned.