iOS showExternalPurchaseCustomLinkNoticeIOS

Display the system disclosure notice for ExternalPurchaseCustomLink (iOS 18.1+, macOS 15.1+). Apple requires this sheet to be presented after a deliberate customer interaction, before you can route the user to an external purchase URL.

Wraps ExternalPurchaseCustomLink.showNotice(type:) — required disclosure sheet before linking out. iOS 18.1+, macOS 15.1+. See the Apple StoreKit reference.

Signature

swift
func showExternalPurchaseCustomLinkNoticeIOS(
    _ noticeType: ExternalPurchaseCustomLinkNoticeTypeIOS
) async throws -> ExternalPurchaseCustomLinkNoticeResultIOS

Parameters#

  • noticeType (required, ExternalPurchaseCustomLinkNoticeTypeIOS) — Disclosure style.

Returns#

Promise<ExternalPurchaseCustomLinkNoticeResultIOS> — carries:

  • continued (boolean) — Whether the user chose to continue to the external purchase.
  • error (string?) — Populated when the sheet fails to present.

Example

swift
let result = try await OpenIapModule.shared.showExternalPurchaseCustomLinkNoticeIOS(
    .browser
)

ExternalPurchaseCustomLinkNoticeTypeIOS currently has a single value: 'browser' (case-sensitive — Swift / Kotlin / Dart spell it as .browser / .Browser).