MusicKit · IOS API REFERENCE

MusicCatalogChartsRequest

struct · iOS 16.0+ · SDK 27.1

struct MusicCatalogChartsRequest

A request that your app uses to fetch the most popular items in the Apple Music catalog.

Members (7)

get · iOS 16.0+

TypeScript

get genre(): (Genre) | null

Swift declaration

var genre: Genre? { get }

The genre for the request.

get · iOS 16.0+

TypeScript

get kinds(): Array<MusicCatalogChartKind>

Swift declaration

var kinds: [MusicCatalogChartKind] { get }

The kinds of requested catalog charts.

get · iOS 16.0+

TypeScript

get limit(): (number) | null

Swift declaration

var limit: Int?

A limit for the number of items to return in the catalog search response.

set · iOS 16.0+

TypeScript

set limit(value: (number) | null)

Swift declaration

var limit: Int?

A limit for the number of items to return in the catalog search response.

get · iOS 16.0+

TypeScript

get offset(): (number) | null

Swift declaration

var offset: Int?

An offset for the request.

set · iOS 16.0+

TypeScript

set offset(value: (number) | null)

Swift declaration

var offset: Int?

An offset for the request.

method · iOS 16.0+

TypeScript

response(): Promise<MusicCatalogChartsResponse>

Swift declaration

func response() async throws -> MusicCatalogChartsResponse

Fetches the most popular items of the requested types that match the genre and kinds for the request.

2 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

MusicCatalogChartsRequest.init(genre:kinds:types:)

Passing a Swift type itself is not supported.

MusicCatalogChartsRequest.types

Passing a Swift type itself is not supported.