Class OpenGraphData

Open Graph metadata used when a playlist is shared as a link.

Hierarchy (View Summary)

YandexMusicModel
- OpenGraphData

Index

Constructors

Properties

client? description? image? title?

Methods

deJson requireClient

Constructors

constructor

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

description?: string

Share description.

`Optional`image

image?: Cover

Share image.

`Optional`title

title?: string

Share title.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): OpenGraphData | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns OpenGraphData | null
See
OpenGraphData
- Defined in src/models/playlist/promo.ts:125

`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