Class AlbumActionButton

A call-to-action button shown on an album page.

Hierarchy (View Summary)

YandexMusicModel
- AlbumActionButton

Index

Constructors

Properties

client? color? text? url?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`client

client?: Client

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

`Optional`color

color?: string

Button color.

`Optional`text

text?: string

Button caption.

`Optional`url

url?: string

Target URL.

Methods

`Static`deJson

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

`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