Class Reposts

Reposts namespace — repost and unrepost tracks and playlists.

See

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

Index

Constructors

Methods

repostPlaylist repostTrack unrepostPlaylist unrepostTrack

Constructors

constructor

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

Methods

repostPlaylist

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

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/reposts/post_reposts_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:1323

repostTrack

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

unrepostPlaylist

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

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/reposts/delete_reposts_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:1337

unrepostTrack

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

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/reposts/delete_reposts_tracks__track_id_
- Defined in src/client/SoundCloudClient.ts:1309