One Logo Pool Ball
_MusicKit_SwiftUI · IOS API REFERENCE

MusicSubscriptionOffer.Options

struct · iOS 15.0+ · SDK 27.1

struct Options

Options for loading subscription offers for Apple Music.

Members (13)

get · iOS 15.0+

description

TypeScript
get description(): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get · iOS 15.0+

campaignToken

TypeScript
get campaignToken(): (string) | null
Swift declaration
var campaignToken: String?

A campaign token for the Apple Services affiliate program.

set · iOS 15.0+

campaignToken

TypeScript
set campaignToken(value: (string) | null)
Swift declaration
var campaignToken: String?

A campaign token for the Apple Services affiliate program.

get · iOS 15.0+

affiliateToken

TypeScript
get affiliateToken(): (string) | null
Swift declaration
var affiliateToken: String?

An affiliate token for the Apple Services affiliate program.

set · iOS 15.0+

affiliateToken

TypeScript
set affiliateToken(value: (string) | null)
Swift declaration
var affiliateToken: String?

An affiliate token for the Apple Services affiliate program.

get · iOS 15.0+

messageIdentifier

TypeScript
get messageIdentifier(): MusicSubscriptionOffer_MessageIdentifier
Swift declaration
var messageIdentifier: MusicSubscriptionOffer.MessageIdentifier

An identifier for selecting the main message that the subscription offer sheet presents to the user. Defaults to ``MusicSubscriptionOffer/MessageIdentifier/join``.

set · iOS 15.0+

messageIdentifier

TypeScript
set messageIdentifier(value: MusicSubscriptionOffer_MessageIdentifier)
Swift declaration
var messageIdentifier: MusicSubscriptionOffer.MessageIdentifier

An identifier for selecting the main message that the subscription offer sheet presents to the user. Defaults to ``MusicSubscriptionOffer/MessageIdentifier/join``.

init · iOS 15.0+

init

TypeScript
static init(action?: MusicSubscriptionOffer_Action, messageIdentifier?: MusicSubscriptionOffer_MessageIdentifier, itemID?: (_MusicKit_MusicItemID) | null, affiliateToken?: (string) | null, campaignToken?: (string) | null): MusicSubscriptionOffer_Options
Swift declaration
init(action: MusicSubscriptionOffer.Action = .subscribe, messageIdentifier: MusicSubscriptionOffer.MessageIdentifier = .join, itemID: MusicItemID? = nil, affiliateToken: String? = nil, campaignToken: String? = nil)

Creates options for a subscription offer sheet with specific values for common properties.

get · iOS 15.0+

action

TypeScript
get action(): MusicSubscriptionOffer_Action
Swift declaration
var action: MusicSubscriptionOffer.Action

An action for the subscription offers entry point. Defaults to ``MusicSubscriptionOffer/Action/subscribe``.

set · iOS 15.0+

action

TypeScript
set action(value: MusicSubscriptionOffer_Action)
Swift declaration
var action: MusicSubscriptionOffer.Action

An action for the subscription offers entry point. Defaults to ``MusicSubscriptionOffer/Action/subscribe``.

get · iOS 15.0+

itemID

TypeScript
get itemID(): (_MusicKit_MusicItemID) | null
Swift declaration
var itemID: MusicItemID?

An identifier for the music item the user is trying to access, which requires an active subscription.

set · iOS 15.0+

itemID

TypeScript
set itemID(value: (_MusicKit_MusicItemID) | null)
Swift declaration
var itemID: MusicItemID?

An identifier for the music item the user is trying to access, which requires an active subscription.

get · iOS 15.0+

default

TypeScript
static get default(): MusicSubscriptionOffer_Options
Swift declaration
static let `default`: MusicSubscriptionOffer.Options

The default set of options for loading subscription offers for Apple Music.

Skipped declarations

No declarations were skipped in this snapshot.

All _MusicKit_SwiftUI types →