Class MetatagAlbums

A page of a metatag's albums.

Hierarchy (View Summary)

YandexMusicModel
- MetatagAlbums

Index

Constructors

Properties

albums? client? color? coverUri? id? pager? sortByValues? stationId? title?

Methods

deJson requireClient

Constructors

constructor

new MetatagAlbums(client?: Client): MetatagAlbums
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns MetatagAlbums
Inherited from YandexMusicModel.constructor
- Defined in src/base.ts:177

Properties

`Optional`albums

albums?: Album[]

The albums on this page.

`Optional`client

client?: Client

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

`Optional`color

color?: string

Accent color.

`Optional`coverUri

coverUri?: string

Cover URI template.

`Optional`id

id?: string

Metatag id.

`Optional`pager

pager?: Pager

Pagination metadata.

`Optional`sortByValues

sortByValues?: MetatagSortByValue[]

Available sort options.

`Optional`stationId

stationId?: string

Radio station id.

`Optional`title

title?: MetatagTitle

Title.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): MetatagAlbums | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns MetatagAlbums | null
See
MetatagAlbums
- Defined in src/models/metatag/metatag.ts:229

`Protected`requireClient

requireClient(): Client
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.

Throws
When the model was created without a client.
Inherited from YandexMusicModel.requireClient
- Defined in src/base.ts:190