Purchase

This object encapsulates the attributes of a purchase.

It may be acquired by calling one of the blackberry.payment methods.


Supported Platform(s)

- BlackBerry OS 5.0+
- BlackBerry PlayBook 1.0+
- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
date Y Y Y Y Y Y 
digitalGoodID Y Y Y Y Y Y 
digitalGoodSKU Y Y Y Y Y Y 
extraParameters       Y Y Y 
licenseKey Y Y Y Y Y Y 
metaData Y Y Y Y Y Y 
purchaseID Y Y Y Y Y Y 
transactionID Y Y Y Y Y Y 

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.payment" /> Y Y Y Y Y Y 

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties

String date
String digitalGoodID
String digitalGoodSKU
Object extraParameters
String licenseKey
String metaData
String purchaseID
String transactionID

Properties

String date


The Epoch time represention of the date this purchase was made.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

String digitalGoodID


The ID of the purchased digital good.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

String digitalGoodSKU


The SKU of the purchased digital good.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

Object extraParameters


A set of key/value pairs to be associated with a purchase request. Extra parameters (not necessarily corresponding to any that were passed in) may also be present in the purchasedItem returned from a successful blackberry.payment.purchase. Only relevant to a Purchase object at the time of the transaction (would not be present in a blackberry.payment.getExistingPurchases result).


Supported Platforms
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

String licenseKey


Represents the license key for this purchase, or null if the purchased digital good does not have a license key.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

String metaData


The metadata for this purchase, or null if no metadata was included with the purchase.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

String purchaseID


The purchaseID for this purchase.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

String transactionID


The transaction ID for this purchase.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:09 GMT-0500 (EST)