Class Playlists

Hierarchy

Base
- Playlists

Index

Constructors

Properties

Accessors

Methods

fetch get getAlt getV2 search searchAlt searchV2 secretToken

Constructors

constructor

new Playlists(sc): Playlists
Parameters
- sc: Soundcloud
Returns Playlists
Inherited from Base.constructor
- Defined in entities/Base.ts:4

Properties

`Readonly` sc

Accessors

api

get api(): API
Returns API
Inherited from Base.api
- Defined in entities/Base.ts:5

Methods

fetch

fetch(playlist): Promise<SoundcloudPlaylistV2>
Return playlist with all tracks fetched.
Parameters
- playlist: SoundcloudPlaylistV2
Returns Promise<SoundcloudPlaylistV2>
- Defined in entities/Playlists.ts:16

get

get(playlistResolvable): Promise<any>
Parameters
- playlistResolvable: string | number
Returns Promise<any>

Deprecated
use getV2 Fetches a playlist from URL or ID.
- Defined in entities/Playlists.ts:44

getAlt

getAlt(url): Promise<SoundcloudPlaylistV2>
Gets a playlist by URL (web scraping)
Parameters
- url: string
Returns Promise<SoundcloudPlaylistV2>
- Defined in entities/Playlists.ts:93

getV2

getV2(playlistResolvable): Promise<SoundcloudPlaylistV2>
Fetches a playlist from URL or ID using Soundcloud v2 API.
Parameters
- playlistResolvable: string | number
Returns Promise<SoundcloudPlaylistV2>
- Defined in entities/Playlists.ts:54

search

search(params?): Promise<SoundcloudPlaylist[]>
Parameters
- Optional params: SoundcloudPlaylistFilter
Returns Promise<SoundcloudPlaylist[]>

Deprecated
use searchV2 Searches for playlists.
- Defined in entities/Playlists.ts:27

searchAlt

searchAlt(query): Promise<SoundcloudPlaylistV2[]>
Searches for playlists (web scraping)
Parameters
- query: string
Returns Promise<SoundcloudPlaylistV2[]>
- Defined in entities/Playlists.ts:75

searchV2

searchV2(params?): Promise<SoundcloudPlaylistSearchV2>
Searches for playlists using the v2 API.
Parameters
- Optional params: SoundcloudPlaylistFilterV2
Returns Promise<SoundcloudPlaylistSearchV2>
- Defined in entities/Playlists.ts:35

secretToken

secretToken(playlistResolvable): Promise<SoundcloudSecretToken>
Parameters
- playlistResolvable: string | number
Returns Promise<SoundcloudSecretToken>

Deprecated
Requires Authentication - Gets the secret token from one of your playlists.
- Defined in entities/Playlists.ts:64