Interface BridgeInterface

Shared interface implemented by both the SK1 and SK2 bridges. The adapter programs against this interface, not a concrete class.

interface BridgeInterface {
    appStoreReceipt?: null | ApplicationReceipt;
    isSK2?: boolean;
    pendingTransactionsReady?: Promise<void>;
    transactionsForProduct: {
        [productId: string]: string[];
    };
    canMakePayments(success, error): void;
    finish(transactionId, success, error): void;
    getStorefront?(): Promise<undefined | string>;
    init(options, success, error): void;
    load(productIds, success, error): void;
    loadReceipts(callback, errorCb): void;
    manageBilling(callback?): void;
    manageSubscriptions(callback?): void;
    presentCodeRedemptionSheet(callback?): void;
    purchase(productId, quantity, applicationUsername, discount, success, error): void;
    refreshReceipts(successCb, errorCb): void;
    restore(callback?): void;
}

Implemented by

Properties

appStoreReceipt? isSK2? pendingTransactionsReady? transactionsForProduct

Methods

canMakePayments finish getStorefront? init load loadReceipts manageBilling manageSubscriptions presentCodeRedemptionSheet purchase refreshReceipts restore

Properties

Optional appStoreReceipt

appStoreReceipt?: null | ApplicationReceipt

Cached app store receipt

Optional Readonly isSK2

isSK2?: boolean

Whether this bridge uses StoreKit 2

Optional pendingTransactionsReady

pendingTransactionsReady?: Promise<void>

Resolves when pending transactions from the native queue have been processed

transactionsForProduct

transactionsForProduct: {
    [productId: string]: string[];
}

Transaction IDs grouped by product

Type declaration

  • [productId: string]: string[]

Methods

canMakePayments

  • canMakePayments(success, error): void

  • Parameters

    • success: (() => void)
        • (): void

        • Returns void

    • error: ((message) => void)
        • (message): void

        • Parameters

          • message: string

          Returns void

    Returns void

finish

  • finish(transactionId, success, error): void

  • Parameters

    • transactionId: string
    • success: (() => void)
        • (): void

        • Returns void

    • error: ((msg) => void)
        • (msg): void

        • Parameters

          • msg: string

          Returns void

    Returns void

Optional getStorefront

  • getStorefront(): Promise<undefined | string>

  • Retrieve the storefront country code (alpha-3 on iOS)

    Returns Promise<undefined | string>

init

  • init(options, success, error): void

  • Parameters

    • options: Partial<BridgeOptions>
    • success: (() => void)
        • (): void

        • Returns void

    • error: ((code, message) => void)

    Returns void

load

  • load(productIds, success, error): void

  • Parameters

    • productIds: string[]
    • success: ((validProducts, invalidProductIds) => void)
        • (validProducts, invalidProductIds): void

        • Parameters

          Returns void

    • error: ((code, message) => void)

    Returns void

loadReceipts

  • loadReceipts(callback, errorCb): void

  • Parameters

    • callback: ((receipt) => void)
    • errorCb: ((code, message) => void)

    Returns void

manageBilling

  • manageBilling(callback?): void

  • Parameters

    Returns void

manageSubscriptions

  • manageSubscriptions(callback?): void

  • Parameters

    Returns void

presentCodeRedemptionSheet

  • presentCodeRedemptionSheet(callback?): void

  • Parameters

    Returns void

purchase

  • purchase(productId, quantity, applicationUsername, discount, success, error): void

  • Parameters

    • productId: string
    • quantity: number
    • applicationUsername: undefined | string
    • discount: undefined | PaymentDiscount
    • success: (() => void)
        • (): void

        • Returns void

    • error: (() => void)
        • (): void

        • Returns void

    Returns void

refreshReceipts

  • refreshReceipts(successCb, errorCb): void

  • Parameters

    • successCb: ((receipt) => void)
    • errorCb: ((code, message) => void)

    Returns void

restore

  • restore(callback?): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

appStoreReceiptisSK2pendingTransactionsReadytransactionsForProductcanMakePaymentsfinishgetStorefrontinitloadloadReceiptsmanageBillingmanageSubscriptionspresentCodeRedemptionSheetpurchaserefreshReceiptsrestore