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

Function: listRecentlyPlayed()

function listRecentlyPlayed(client, options?): Promise<tPaged<tPaginatedResourceCollectionResponse>>;

Defined in: clients/client-user/src/library.ts:272

What the listener played lately, newest first, a page at a time: the albums, playlists and stations, not the tracks in them.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

options?

tReadOptions<tPaged<tPaginatedResourceCollectionResponse>> & object & tRecentlyPlayedTypesOption & tWalkOptions

The types to keep to, how many to send in one page, where to start, what to send beside them, and the signal and schema of the request.

Returns

Promise<tPaged<tPaginatedResourceCollectionResponse>>

What Apple answered: the first page, with next where there is more; maxPages plays no part.

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.