Reference / @open-music-sdk/client-user / getLibraryMusicVideoRating

Function: getLibraryMusicVideoRating()

function getLibraryMusicVideoRating(
   client, 
   id, 
   options?
): Promise<tRatingsResponse>;

Defined in: clients/client-user/src/ratings.ts:492

The listener's rating of the library music video with an id.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

id

string

The library music video's id.

options?

tEndpointOptions<tRatingsResponse, object, object>

The language to answer in, and what else to send with the request.

Returns

Promise<tRatingsResponse>

What Apple answered: the rating under data.

Throws

TypeError if client is no client or an argument is not what it should be, before Apple is asked.

Throws

AppleMusicError if Apple, the network, or a token provider fails, or a schema finds issues; _tag says which.

Throws

The reason options.signal aborted with, when it does.

Throws

Whatever a token provider, store, schema, hook or rate limiter throws, as client.request passes it on.