Class Bridge

constructor

• new Bridge(): CdvPurchase.AppleAppStore.Bridge.Bridge

• Returns CdvPurchase.AppleAppStore.Bridge.Bridge

Optional appStoreReceipt

onFailed

onPurchased

onRestored

options

transactionsForProduct

canMakePayments

• canMakePayments(success, error): void

• Checks if device/user is allowed to make in-app purchases

  Parameters

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

      • Returns void

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

      • Parameters

        • message: string

        Returns void

  Returns void

finalizeTransactionUpdates

• finalizeTransactionUpdates(): 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

init

• init(options, success, error): void

• Initialize the AppStore bridge.

  This calls the native "setup" method from the "InAppPurchase" Objective-C class.

  Parameters

  • options: Partial<BridgeOptions>

    Options for the bridge
  • success: (() => void)

    Called when the bridge is ready

    • • (): void

      • Returns void

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

    Called when the bridge failed to initialize

    • • (code, message): void

      • Parameters

        • code: CdvPurchase.ErrorCode
        • message: string

        Returns void

  Returns void

lastTransactionUpdated

• lastTransactionUpdated(): void

• Returns void

load

• load(productIds, success, error): void

• Retrieves localized product data, including price (as localized string), name, description of multiple products.

  Parameters

  • productIds: string[]

    An array of product identifier strings.
  • success: ((validProducts, invalidProductIds) => void)
    • • (validProducts, invalidProductIds): void

      • Parameters

        • validProducts: ValidProduct[]
        • invalidProductIds: string[]

        Returns void

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

      • Parameters

        • code: CdvPurchase.ErrorCode
        • message: string

        Returns void

  Returns void

loadReceipts

• loadReceipts(callback, errorCb): void

• Parameters

  • callback: ((receipt) => void)
    • • (receipt): void

      • Parameters

        • receipt: ApplicationReceipt

        Returns void

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

      • Parameters

        • code: CdvPurchase.ErrorCode
        • message: string

        Returns void

  Returns void

manageBilling

• manageBilling(callback?): void

• Parameters

  • Optional callback: Callback<any>

  Returns void

manageSubscriptions

• manageSubscriptions(callback?): void

• Parameters

  • Optional callback: Callback<any>

  Returns void

parseReceiptArgs

• parseReceiptArgs(args): ApplicationReceipt

• Parameters

  • args: RawReceiptArgs

  Returns ApplicationReceipt

presentCodeRedemptionSheet

• presentCodeRedemptionSheet(callback?): void

• Parameters

  • Optional callback: Callback<any>

  Returns void

processPendingTransactions

• processPendingTransactions(): void

• Returns void

purchase

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

• Makes an in-app purchase.

  Parameters

  • productId: string

    The product identifier. e.g. "com.example.MyApp.myproduct"
  • quantity: number

    Quantity of product to purchase
  • 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)
    • • (receipt): void

      • Parameters

        • receipt: ApplicationReceipt

        Returns void

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

      • Parameters

        • code: CdvPurchase.ErrorCode
        • message: string

        Returns void

  Returns void

restore

• restore(callback?): void

• Asks the payment queue to restore previously completed purchases.

  The restored transactions are passed to the onRestored callback, so make sure you define a handler for that first.

  Parameters

  • Optional callback: Callback<any>

  Returns void

restoreCompletedTransactionsFailed

• restoreCompletedTransactionsFailed(errorCode): void

• Parameters

  • errorCode: CdvPurchase.ErrorCode

  Returns void

restoreCompletedTransactionsFinished

• restoreCompletedTransactionsFinished(): void

• Returns void

transactionUpdated

• transactionUpdated(state, errorCode, errorText, transactionIdentifier, productId, transactionReceipt, originalTransactionIdentifier, transactionDate, discountId): void

• Parameters

  • state: CdvPurchase.AppleAppStore.Bridge.TransactionState
  • errorCode: undefined | CdvPurchase.ErrorCode
  • errorText: undefined | string
  • transactionIdentifier: string
  • productId: string
  • transactionReceipt: never
  • originalTransactionIdentifier: undefined | string
  • transactionDate: undefined | string
  • discountId: undefined | string

  Returns void