net.rimlib.blackberry.api.payment
Class PurchaseArguments

java.lang.Object
  extended by net.rimlib.blackberry.api.payment.PurchaseArguments

public final class PurchaseArguments
extends Object

Represents a set of arguments used for initiating a digital good purchase via PaymentEngine.purchase(PurchaseArguments). Instances of this class must be constructed with a PurchaseArgumentsBuilder. Refer to PurchaseArgumentsBuilder for an in-depth explanation of how to set the arguments and how they are used in the purchase flow.

See Also:
PurchaseArgumentsBuilder

Method Summary
 String getDigitalGoodId()
          Retrieves the ID of the digital good being purchased.
 String getDigitalGoodName()
          Retrieves the name of the digital good being purchased.
 String getDigitalGoodSku()
          Retrieves the SKU of the digital good being purchased.
 String getMetadata()
          Retrieves the metadata associated with the purchase.
 net.rim.device.api.system.Bitmap getPurchasingAppIcon()
          Retrieves the icon of the application requesting the purchase.
 String getPurchasingAppName()
          Retrieves the name of the application requesting the purchase.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDigitalGoodId

public String getDigitalGoodId()
Retrieves the ID of the digital good being purchased.

Returns:
The ID of the digital good being purchased.

getDigitalGoodSku

public String getDigitalGoodSku()
Retrieves the SKU of the digital good being purchased.

Returns:
The SKU of the digital good being purchased.

getDigitalGoodName

public String getDigitalGoodName()
Retrieves the name of the digital good being purchased.

Returns:
The name of the digital good being purchased.

getPurchasingAppName

public String getPurchasingAppName()
Retrieves the name of the application requesting the purchase.

Returns:
The name of the application requesting the purchase.

getPurchasingAppIcon

public net.rim.device.api.system.Bitmap getPurchasingAppIcon()
Retrieves the icon of the application requesting the purchase.

Returns:
The icon of the application requesting the purchase.

getMetadata

public String getMetadata()
Retrieves the metadata associated with the purchase.

Returns:
The metadata associated with the purchase.


Copyright © 2010 Research In Motion Limited. All Rights Reserved.