One Logo Pool Ball
Additional SDK Modules · IOS API REFERENCE

_StoreKit_SwiftUI

Explore _StoreKit_SwiftUI types and the APIs available through One's generated iOS bindings.

150 types

147 callable entries

186 skipped

44% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AutomaticProductPlaceholderIcon

struct · iOS 17.0+

AutomaticProductPlaceholderIcon.Body

typealias · iOS 17.0+

AutomaticProductViewStyle

struct · iOS 17.0+

AutomaticProductViewStyle.Body

typealias · iOS 17.0+

AutomaticSubscriptionOfferViewStyle

struct · iOS 26.0+

AutomaticSubscriptionOfferViewStyle.Body

typealias · iOS 26.0+

AutomaticSubscriptionOptionGroupLabel

struct · iOS 18.0+

AutomaticSubscriptionOptionGroupLabel.Body

typealias · iOS 18.0+

AutomaticSubscriptionOptionGroupStyle

struct · iOS 18.0+

AutomaticSubscriptionStoreControlPlacement

struct · iOS 18.0+

AutomaticSubscriptionStoreControlPlacement.RawValue

typealias · iOS 18.0+

AutomaticSubscriptionStoreControlStyle

struct · iOS 17.0+

AutomaticSubscriptionStoreControlStyle.Body

typealias · iOS 17.0+

AutomaticSubscriptionStoreControlStyle.Placement

struct · iOS 18.0+

AutomaticSubscriptionStoreControlStyle.Placement.RawValue

typealias · iOS 18.0+

AutomaticSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

AutomaticSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

AutomaticSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

AutomaticSubscriptionStoreMarketingContent

struct · iOS 17.0+

AutomaticSubscriptionStoreMarketingContent.Body

typealias · iOS 17.0+

AutomaticSubscriptionStorePickerOptionLabel

struct · iOS 18.0+

AutomaticSubscriptionStorePickerOptionLabel.Body

typealias · iOS 18.0+

ButtonsSubscriptionStoreControlStyle

struct · iOS 17.0+

ButtonsSubscriptionStoreControlStyle.Body

typealias · iOS 17.0+

ButtonsSubscriptionStoreControlStyle.Placement

struct · iOS 18.0+

ButtonsSubscriptionStoreControlStyle.Placement.RawValue

typealias · iOS 18.0+

ButtonsSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

ButtonsSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

ButtonsSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle

struct · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle.Body

typealias · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle.Placement

struct · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle.Placement.RawValue

typealias · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

CompactPickerSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

CompactProductViewStyle

struct · iOS 17.0+

CompactProductViewStyle.Body

typealias · iOS 17.0+

CompactSubscriptionOfferViewStyle

struct · iOS 26.0+

CompactSubscriptionOfferViewStyle.Body

typealias · iOS 26.0+

DisplayMessageAction

struct · iOS 16.0+

EntitlementTaskState

enum · iOS 17.0+

IdentifiedStoreContent

struct · iOS 18.0+

LargeProductViewStyle

struct · iOS 17.0+

LargeProductViewStyle.Body

typealias · iOS 17.0+

LinksSubscriptionOptionGroupStyle

struct · iOS 18.0+

Optional.Body

typealias · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle

struct · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle.Body

typealias · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle.Placement

struct · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle.Placement.RawValue

typealias · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

PagedPickerSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

PagedProminentPickerSubscriptionStoreControlStyle

struct · iOS 18.0+

PagedProminentPickerSubscriptionStoreControlStyle.Body

typealias · iOS 18.0+

PagedProminentPickerSubscriptionStoreControlStyle.Placement

typealias · iOS 18.0+

PagedProminentPickerSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

PagedProminentPickerSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

PagedProminentPickerSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

PickerSubscriptionStoreControlStyle

struct · iOS 17.0+

PickerSubscriptionStoreControlStyle.Body

typealias · iOS 17.0+

PickerSubscriptionStoreControlStyle.Placement

struct · iOS 18.0+

PickerSubscriptionStoreControlStyle.Placement.RawValue

typealias · iOS 18.0+

PickerSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

PickerSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

PickerSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

Product.CollectionTaskState

enum · iOS 17.0+

Product.SubscriptionRelationship

struct · iOS 17.0+

Product.SubscriptionRelationship.ArrayLiteralElement

typealias · iOS 17.0+

Product.SubscriptionRelationship.Element

typealias · iOS 17.0+

Product.SubscriptionRelationship.RawValue

typealias · iOS 17.0+

Product.TaskState

enum · iOS 17.0+

ProductIconPhase

enum · iOS 17.0+

ProductView

struct · iOS 17.0+

ProductView.Body

typealias · iOS 17.0+

ProductViewStyle

protocol · iOS 17.0+

ProductViewStyle.Configuration

typealias · iOS 17.0+

ProductViewStyleConfiguration

struct · iOS 17.0+

ProductViewStyleConfiguration.Icon

struct · iOS 17.0+

ProductViewStyleConfiguration.Icon.Body

typealias · iOS 17.0+

ProminentPickerSubscriptionStoreControlStyle

struct · iOS 17.0+

ProminentPickerSubscriptionStoreControlStyle.Body

typealias · iOS 17.0+

ProminentPickerSubscriptionStoreControlStyle.Placement

typealias · iOS 18.0+

ProminentPickerSubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

ProminentPickerSubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

ProminentPickerSubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

PurchaseAction

struct · iOS 17.0+

RegularProductViewStyle

struct · iOS 17.0+

RegularProductViewStyle.Body

typealias · iOS 17.0+

RequestReviewAction

struct · iOS 16.0+

StoreButtonKind

struct · iOS 17.0+

StoreContent

protocol · iOS 18.0+

StoreContentBuilder

struct · iOS 18.0+

StoreView

struct · iOS 17.0+

StoreView.Body

typealias · iOS 17.0+

SubscriptionOfferView

struct · iOS 26.0+

SubscriptionOfferView.Body

typealias · iOS 26.0+

SubscriptionOfferViewButtonKind

struct · iOS 26.0+

SubscriptionOfferViewStyle

protocol · iOS 26.0+

SubscriptionOfferViewStyle.Configuration

typealias · iOS 26.0+

SubscriptionOfferViewStyleConfiguration

struct · iOS 26.0+

SubscriptionOfferViewStyleConfiguration.Icon

struct · iOS 26.0+

SubscriptionOfferViewStyleConfiguration.Icon.Body

typealias · iOS 26.0+

SubscriptionOptionGroup

struct · iOS 18.0+

SubscriptionOptionGroup.Body

typealias · iOS 18.0+

SubscriptionOptionGroupSet

struct · iOS 18.0+

SubscriptionOptionGroupSet.Body

typealias · iOS 18.0+

SubscriptionOptionGroupStyle

protocol · iOS 18.0+

SubscriptionOptionGroupStyleOutput

struct · iOS 18.0+

SubscriptionOptionSection

struct · iOS 18.0+

SubscriptionOptionSection.Body

typealias · iOS 18.0+

SubscriptionPeriodGroupSet

struct · iOS 18.0+

SubscriptionPeriodGroupSet.Body

typealias · iOS 18.0+

SubscriptionStoreButton

struct · iOS 18.0+

SubscriptionStoreButton.Body

typealias · iOS 18.0+

SubscriptionStoreButtonLabel

struct · iOS 17.0+

SubscriptionStoreContentView

struct · iOS 18.0+

SubscriptionStoreContentView.Body

typealias · iOS 18.0+

SubscriptionStoreControlBackground

struct · iOS 17.0+

SubscriptionStoreControlPlacement

protocol · iOS 18.0+

SubscriptionStoreControlPlacementKey

struct · iOS 18.0+

SubscriptionStoreControlStyle

protocol · iOS 17.0+

SubscriptionStoreControlStyle.Configuration

typealias · iOS 17.0+

SubscriptionStoreControlStyle.SubscribeButton

typealias · iOS 18.0+

SubscriptionStoreControlStyle.SubscriptionPicker

typealias · iOS 18.0+

SubscriptionStoreControlStyle.SubscriptionPickerOption

typealias · iOS 18.0+

SubscriptionStoreControlStyleConfiguration

struct · iOS 17.0+

SubscriptionStoreControlStyleConfiguration.Icon

struct · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Icon.Body

typealias · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Option

struct · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Option.ID

typealias · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.PickerOption

struct · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.PickerOption.ID

typealias · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Section

struct · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Section.Footer

struct · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Section.Footer.Body

typealias · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Section.Header

struct · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Section.Header.Body

typealias · iOS 18.0+

SubscriptionStoreControlStyleConfiguration.Section.ID

struct · iOS 18.0+

SubscriptionStorePicker

struct · iOS 18.0+

SubscriptionStorePicker.Body

typealias · iOS 18.0+

SubscriptionStorePickerOption

struct · iOS 18.0+

SubscriptionStorePickerOption.Body

typealias · iOS 18.0+

SubscriptionStorePolicyKind

struct · iOS 17.0+

SubscriptionStoreView

struct · iOS 17.0+

SubscriptionStoreView.Body

typealias · iOS 17.0+

TabsSubscriptionOptionGroupStyle

struct · iOS 18.0+

TupleStoreContent

struct · iOS 18.0+

TupleStoreContent.Body

typealias · iOS 18.0+

Functions and constants

init · iOS 18.0+

init

TypeScript
static init(option: SubscriptionStoreControlStyleConfiguration_Option): Promise<SubscriptionStorePickerOption<AutomaticSubscriptionStorePickerOptionLabel>>
Swift declaration
@MainActor @preconcurrency init(_ option: SubscriptionStoreControlStyleConfiguration.Option) where Label == AutomaticSubscriptionStorePickerOptionLabel

Create a subscription picker option with the standard label. You must declare this as a descendant of a ``SubscriptionStoreControlStyle/SubscriptionPicker``.

init · iOS 18.0+

init

TypeScript
static init43180(option: SubscriptionStoreControlStyleConfiguration_PickerOption): Promise<SubscriptionStorePickerOption<AutomaticSubscriptionStorePickerOptionLabel>>
Swift declaration
@MainActor @preconcurrency init(_ option: SubscriptionStoreControlStyleConfiguration.PickerOption) where Label == AutomaticSubscriptionStorePickerOptionLabel

Create a subscription picker option with the standard label. You must declare this as a descendant of a ``SubscriptionStoreControlStyle/SubscriptionPicker``.

init · iOS 17.0+

init

TypeScript
static init(groupID: string, visibleRelationships?: Product_SubscriptionRelationship): Promise<SubscriptionStoreView<AutomaticSubscriptionStoreMarketingContent>>
Swift declaration
nonisolated init(groupID: String, visibleRelationships: Product.SubscriptionRelationship = .all) where Content == AutomaticSubscriptionStoreMarketingContent

Creates a view to load all subscriptions in a subscription group from the App Store, and merchandise them with automatic marketing content. The `visibleRelationships` parameter only has effects when using a subscription store while someone is actively subscribed to the subscription. For example, if you provide ``StoreKit/Product/SubscriptionRelationship/upgrade`` for the `visibleRelationships` parameter, the subscription store will only show plans with a higher level of service than the active subscription. - Parameters: - groupID: The subscription group identifier to load from the App Store. - visibleRelationships: The kinds of subscription option relationships to be visible when someone is already subscribed to the subscription. - control: The kind of control to use for subscribing.

init · iOS 17.0+

init

TypeScript
static init(configuration: ProductViewStyleConfiguration): Promise<ProductView<ProductViewStyleConfiguration_Icon, ProductViewStyleConfiguration_Icon>>
Swift declaration
nonisolated init(_ configuration: ProductViewStyleConfiguration) where Icon == ProductViewStyleConfiguration.Icon, PlaceholderIcon == ProductViewStyleConfiguration.Icon

Creates a view to merchandise an invididual product based on a configuration for product view style. Use this initializer within the ``ProductViewStyle/makeBody(configuration:)`` method of a ``ProductViewStyle`` to create an instance of the product view you want to style. This is useful for custom product view styles that only modify the current style, instead of implementing a brand new style The following example shows how to create and use custom styles by composing standard styles: ``` struct SpinnerWhenLoadingStyle: ProductViewStyle { public func makeBody(configuration: Configuration) -> some View { switch configuration.state { case .loading: ProgressView() .progressView(.circular) default: ProductView(configuration) } } } ... ProductView(id: "com.example.product") .productViewStyle(SpinnerWhenLoadingStyle()) ``` - Parameter configuration: A configuration for product view style.

method · iOS 17.0+

map

TypeScript
map(transform: ((arg0: unknown) => unknown)): EntitlementTaskState<unknown>
Swift declaration
func map<NewValue>(_ transform: (Value) throws -> NewValue) rethrows -> EntitlementTaskState<NewValue>

Returns a new state, mapping the entitlement value if successful.

method · iOS 17.0+

map

TypeScript
map44069(transform: ((arg0: unknown) => Promise<unknown>)): Promise<EntitlementTaskState<unknown>>
Swift declaration
func map<NewValue>(_ transform: (Value) async throws -> NewValue) async rethrows -> EntitlementTaskState<NewValue>

Returns a new state, mapping the entitlement value if successful.

get · iOS 17.0+

value

TypeScript
get value(): (unknown) | null
Swift declaration
var value: Value? { get }

The entitlement value if the task was successful. Use this as a convenience to access the entitlement value in code that doesn't depend on the reason the value can't be accessed. The value is `nil` while the value is loading, or if it fails to load for any reason.

method · iOS 17.0+

flatMap

TypeScript
flatMap(transform: ((arg0: unknown) => EntitlementTaskState<unknown>)): EntitlementTaskState<unknown>
Swift declaration
func flatMap<NewValue>(_ transform: (Value) throws -> EntitlementTaskState<NewValue>) rethrows -> EntitlementTaskState<NewValue>

Returns a new state, mapping the entitlement value if successful.

method · iOS 17.0+

flatMap

TypeScript
flatMap44951(transform: ((arg0: unknown) => Promise<EntitlementTaskState<unknown>>)): Promise<EntitlementTaskState<unknown>>
Swift declaration
func flatMap<NewValue>(_ transform: (Value) async throws -> EntitlementTaskState<NewValue>) async rethrows -> EntitlementTaskState<NewValue>

Returns a new state, mapping the entitlement value if successful.

get · iOS 17.0+

transaction

TypeScript
get transaction(): (_StoreKit_VerificationResult<_StoreKit_Transaction>) | null
Swift declaration
var transaction: VerificationResult<Transaction>? { get }

The entitlement value if the task was successful. Use this as a convenience to access the transaction value in code that doesn't depend on the reason the transaction is not available. The value is `nil` while the transaction is loading, if it fails to load for any reason, or the customer is not entitled to the product.

init · iOS 26.0+

init

TypeScript
static init(configuration: SubscriptionOfferViewStyleConfiguration): Promise<SubscriptionOfferView<SubscriptionOfferViewStyleConfiguration_Icon, SubscriptionOfferViewStyleConfiguration_Icon>>
Swift declaration
nonisolated init(_ configuration: SubscriptionOfferViewStyleConfiguration) where Icon == SubscriptionOfferViewStyleConfiguration.Icon, PlaceholderIcon == SubscriptionOfferViewStyleConfiguration.Icon
init · iOS 18.0+

init

TypeScript
static init(): Promise<SubscriptionPeriodGroupSet<AutomaticSubscriptionOptionGroupLabel, AutomaticSubscriptionStoreMarketingContent>>
Swift declaration
@MainActor @preconcurrency init() where Label == AutomaticSubscriptionOptionGroupLabel, MarketingContent == AutomaticSubscriptionStoreMarketingContent

Creates a set of subscription option groups, each group containing subscription options with a common period. When you use this initializer, the automatic label represents a localized description of the subscription period of options within each group.

Skipped declarations

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

View.subscriptionPromotionalOffer(offer:signature:)

callback cannot propagate synchronous failure

View.subscriptionPromotionalOffer(offer:compactJWS:)

callback cannot propagate synchronous failure

View.subscriptionIntroductoryOffer(applyOffer:compactJWS:)

callback cannot propagate synchronous failure

View.preferredSubscriptionPricingTerms(_:)

callback cannot propagate synchronous failure

View.refundRequestSheet(for:isPresented:onDismiss:)

This protocol needs associated types that cannot yet cross the bridge.

View.currentEntitlementTask(for:priority:action:)

This protocol needs associated types that cannot yet cross the bridge.

View.manageSubscriptionsSheet(isPresented:)

This protocol needs associated types that cannot yet cross the bridge.

View.manageSubscriptionsSheet(isPresented:subscriptionGroupID:)

This protocol needs associated types that cannot yet cross the bridge.

View.storeButton(_:for:)

This protocol needs associated types that cannot yet cross the bridge.

View.appStoreOverlay(isPresented:configuration:)

callback cannot propagate synchronous failure

View.storeProductTask(for:priority:action:)

This protocol needs associated types that cannot yet cross the bridge.

View.storeProductsTask(for:priority:action:)

This protocol needs associated types that cannot yet cross the bridge.

View.appStoreMerchandising(isPresented:kind:onDismiss:)

This protocol needs associated types that cannot yet cross the bridge.

View.offerCodeRedemption(isPresented:onCompletion:)

This protocol needs associated types that cannot yet cross the bridge.

View.offerCodeRedemption(options:isPresented:onCompletion:)

This protocol needs associated types that cannot yet cross the bridge.

EnvironmentValues.requestReview

The iOS SDK compiler rejected this binding: cannot find type 'SwiftUICore' in scope

View.onInAppPurchaseStart(perform:)

This protocol needs associated types that cannot yet cross the bridge.

View.inAppPurchaseOptions(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.onInAppPurchaseCompletion(perform:)

This protocol needs associated types that cannot yet cross the bridge.

View.preferredSubscriptionOffer(_:)

callback cannot propagate synchronous failure

View.subscriptionStoreControlStyle(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStoreControlStyle(_:placement:)

This declaration needs Swift generic type arguments. (no canonical witness for S)

View.subscriptionOfferViewStyle(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStoreControlBackground(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStoreControlBackground(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStorePickerItemBackground(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStorePickerItemBackground(_:in:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStoreOptionGroupStyle(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStoreSignInAction(_:)

This protocol needs associated types that cannot yet cross the bridge.

View.subscriptionStatusTask(for:priority:action:)

This protocol needs associated types that cannot yet cross the bridge.