SKPaymentTransactionObserver Protocol Reference
| Conforms to | |
| Framework | /System/Library/Frameworks/StoreKit.framework |
| Availability | Available in iOS 3.0 and later. |
| Companion guide | |
| Declared in | SKPaymentQueue.h |
Overview
The SKPaymentTransactionObserver protocol declares methods that are implemented by observers of an SKPaymentQueue object.
An observer is called when transactions are updated by the queue or removed from the queue. An observer should process all successful transactions, unlock the functionality purchased by the user, and then finish the transaction by calling the payment queue’s finishTransaction: method.
Tasks
Handling Transactions
Handling Restored Transactions
-
– paymentQueue:restoreCompletedTransactionsFailedWithError: -
– paymentQueueRestoreCompletedTransactionsFinished:
Handling Download Actions
-
– paymentQueue:updatedDownloads:required method
Instance Methods
paymentQueue:removedTransactions:
Tells an observer that one or more transactions have been removed from the queue.
Parameters
- queue
The payment queue that updated the transactions.
- transactions
An array of the transactions that were removed.
Discussion
Your application does not typically need to implement this method but might implement it to update its own user interface to reflect that a transaction has been completed.
Availability
- Available in iOS 3.0 and later.
Declared In
SKPaymentQueue.hpaymentQueue:restoreCompletedTransactionsFailedWithError:
Tells the observer that an error occurred while restoring transactions.
Parameters
- queue
The payment queue that was restoring transactions.
- error
The error that occurred.
Availability
- Available in iOS 3.0 and later.
Declared In
SKPaymentQueue.hpaymentQueue:updatedDownloads:
Tells the observer that the payment queue has updated one or more download objects. (required)
Parameters
- queue
The payment queue that updated the downloads.
- downloads
The download objects that were updated.
Discussion
When a download object is updated, its downloadState property describes how it changed.
Availability
- Available in iOS 6.0 and later.
Declared In
SKPaymentQueue.hpaymentQueue:updatedTransactions:
Tells an observer that one or more transactions have been updated. (required)
Parameters
- queue
The payment queue that updated the transactions.
- transactions
An array of the transactions that were updated.
Discussion
The application should process each transaction by examining the transaction’s transactionState property. If transactionState is SKPaymentTransactionStatePurchased, payment was successfully received for the desired functionality. The application should make the functionality available to the user. If transactionState is SKPaymentTransactionStateFailed, the application can read the transaction’s error property to return a meaningful error to the user.
Once a transaction is processed, it should be removed from the payment queue by calling the payment queue’s finishTransaction: method, passing the transaction as a parameter.
Availability
- Available in iOS 3.0 and later.
Declared In
SKPaymentQueue.hpaymentQueueRestoreCompletedTransactionsFinished:
Tells the observer that the payment queue has finished sending restored transactions.
Parameters
- queue
The payment queue that restored the transactions.
Discussion
This method is called after all restorable transactions have been processed by the payment queue. Your application is not required to do anything in this method.
Availability
- Available in iOS 3.0 and later.
Declared In
SKPaymentQueue.h© 2012 Apple Inc. All Rights Reserved. (Last updated: 2012-09-19)