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

Function: getAlbumRatings()

function getAlbumRatings(
   client, 
   ids, 
   options?
): Promise<tRatingsResponse>;

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

The listener's ratings of the albums with the ids given.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

ids

readonly string[]

The albums' ids, 1 to 300 of them.

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 ratings 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.