net.rim.blackberry.payment.Purchase

Purchase

Properties | Methods | Constants


Packagenet.rim.blackberry.payment
Classpublic class Purchase
InheritancePurchase Inheritance Object

Represents a successful in-app purchase.

Class information:
PlayBook Tablet OS Version:   1.0.6



Public Properties

 PropertyDefined By
  date : Date
[read-only] Retrieves the date this purchase was made.
Purchase
  digitalGoodID : String
[read-only] Retrieves the ID of the purchased digital good.
Purchase
  digitalGoodSKU : String
[read-only] Retrieves the SKU of the purchased digital good.
Purchase
  endDate : Date
[read-only] Retrieves the endDate for this subscription purchase.
Purchase
  intialPeriod : Number
[read-only] Retrieves the intial period for this subscription purchase.
Purchase
  itemState : String
[read-only] Retrieves the state of this digital good purchase.
Purchase
  licenseKey : String
[read-only] Retrieves the license key for this purchase, or null if the purchased digital good does not have a license key.
Purchase
  metaData : String
[read-only] Retrieves the metadata for this purchase, or null if no metadata was included with the purchase.
Purchase
  purchaseID : String
[read-only] Retrieves the purchase ID for this purchase.
Purchase
  startDate : Date
[read-only] Retrieves the startDate for this subscription purchase.
Purchase

Public Methods

 MethodDefined By
  
Purchase(i_date:String, i_digitalGoodID:String, i_digitalGoodSKU:String, i_licenseKey:String, i_metaData:String, i_purchaseID:String, i_startDate:String = null, i_endDate:String = null, i_initialPeriod:String = null, i_itemState:String = null)
Represents a successful in-app purchase.
Purchase

Public Constants

 ConstantDefined By
  CANCELED : String = purchaseCanceled
[static]
Purchase
  OWNED : String = purchaseOwned
[static]
Purchase
  REFUNDED : String = purchaseRefunded
[static]
Purchase
  RENEWED : String = purchaseRenewed
[static]
Purchase
  SUBSCRIBED : String = purchaseSubscribed
[static]
Purchase

Property Detail

date


date:Date  [read-only]

Retrieves the date this purchase was made.


Implementation

public function get date():Date

digitalGoodID


digitalGoodID:String  [read-only]

Retrieves the ID of the purchased digital good.


Implementation

public function get digitalGoodID():String

digitalGoodSKU


digitalGoodSKU:String  [read-only]

Retrieves the SKU of the purchased digital good.


Implementation

public function get digitalGoodSKU():String

endDate


endDate:Date  [read-only]

Retrieves the endDate for this subscription purchase.


Implementation

public function get endDate():Date

intialPeriod


intialPeriod:Number  [read-only]

Retrieves the intial period for this subscription purchase.


Implementation

public function get intialPeriod():Number

itemState


itemState:String  [read-only]

Retrieves the state of this digital good purchase. Possible States: Purchase.OWNED = purchaseOwned Purchase.SUBSCRIBED = purchaseSubscribed Purchase.CANCELED = purchaseCancelled Purchase.REFUNDED = purchaseRefunded Purchase.RENEWED = purchaseRenewed


Implementation

public function get itemState():String

licenseKey


licenseKey:String  [read-only]

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


Implementation

public function get licenseKey():String

metaData


metaData:String  [read-only]

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


Implementation

public function get metaData():String

purchaseID


purchaseID:String  [read-only]

Retrieves the purchase ID for this purchase.


Implementation

public function get purchaseID():String

startDate


startDate:Date  [read-only]

Retrieves the startDate for this subscription purchase.


Implementation

public function get startDate():Date

Constructor Detail

Purchase()


public function Purchase(i_date:String, i_digitalGoodID:String, i_digitalGoodSKU:String, i_licenseKey:String, i_metaData:String, i_purchaseID:String, i_startDate:String = null, i_endDate:String = null, i_initialPeriod:String = null, i_itemState:String = null)

Represents a successful in-app purchase.

Parameters

i_date:String
i_digitalGoodID:String
i_digitalGoodSKU:String
i_licenseKey:String
i_metaData:String
i_purchaseID:String
i_startDate:String (default = null)
i_endDate:String (default = null)
i_initialPeriod:String (default = null)
i_itemState:String (default = null)

Constant Detail

CANCELED


public static const CANCELED:String = purchaseCanceled

OWNED


public static const OWNED:String = purchaseOwned

REFUNDED


public static const REFUNDED:String = purchaseRefunded

RENEWED


public static const RENEWED:String = purchaseRenewed

SUBSCRIBED


public static const SUBSCRIBED:String = purchaseSubscribed