iOS presentExternalPurchaseNoticeSheetIOS

Present Apple's compliance notice sheet (iOS 17.4+, macOS 14.4+).

Wraps ExternalPurchase.presentNoticeSheet() — returns a token if the user accepts. iOS 17.4+, macOS 14.4+. See the Apple StoreKit reference.

Signature

swift
func presentExternalPurchaseNoticeSheetIOS() async throws -> ExternalPurchaseNoticeResultIOS

struct ExternalPurchaseNoticeResultIOS {
    let result: ExternalPurchaseNoticeAction
    let error: String?
    let externalPurchaseToken: String?
}

Returns#

Promise<ExternalPurchaseNoticeResultIOS> — carries:

  • result ('continue' | 'dismissed') — User action on the notice sheet — see ExternalPurchaseNoticeAction.
  • externalPurchaseToken (string?) — Reporting token returned by Apple when the user continues (result === 'continue'). Pass to your backend / send to Apple's External Purchase Server API.
  • error (string?) — Populated when the sheet failed to present.

Example

swift
let result = try await OpenIapModule.shared.presentExternalPurchaseNoticeSheetIOS()