Class MediaResource

Resource for working with media

Index

Constructors

Methods

addPhoto addTrackToPlaylist createPlaylist deletePhoto deletePlaylist getPhoto getPlaylist getTrack getUserPlaylists removeTrackFromPlaylist updatePlaylist

Constructors

constructor

new MediaResource(client: REST): MediaResource
Creates a new resource for working with media
Parameters
- client: REST
  REST client
Returns MediaResource
- Defined in packages/rest/src/resources/Media.ts:24

Methods

addPhoto

addPhoto(
    photo: Blob,
    caption?: string,
    mode?: "public" | "private",
): Promise<Photo>
Add a new photo
Parameters
- photo: Blob
  Binary photo data
- caption: string = ''
  Photo caption
- mode: "public" | "private" = 'public'
  Photo visibility mode
Returns Promise<Photo>
Photo data
- Defined in packages/rest/src/resources/Media.ts:44

addTrackToPlaylist

addTrackToPlaylist(playlistId: number, trackId: number): Promise<BaseOkay>
Add track to playlist
Parameters
- playlistId: number
  Playlist ID
- trackId: number
  Track ID
Returns Promise<BaseOkay>
Addition result
- Defined in packages/rest/src/resources/Media.ts:133

createPlaylist

createPlaylist(
    name: string,
    release: string,
    description: string,
    cover: number,
): Promise<Playlist>
Create playlist
Parameters
- name: string
  Playlist name
- release: string
  Release date
- description: string
  Playlist description
- cover: number
  Cover ID
Returns Promise<Playlist>
Created playlist
- Defined in packages/rest/src/resources/Media.ts:83

deletePhoto

deletePhoto(photoId: number): Promise<BaseOkay>
Delete photo
Parameters
- photoId: number
  Photo ID
Returns Promise<BaseOkay>
Deletion result
- Defined in packages/rest/src/resources/Media.ts:62

deletePlaylist

deletePlaylist(playlistId: number): Promise<BaseOkay>
Delete playlist
Parameters
- playlistId: number
  Playlist ID
Returns Promise<BaseOkay>
Deletion result
- Defined in packages/rest/src/resources/Media.ts:98

getPhoto

getPhoto(photoId: string): Promise<Photo>
Get photo by ID
Parameters
- photoId: string
  Photo ID
Returns Promise<Photo>
Photo data
- Defined in packages/rest/src/resources/Media.ts:33

getPlaylist

getPlaylist(playlistId: number): Promise<Playlist>
Get playlist by ID
Parameters
- playlistId: number
  Playlist ID
Returns Promise<Playlist>
Playlist data
- Defined in packages/rest/src/resources/Media.ts:163

getTrack

getTrack(trackId: number): Promise<Track>
Get track by ID
Parameters
- trackId: number
  Track ID
Returns Promise<Track>
Track data
- Defined in packages/rest/src/resources/Media.ts:71

getUserPlaylists

getUserPlaylists(tag: string): Promise<Playlist[]>
Get user playlists
Parameters
- tag: string
  User tag
Returns Promise<Playlist[]>
List of playlists
- Defined in packages/rest/src/resources/Media.ts:172

removeTrackFromPlaylist

removeTrackFromPlaylist(playlistId: number, trackId: number): Promise<Playlist>
Remove track from playlist
Parameters
- playlistId: number
  Playlist ID
- trackId: number
  Track ID
Returns Promise<Playlist>
Removal result
- Defined in packages/rest/src/resources/Media.ts:149

updatePlaylist

updatePlaylist(
    playlistId: number,
    name: string,
    release: string,
    description: string,
    cover: number,
): Promise<BaseOkay>
Update playlist
Parameters
- playlistId: number
  Playlist ID
- name: string
  Playlist name
- release: string
  Release date
- description: string
  Playlist description
- cover: number
  Cover ID
Returns Promise<BaseOkay>
Updated playlist
- Defined in packages/rest/src/resources/Media.ts:113