Class Likes

Likes namespace — like and unlike tracks and playlists.

See

https://developers.soundcloud.com/docs/api/explorer/open-api#/likes

Index

Constructors

Methods

likePlaylist likeTrack unlikePlaylist unlikeTrack

Constructors

constructor

new Likes(getToken: TokenGetter, refreshCtx?: AutoRefreshContext): Likes
Parameters
- getToken: TokenGetter
- OptionalrefreshCtx: AutoRefreshContext
Returns Likes
- Defined in src/client/SoundCloudClient.ts:1312

Methods

likePlaylist

likePlaylist(
playlistId: string | number,
options?: TokenOption,
): Promise<boolean>
Like a playlist.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<boolean>
true if the like was successful, false on failure

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/likes/post_likes_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:1357

likeTrack

likeTrack(trackId: string | number, options?: TokenOption): Promise<boolean>
Like a track.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<boolean>
true if the like was successful, false on failure
Example
```
const success = await sc.likes.likeTrack(123456);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/likes/post_likes_tracks__track_id_
- Defined in src/client/SoundCloudClient.ts:1329

unlikePlaylist

unlikePlaylist(
playlistId: string | number,
options?: TokenOption,
): Promise<boolean>
Unlike a playlist.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<boolean>
true if the unlike was successful, false on failure

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/likes/delete_likes_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:1371

unlikeTrack

unlikeTrack(trackId: string | number, options?: TokenOption): Promise<boolean>
Unlike a track.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<boolean>
true if the unlike was successful, false on failure

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/likes/delete_likes_tracks__track_id_
- Defined in src/client/SoundCloudClient.ts:1343