Interface BridgeOptions

interface BridgeOptions {
    autoFinish: boolean;
    debug: boolean;
    deferred: ((productId) => void);
    error: ((code, message, options?) => void);
    finished: ((transactionIdentifier, productId) => void);
    log: ((message) => void);
    purchaseEnqueued: ((productId, quantity) => void);
    purchaseFailed: ((productId, code, message) => void);
    purchased: ((transactionIdentifier, productId, originalTransactionIdentifier?, transactionDate?, discountId?) => void);
    purchasing: ((productId) => void);
    ready: (() => void);
    receiptsRefreshed: ((receipt) => void);
    restoreCompleted: (() => void);
    restoreFailed: ((errorCode) => void);
    restored: ((transactionIdentifier, productId) => void);
}

Hierarchy (view full)

Properties

autoFinish debug deferred error finished log purchaseEnqueued purchaseFailed purchased purchasing ready receiptsRefreshed restoreCompleted restoreFailed restored

Properties

autoFinish

autoFinish: boolean

Auto-finish transaction

debug

debug: boolean

True to enable lot of logs on the console

deferred

deferred: ((productId) => void)

Called when a transaction is deferred (waiting for approval)

Type declaration

    • (productId): void

    • Parameters

      • productId: string

      Returns void

error

error: ((code, message, options?) => void)

Type declaration

    • (code, message, options?): void

    • Parameters

      • code: CdvPurchase.ErrorCode
      • message: string
      • Optional options: {
            productId: string;
            quantity?: number;
        }
        • productId: string
        • Optional quantity?: number

      Returns void

finished

finished: ((transactionIdentifier, productId) => void)

Called when a transaction is in "finished" state

Type declaration

    • (transactionIdentifier, productId): void

    • Parameters

      • transactionIdentifier: string
      • productId: string

      Returns void

log

log: ((message) => void)

Custom logger for the bridge

Type declaration

    • (message): void

    • Parameters

      • message: string

      Returns void

purchaseEnqueued

purchaseEnqueued: ((productId, quantity) => void)

Called when a transaction has been enqueued

Type declaration

    • (productId, quantity): void

    • Parameters

      • productId: string
      • quantity: number

      Returns void

purchaseFailed

purchaseFailed: ((productId, code, message) => void)

Called when a transaction failed.

Watch out for ErrorCode.PAYMENT_CANCELLED (means user closed the dialog)

Type declaration

    • (productId, code, message): void

    • Parameters

      Returns void

purchased

purchased: ((transactionIdentifier, productId, originalTransactionIdentifier?, transactionDate?, discountId?) => void)

Called when a transaction is in "Purchased" state

Type declaration

    • (transactionIdentifier, productId, originalTransactionIdentifier?, transactionDate?, discountId?): void

    • Parameters

      • transactionIdentifier: string
      • productId: string
      • Optional originalTransactionIdentifier: string
      • Optional transactionDate: string
      • Optional discountId: string

      Returns void

purchasing

purchasing: ((productId) => void)

Called when a transaction is in "purchasing" state

Type declaration

    • (productId): void

    • Parameters

      • productId: string

      Returns void

ready

ready: (() => void)

Called when the bridge is ready (after setup)

Type declaration

    • (): void

    • Returns void

receiptsRefreshed

receiptsRefreshed: ((receipt) => void)

Called when the application receipt is refreshed

Type declaration

restoreCompleted

restoreCompleted: (() => void)

Called when a call to "restore" is complete

Type declaration

    • (): void

    • Returns void

restoreFailed

restoreFailed: ((errorCode) => void)

Called when a call to "restore" failed

Type declaration

restored

restored: ((transactionIdentifier, productId) => void)

Called when a transaction is in "restored" state

Type declaration

    • (transactionIdentifier, productId): void

    • Parameters

      • transactionIdentifier: string
      • productId: string

      Returns void

Settings

Member Visibility

Theme

On This Page

autoFinishdebugdeferrederrorfinishedlogpurchaseEnqueuedpurchaseFailedpurchasedpurchasingreadyreceiptsRefreshedrestoreCompletedrestoreFailedrestored