A B C D E G I M N O P R S T U V W _

A

AppWorldUpdateRequired - Exception in net.rimlib.blackberry.api.paymentsdk

Thrown by the PaymentEngine when the invoking application was not installed on the BlackBerry device via BlackBerry App World.

AppWorldUpdateRequired(String) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.AppWorldUpdateRequired

Creates an exception with the given detail message.

ATTR_ENDDATE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_ID - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_INITIALSUBSCRIPTIONPERIOD - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_LICENSEKEY - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_PURCHASEDATE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_PURCHASEID - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_STARTDATE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

ATTR_STATUS - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

B

build() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Builds a PurchaseArguments object containing all the arguments set with the withXXX methods.

C

cancel(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Initiates a request to cancel the virtual good given it's TransactionID.

CANCELED - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Purchase

The Constant CANCELED.

checkExisting(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Returns true if the logged in BBID user has rights for this SKU at the time of calling this method.

D

DigitalGoodNotFoundException - Exception in net.rimlib.blackberry.api.paymentsdk

Thrown by the PaymentEngine when the digital good being purchased cannot be found on the Payment Service server.

DigitalGoodNotFoundException(String) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.DigitalGoodNotFoundException

Creates an exception with the given detail message.

E

ExistingPurchasesResult - Interface in net.rimlib.blackberry.api.paymentsdk

Represents the result of an existing purchases retrieval attempt.

G

get(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Returns a Purchase object if the logged in BBID user has rights for this SKU at the time of calling this method.

getAdditionalProperties() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

getData() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

getDate() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the date this purchase was made.

getDate() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

Returns the date when the purchase attempt represented by this PurchaseResult was made.

getDigitalGoodId() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the ID of the purchased digital good.

getDigitalGoodId() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves the ID of the digital good being purchased.

getDigitalGoodId() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

Retrieves the ID of the purchased digital good, or null if this purchase result did not succeed.

getDigitalGoodName() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves the name of the digital good being purchased.

getDigitalGoodSku() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the SKU of the purchased digital good.

getDigitalGoodSku() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves the SKU of the digital good being purchased.

getDigitalGoodSku() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

Retrieves the SKU of the purchased digital good, or null if this purchase result did not succeed.

getEndDate() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the date the subscription expires.

getExistingPurchases(boolean) - Method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Retrieves a record of the previous successful purchases made by the user from within the calling application.

getFailureReason() - Method in exception net.rimlib.blackberry.api.paymentsdk.PaymentException

Retrieves a constant representing the reason this result is unsuccessful, or REASON_NONE if this result is successful.

getFailureReason() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

getFailureReason() - Method in interface net.rimlib.blackberry.api.paymentsdk.Result

Retrieves a constant representing the reason this result is unsuccessful, or REASON_NONE if this result is successful.

getInitialSubscriptionPeriod() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the duration of the initial subscription period.

getInstance() - Static method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Retrieves an instance of the PaymentEngine class, or null if the BlackBerry device does not have BlackBerry App World 3.0 or higher installed.

getItemState() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the state of this item.

getLicenseKey() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

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

getLicenseKey() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

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

getMetadata() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

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

getMetadata() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves the metadata associated with the purchase.

getMetadata() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

Retrieves the metadata for this purchase result, or null if this purchase result did not succeed (or no metadata was included with the purchase).

getPrice(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Initiates a request for the price of a digital good.

getPriceSetValue(String) - Method in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

Returns the String representing the value defined by the above keys.

getPurchases() - Method in interface net.rimlib.blackberry.api.paymentsdk.ExistingPurchasesResult

Retrieves the existing successful purchases, which is non-null but may be empty.

getPurchasingAppIcon() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves the icon of the application requesting the purchase.

getPurchasingAppName() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves the name of the application requesting the purchase.

getStartDate() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the date this subscription starts.

getStatusMessage() - Method in interface net.rimlib.blackberry.api.paymentsdk.Result

Retrieves a human-readable status message that an application can use relay this result to the end user.

getTransactionId() - Method in interface net.rimlib.blackberry.api.paymentsdk.Purchase

Retrieves the transaction ID for this purchase.

getTransactionId() - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

Retrieves the transaction ID for this purchase result, or null if this purchase result did not succeed.

getValue(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves value associated with the tag or key passed in.

getValue(String) - Method in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

getVendorContentId() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves value of the PID (From the Vendor's separate BBID for this user), provided by the vendor.

getVendorCustomerId() - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

Retrieves value of the PID (From the Vendor's separate BBID for this user), provided by the vendor.

I

IllegalApplicationException - Exception in net.rimlib.blackberry.api.paymentsdk

Thrown by the PaymentEngine when the invoking application was not installed on the BlackBerry device via BlackBerry App World.

IllegalApplicationException(String) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.IllegalApplicationException

Creates an exception with the given detail message.

isAppWorldInstalledAndAtCorrectVersion() - Static method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Provides a method to check if a version of AppWorld that supports this version of the PS SDK is installed.

isSuccessful() - Method in interface net.rimlib.blackberry.api.paymentsdk.Result

Determines whether or not this is a successful result.

M

META_DATA - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

N

net.rimlib.blackberry.api.paymentsdk - package net.rimlib.blackberry.api.paymentsdk

NO_VALUE_SET - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Purchase

O

OWNED - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Purchase

The Constant OWNED.

P

PaymentEngine - Class in net.rimlib.blackberry.api.paymentsdk

API that permits BlackBerry device users to initiate the purchase of digital goods from within your application.

PaymentException - Exception in net.rimlib.blackberry.api.paymentsdk

Thrown when a generic failure occurs with one of the PaymentEngine methods.

PaymentException(String) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.PaymentException

Creates an exception with the given detail message.

PaymentException(String, int) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.PaymentException

Creates an exception with the given detail message.

PaymentServerException - Exception in net.rimlib.blackberry.api.paymentsdk

Thrown by the PaymentEngine when a failure occurs due to a problem with the Payment Service server.

PaymentServerException(String) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.PaymentServerException

Creates an exception with the given detail message.

PRICE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

The Constant PRICE.

PriceSet - Interface in net.rimlib.blackberry.api.paymentsdk

Class that encapsulates a set of String values representing prices for subscription goods with the set of tags to retrieve them.

purchase(PurchaseArguments) - Method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Initiates the purchase of a digital good.

Purchase - Interface in net.rimlib.blackberry.api.paymentsdk

Represents a successful in-app purchase.

PURCHASE_VENDOR_CONTENT_ID - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

PURCHASE_VENDOR_CUSTOMER_ID - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

PurchaseArguments - Class in net.rimlib.blackberry.api.paymentsdk

Represents a set of arguments used for initiating a digital good purchase via PaymentEngine.purchase(PurchaseArguments).

PurchaseArguments(String, String, String, String, Bitmap, String, Hashtable) - Constructor for class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

PurchaseArgumentsBuilder - Class in net.rimlib.blackberry.api.paymentsdk

Builds a PurchaseArguments object used for initiating a digital good purchase via PaymentEngine.purchase(PurchaseArguments).

PurchaseArgumentsBuilder() - Constructor for class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Creates a new builder.

PurchaseResult - Interface in net.rimlib.blackberry.api.paymentsdk

Represents the result of an in-app purchase attempt.

R

REASON_APP_WORLD_NOT_CORRECT_VERSION - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the #getFailureReason() method when a call failed because the version of AppWorld on the device is less than the required version.

REASON_ARGUMENTS_ERROR - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the #getFailureReason() method when a call failed because the digital arguments passed to the PS SDK were not correct.

REASON_CANCELED - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the getFailureReason method when a result failed because it was canceled by the user.

REASON_GOOD_NOT_FOUND - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the #getFailureReason() method when a call t failed because the digital good being purchased was not found on the App World server.

REASON_ILLEGAL_APPLICATION - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the getFailureReason method when a result failed because the calling application was not installed via App World 2.1.

REASON_NONE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the getFailureReason method when a result is successful.

REASON_SERVER_ERROR - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the getFailureReason method when a result failed because of a server error.

REASON_UNKNOWN - Static variable in interface net.rimlib.blackberry.api.paymentsdk.ResultCodes

Constant that is returned from the getFailureReason method when a result failed for an unknown reason.

REFUNDED - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Purchase

The Constant REFUNDED.

RENEW - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Purchase

The Constant RENEW.– subscribed

REQUESTID_REQUESTOR_PID - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

REQUESTOID_PAYER_DISPLAY_NAME - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

REQUESTOID_REQUESTOR_DISPLAY_NAME - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

REQUESTOID_URL_DISPLAY_NAME_OF_URL - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

REQUESTOID_URL_TO_LAUNCH_VENDOR_APPLICATION - Static variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Result - Interface in net.rimlib.blackberry.api.paymentsdk

Represents the result of a payment-related transaction attempt, such as making an in-app purchase or retrieving existing purchases.

ResultCodes - Interface in net.rimlib.blackberry.api.paymentsdk

RETURN_CODE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Result

S

STATUS_MESSAGE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Result

SUB_STATUS - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

SUBSCRIBED - Static variable in interface net.rimlib.blackberry.api.paymentsdk.Purchase

The Constant SUBSCRIBED.

SUBSCRIPTION_INITIAL_PERIOD - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

The Constant SUBSCRIPTION_INITIAL_PERIOD.

SUBSCRIPTION_INITIAL_PRICE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

The Constant SUBSCRIPTION_INITIAL_PRICE.

SUBSCRIPTION_PERIOD_NAME - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

The Constant SUBSCRIPTION_PERIOD_NAME.

SUBSCRIPTION_RENEWAL_PRICE - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

The Constant SUBSCRIPTION_RENEWAL_PRICE.

T

TAG_PERIOD - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

TAG_SKU - Static variable in interface net.rimlib.blackberry.api.paymentsdk.PurchaseResult

toString() - Method in interface net.rimlib.blackberry.api.paymentsdk.PriceSet

U

upDateAppWorld() - Static method in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

Starts the process of upgrading App World to the current version by opening the browser on the device to the AppWorld upgrade page.

UserCancelException - Exception in net.rimlib.blackberry.api.paymentsdk

Thrown if one of the PaymentEngine methods fails because the action is cancelled by the user.

UserCancelException(String) - Constructor for exception net.rimlib.blackberry.api.paymentsdk.UserCancelException

Creates an exception with the given detail message.

V

VERSION_CODE - Static variable in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

A variable to track releases of the SDK

VERSION_NAME - Static variable in class net.rimlib.blackberry.api.paymentsdk.PaymentEngine

A variable to track the version of this SDK

W

withDigitalGoodId(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the ID of the digital good to be purchased.

withDigitalGoodName(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the name of the digital good to be purchased.

withDigitalGoodSku(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the SKU of the digital good to be purchased.

withMetadata(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the metadata to be associated with the purchase.

withProperty(String, String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets additional properties that will be passed to the PS with the given tag and value.

withPurchasingAppIcon(Bitmap) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the icon of the application requesting the purchase.

withPurchasingAppName(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the name of the application requesting the purchase.

withVendorCustomerId(String) - Method in class net.rimlib.blackberry.api.paymentsdk.PurchaseArgumentsBuilder

Sets the PID (From the Vendor's separate BBID for this user), provided by the vendor.

_

_additionalProperties - Variable in class net.rimlib.blackberry.api.paymentsdk.PurchaseArguments

A B C D E G I M N O P R S T U V W _