QInAppTransaction Class

Contains information about a transaction in the external app store. More...

Header:	#include <QInAppTransaction>
Inherits:	QObject

• List of all members, including inherited members

Public Types

enum	FailureReason { NoFailure, CanceledByUser, ErrorOccurred }
enum	TransactionStatus { Unknown, PurchaseApproved, PurchaseFailed, PurchaseRestored }

Properties

errorString : const QString failureReason : const FailureReason orderId : const QString

product : QInAppProduct* const status : const TransactionStatus timestamp : const QDateTime

Public Functions

virtual QString	errorString() const
virtual QInAppTransaction::FailureReason	failureReason() const
virtual void	finalize() = 0
virtual QString	orderId() const
virtual QString	platformProperty(const QString &propertyName) const
QInAppProduct *	product() const
QInAppTransaction::TransactionStatus	status() const
virtual QDateTime	timestamp() const

Detailed Description

QInAppTransaction contains information about a transaction in the external app store and is usually provided as a result of calling QInAppProduct::purchase(). When the purchase flow has been completed by the user (confirming the purchase, for instance by entering their password), the QInAppStore instance containing the product will emit a QInAppStore::transactionReady() signal with data about the transaction.

The status() provides information on whether the transaction was successful or not. If it was successful, then the application should take appropriate action. When the necessary action has been performed, finalize() should be called. The finalize() function should be called regardless of the status of the transaction.

It is important that the application stores the purchase information before calling finalize(). If a transaction is not finalized (for example because the application was interrupted before it had a chance to save the information), then the transaction will be emitted again the next time the product is registered by QInAppStore::registerProduct().

Transactions can also be emitted after calling QInAppStore::restorePurchases(), at which point a new transaction will be emitted for each previously purchased unlockable product with the status of PurchaseRestored.

Note: Since transactions may under certain circumstances be emitted for the same transaction several times, the application should always check if the transaction has been registered before. Do not expect each transaction to be unique.

Member Type Documentation

enum QInAppTransaction::FailureReason

This enum type specifies the reason for failure if a transaction has the PurchaseFailed status.

Constant	Value	Description
QInAppTransaction::NoFailure	0	The status of the transaction is not PurchaseFailed.
QInAppTransaction::CanceledByUser	1	The transaction was manually canceled by the user.
QInAppTransaction::ErrorOccurred	2	An error occurred, preventing the transaction from completing. See the errorString property for more information on the precise error that occurred.

enum QInAppTransaction::TransactionStatus

This enum type is used to specify the status of the transaction.

Constant	Value	Description
QInAppTransaction::Unknown	0	The transaction status has not been set.
QInAppTransaction::PurchaseApproved	1	The purchase was successfully completed.
QInAppTransaction::PurchaseFailed	2	The purchase was not completed for some reason. This could be because the user canceled the transaction, but it could also for example be caused by a missing network connection.
QInAppTransaction::PurchaseRestored	3	The product has previously been purchased and the purchase has now been restored as a result of calling QInAppStore::restorePurchases().

Member Function Documentation

[pure virtual] void QInAppTransaction::finalize()

Call this when the application has finished performing all necessary reactions to the purchase. If the status is PurchaseApproved, the application should store the information about the transaction in a safe way before finalizing it. All transactions should be finalized.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[virtual] QString QInAppTransaction::platformProperty(const QString &propertyName) const

Returns the platform-specific property given by propertyName.

The following properties are available on Google Play:

• AndroidSignature: The signature of the transaction, as given by the private key for the application.
• AndroidPurchaseData: The purchase data returned by the Google Play store.

These properties can be used to verify the purchase using the public key of your application. It is also possible to have the back-end verify the purchases by passing in the public key before registering products, using QInAppStore::setPlatformProperty().

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.