Skip to main content

@wildix/wda-insights-client > ListPlaylistsCommand

ListPlaylistsCommand class​

Lists all playlist and pinned configurations available to the user.

Signature:

export declare class ListPlaylistsCommand extends ListPlaylistsCommand_base

Extends: ListPlaylistsCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { WdaInsightsClient, ListPlaylistsCommand } from "@wildix/wda-insights-client"; // ES Modules import
// const { WdaInsightsClient, ListPlaylistsCommand } = require("@wildix/wda-insights-client"); // CommonJS import
const client = new WdaInsightsClient(config);
const input = { // ListPlaylistsInput
  company: "STRING_VALUE",
  user: "STRING_VALUE",
};
const command = new ListPlaylistsCommand(input);
const response = await client.send(command);
// { // ListPlaylistsOutput
//   playlists: [ // PlaylistsList // required
//     { // Playlist
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       id: "STRING_VALUE", // required
//       createdAt: "STRING_VALUE", // required
//       createdBy: "STRING_VALUE", // required
//       createdByName: "STRING_VALUE", // required
//       updatedAt: "STRING_VALUE",
//       access: { // PlaylistAccess
//         visibility: "explicit" || "organization",
//         grants: [ // PlaylistGrantList
//           { // PlaylistGrant
//             permission: "view" || "edit", // required
//             principal: { // PlaylistPrincipal Union: only one key present
//               userId: "STRING_VALUE",
//               groupId: "STRING_VALUE",
//             },
//           },
//         ],
//       },
//       itemsCount: Number("int"), // required
//     },
//   ],
// };