Class PlayContext

A "continue listening" context (where playback last happened).

Hierarchy (View Summary)

YandexMusicModel
- PlayContext

Index

Constructors

Properties

client? context? contextItem? payload? tracks?

Methods

deJson requireClient

Constructors

constructor

new PlayContext(client?: Client): PlayContext
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns PlayContext
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`context

context?: string

Context kind (for example playlist, album, radio).

`Optional`contextItem

contextItem?: string

Identifier of the context item.

`Optional`payload

payload?: JSONValue

Context payload (free-form raw JSON, pending a typed model).

`Optional`tracks

tracks?: TrackShortOld[]

Tracks recently played in this context.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): PlayContext | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns PlayContext | null
See
PlayContext
- Defined in src/models/landing/entities.ts:81

`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