Class ContentRestrictions

Content availability restrictions and disclaimers for an entity.

Hierarchy (View Summary)

YandexMusicModel
- ContentRestrictions

Index

Constructors

Properties

available? client? disclaimers?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`available

available?: boolean

Whether the content is available.

`Optional`client

client?: Client

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

`Optional`disclaimers

disclaimers?: string[]

Human-readable disclaimers.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): ContentRestrictions | null
Deserialize a ContentRestrictions.
Parameters
- raw: JSONValue | undefined
  Raw JSON value from the API.
- Optionalclient: Client
  The owning client.
Returns ContentRestrictions | null
The model, or null when raw is not an object.
- Defined in src/models/common.ts:191

`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