Class StationTracksResult

A batch of tracks streamed from a rotor station.

Hierarchy (View Summary)

YandexMusicModel
- StationTracksResult

Index

Constructors

Properties

batchId? client? id? pumpkin? radioSessionId? sequence?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`batchId

batchId?: string

Batch id (echoed back as queue when requesting the next batch).

`Optional`client

client?: Client

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

`Optional`id

id?: Id

Station id.

`Optional`pumpkin

pumpkin?: boolean

Whether the Halloween ("pumpkin") theme is active.

`Optional`radioSessionId

radioSessionId?: string

Radio session id, used for rotor feedback.

`Optional`sequence

sequence?: Sequence[]

The track sequence.

Methods

`Static`deJson

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

`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