`deleteWaveFolder`

Deletes a specific CRM Analytics folder by ID.

Syntax

1import { deleteWaveFolder } from 'lightning/analyticsWaveApi';
2deleteWaveFolder({ folderId: string }): Promise<void>

CRM Analytics API Resource

1DELETE /wave/folders/${folderId}

deleteWaveFolder uses this CRM Analytics API resource.

Parameters

Parameter Name	Type	Description	Required?
`folderId`	String	The ID of the CRM Analytics folder.

Returns

The return type is void.

Usage

There are several ways to use deleteWaveFolder. For example, you can display a list of folders and enable delete on each folder on the list.

This example adds a delete button to a page with folders. Deleting a folder displays a toast message using the lightning/platformShowToastEvent module.

1import { LightningElement, api } from "lwc";
2import { deleteWaveFolder } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class DeleteWaveFolder extends LightningElement {
6  @api id; // or fetch the ID
7
8  delete(event) {
9    deleteWaveFolder({ folderId: this.id })
10      .then(() => {
11        this.dispatchEvent(
12          new ShowToastEvent({
13            title: "Success",
14            message: "Analytics Folder Deleted",
15            variant: "success",
16          }),
17        );
18      })
19      .catch((error) => {
20        this.dispatchEvent(
21          new ShowToastEvent({
22            title: "Error deleting folder",
23            message: error.body.message,
24            variant: "error",
25          }),
26        );
27      });
28  }
29}

This button calls the deleteWaveFolder() method.

1<template>
2  <lightning-button
3    label="Delete"
4    icon-name="utility:delete"
5    icon-position="right"
6    onclick={delete}
7  >
8  </lightning-button>
9</template>