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

Function: getPersonalStation()

function getPersonalStation(client, options?): Promise<tStationsResponse>;

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

The listener's own station, which plays what Apple picks for them. It is kept in the catalog, and is the one resource there that is asked for with the Music User Token.

Parameters

client

tAppleMusicClient

The listener's client to ask with.

options?

tPersonalStationOptions

The storefront whose catalog the station is in, and what to send beside it.

Returns

Promise<tStationsResponse>

What Apple answered: the station 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, if the client has no storefront to ask in, 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.