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_viewsTrue to get all views. If this parameter is true, the lParentView parameter is ignored.boolean
parent_viewThe ID of the view whose child views to get. Specify -1 to get the root-level views. Effective only when bAllViews is false.number

Return type

NameDescriptionType
viewsThe views as JSON array (Represented by CMF_View struct).View[]

Example

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