Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • new BasePlaylist(client: Client, data: SimplifiedPlaylistObject | PlaylistObject): BasePlaylist

Properties

client

client: Client

The client that instantiated this class

collaborative

collaborative: boolean

Whether the owner allows other users to modify the playlist

description

description: null | string

The playlist description

externalUrls

externalUrls: ExternalUrl

Known external URLs for this playlist

href

href: string

A link to the Web API endpoint providing full details of the playlist

id

id: string

The Spotify ID of the structure

images

images: Image[]

Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order

⚠️Note: If returned, the source URL for the image (url) is temporary and will expire in less than a day

name

name: string

The name of the playlist

owner

owner: PublicUser

The user who owns the playlist

public

public: null | boolean

Whether the playlist is public or not

⚠️Note: This would be null if the playlist status is not relevant

rawObjectType

rawObjectType: string

The raw object type returned by the API: playlist

snapshotId

snapshotId: string

The version identifier for the current playlist

uri

uri: string

The Spotify URI for the playlist

Methods

Private _patchImages

  • _patchImages(data: ImageObject[]): Image[]

Legend

  • Constructor
  • Property
  • Method
  • Constructor
  • Property
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Private property
  • Private method

Generated using TypeDoc