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

    Class PinData

    The payload of a Pin (an album, artist or playlist reference).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    agent? animationUrl? backgroundImageUrl? client? colors? contentRestrictions? contentWarning? cover? header? id? kind? name? playlistUuid? seeds? stationId? title? uid?

    Methods

    deJson requireClient

    Constructors

    Properties

    agent?: string

    Wave agent (wave pins).

    animationUrl?: string

    Animated cover URL (wave pins).

    backgroundImageUrl?: string

    Background image URI template (wave pins).

    client?: Client

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

    colors?: JSONValue

    Theme colors (wave pins; free-form raw JSON).

    contentRestrictions?: ContentRestrictions

    Content availability restrictions.

    contentWarning?: string

    Content warning marker (wave pins).

    cover?: Cover

    Cover art.

    header?: JSONValue

    Header descriptor (wave pins; free-form raw JSON).

    id?: number

    Entity id (albums/artists).

    kind?: number

    Playlist kind (playlists).

    name?: string

    Entity name (artists).

    playlistUuid?: string

    Playlist UUID (playlists only).

    seeds?: JSONValue

    Wave seeds (wave pins; free-form raw JSON).

    stationId?: string

    Station id (wave pins).

    title?: string

    Entity title (albums, playlists).

    uid?: number

    Owner uid (playlists).

    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