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

    Class Block

    A block of a landing page (a titled row of entities).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    backgroundImageUrl? backgroundVideoId? backgroundVideoUrl? client? data? description? entities? id? playContext? title? type? typeForFrom?

    Methods

    deJson requireClient

    Constructors

    Properties

    backgroundImageUrl?: string

    Background image URI template.

    backgroundVideoId?: string

    Background video identifier.

    backgroundVideoUrl?: string

    Background video URL.

    client?: Client

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

    data?: JSONValue

    Block-level data (raw JSON, pending typed variants).

    description?: string

    Block description.

    entities?: BlockEntity[]

    Items in the block.

    id?: string

    Block id.

    playContext?: JSONValue

    Play-context reference driving the block's playback ({kind, uid, playlistUuid}); free-form raw JSON, distinct from the landing-entity PlayContext.

    title?: string

    Block title.

    type?: string

    Block type.

    typeForFrom?: string

    Origin tag used in from parameters.

    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