Skip to main content

GetViews

Returns the user's view collection (common views and user-specific views).

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ViewsOperations.GetViews({
get_all_views: false,
parent_view: 0,
});

Message

NameDescriptionType
get_all_viewsWhen true, retrieves all views regardless of hierarchy. When false, only the children of parent_view are returned.boolean
parent_viewThe ID of the parent view whose child views to retrieve. Use -1 for root-level views. Ignored when get_all_views is true.number

Return type

NameDescriptionType
viewsThe retrieved views, as an array of View objects.View[]

Example

{
"views": [] /* Array of View */
}