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

    Class AdParams

    Advertisement parameters attached to a station result.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    adVolume? categoryId? client? genreId? genreName? otherParams? pageRef? partnerId? targetRef?

    Methods

    deJson requireClient

    Constructors

    Properties

    adVolume?: number

    Ad volume.

    categoryId?: string | number

    Category id.

    client?: Client

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

    genreId?: string

    Genre id.

    genreName?: string

    Genre name.

    otherParams?: string

    Extra parameters (for example user:{ID}).

    pageRef?: string

    Page reference.

    partnerId?: string | number

    Partner id.

    targetRef?: string

    Target reference.

    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