getWaveFolder

Retrieves a specific CRM Analytics app or folder.

Syntax 

1import { LightningElement, wire } from "lwc";
2import { getWaveFolder } from "lightning/analyticsWaveApi";
3
4export default class GetWaveFolder extends LightningElement {
5  @api folderID; // or fetch the ID
6  @wire(getWaveFolder, {
7    folderId: "$folderID",
8  })
9  onGetWaveFolder({ data, error }) {
10    if (error) {
11      console.log("getWaveFolder(${folderId}) ERROR:", error);
12    } else if (data) {
13      console.log("getWaveFolder(${folderId}) RESPONSE:", data);
14    }
15  }
16}

CRM Analytics API Resource 

1GET /wave/folders/${folderId}

getWaveFolder uses this CRM Analytics API resource.

Parameters 

These parameters are optional.

Parameter NameTypeDescription
disableMruStringIndicates whether to update the MRU (true) or not (false). The default is false.
mobileOnlyFeaturedAssetsStringFilters the response to only return a folder which contain dashboards that are enabled for the CRM Analytics mobile app (true) or not (false). The default is false.

Returns