Purchase
This object encapsulates the attributes of a purchase.
It may be aquired by calling to one of the blackberry.payment methods.
Supported Platform(s)
- BlackBerry OS 5.0+
- BlackBerry PlayBook
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| date | Y | Y | Y | Y | |
| digitalGoodID | Y | Y | Y | Y | |
| digitalGoodSKU | Y | Y | Y | Y | |
| licenseKey | Y | Y | Y | Y | |
| metaData | Y | Y | Y | Y | |
| transactionID | 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 ID | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| <feature id="blackberry.payment" /> | Y | Y | Y | Y |
| Permission Elements (PlayBook Only) |
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| date | String |
The Epoch time represention of the date this purchase was made.
|
- BlackBerry OS 5.0+
- BlackBerry PlayBook |
| digitalGoodID | String |
The ID of the purchased digital good.
|
- BlackBerry OS 5.0+
- BlackBerry PlayBook |
| digitalGoodSKU | String |
The SKU of the purchased digital good.
|
- BlackBerry OS 5.0+
- BlackBerry PlayBook |
| licenseKey | String |
Represents the license key for this purchase, or null if the purchased digital good does not have a license key.
|
- BlackBerry OS 5.0+
- BlackBerry PlayBook |
| metaData | String |
The metadata for this purchase, or null if no metadata was included with the purchase.
|
- BlackBerry OS 5.0+
- BlackBerry PlayBook |
| transactionID | String |
The transaction ID for this purchase.
|
- BlackBerry OS 5.0+
- BlackBerry PlayBook |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)