@dvxch/yandex-music
    Preparing search index...

    Class Playlist

    A playlist (user-made or editorial).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    actionButton? animatedCoverUri? artistPlaylistType? available? backgroundColor? backgroundImageUrl? backgroundVideoId? backgroundVideoUrl? branding? client? coauthors? collective? contest? cover? coverWithoutText? created? customWave? derivedColors? description? descriptionFormatted? durationMs? everPlayed? generatedPlaylistType? hasTrailer? idForFrom? image? isBanner? isPremiere? kind? lastOwnerPlaylists? likesCount? madeFor? metrikaId? modified? ogData? ogDescription? ogImage? ogTitle? owner? pager? playCounter? playlistAbsence? playlistUuid? ready? recentTracks? regions? revision? similarPlaylists? snapshot? tags? textColor? title? topArtist? trackCount? tracks? trailer? type? uid? urlPart? visibility?

    Methods

    deJson requireClient

    Constructors

    Properties

    actionButton?: JSONValue

    Call-to-action button (free-form raw JSON, pending a typed model).

    animatedCoverUri?: string

    Animated cover URI.

    artistPlaylistType?: string

    Artist-playlist kind, when this is an artist's playlist.

    available?: boolean

    Whether available.

    backgroundColor?: string

    Background color.

    backgroundImageUrl?: string

    Background image URL.

    backgroundVideoId?: string

    Background video id.

    backgroundVideoUrl?: string

    Background video URL.

    branding?: Brand

    Branding.

    client?: Client

    The client that created this model, used by convenience methods.

    coauthors?: number[]

    Co-author uids.

    collective?: boolean

    Whether collaborative.

    contest?: Contest

    Contest info.

    cover?: Cover

    Playlist cover.

    coverWithoutText?: Cover

    Cover without overlaid text.

    created?: string

    Creation timestamp.

    customWave?: CustomWave

    Custom wave config.

    derivedColors?: CoverDerivedColors

    Colors derived from the cover image.

    description?: string

    Description.

    descriptionFormatted?: string

    Formatted (HTML) description.

    durationMs?: number

    Total duration in milliseconds.

    everPlayed?: boolean

    Whether the playlist was ever played.

    generatedPlaylistType?: string

    Generated playlist kind (for example playlistOfTheDay).

    hasTrailer?: boolean

    Whether a trailer exists.

    idForFrom?: string

    Origin id used in from parameters.

    image?: string

    Image URI template.

    isBanner?: boolean

    Whether shown as a banner.

    isPremiere?: boolean

    Whether a premiere.

    kind?: number

    Playlist kind (id within the owner's playlists).

    lastOwnerPlaylists?: Playlist[]

    Other playlists by the same owner.

    likesCount?: number

    Number of likes.

    madeFor?: MadeFor

    "Made for" personalization.

    metrikaId?: number

    Metrika id.

    modified?: string

    Last modification timestamp.

    ogData?: OpenGraphData

    Open Graph data.

    ogDescription?: string

    Open Graph description.

    ogImage?: string

    Open Graph image URI template.

    ogTitle?: string

    Open Graph title.

    owner?: User

    Owner of the playlist.

    pager?: Pager

    Pagination metadata for the track list.

    playCounter?: PlayCounter

    Play counter.

    playlistAbsence?: PlaylistAbsence

    Absence info.

    playlistUuid?: string

    Stable UUID.

    ready?: boolean

    Whether generation finished.

    recentTracks?: TrackId[]

    Recently added track references.

    regions?: JSONValue[]

    Regions where the playlist is available.

    revision?: number

    Revision number.

    similarPlaylists?: Playlist[]

    Playlists similar to this one.

    snapshot?: number

    Snapshot number.

    tags?: JSONValue[]

    Tags.

    textColor?: string

    Text color.

    title?: string

    Title.

    topArtist?: Artist[]

    Top artists in the playlist.

    trackCount?: number

    Number of tracks.

    tracks?: TrackShort[]

    Track references.

    trailer?: PlaylistAvailability

    Trailer availability.

    type?: string

    Playlist kind label.

    uid?: number

    Owner uid.

    urlPart?: string

    URL slug.

    visibility?: string

    Visibility (public/private).

    Methods

    • Assert that this model carries a client, returning it narrowed to non-null.

      Convenience methods that need to call the API use this to fail fast with a clear message instead of a generic "cannot read property of undefined".

      Returns Client

      The owning Client.

      When the model was created without a client.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods