From dfa3dcca1c940b7b388ab9f7e5b481ea68302ae2 Mon Sep 17 00:00:00 2001 From: Mike Waugh Date: Thu, 1 Dec 2011 16:48:51 -0400 Subject: [PATCH] modifications in response to code review --- api/blackberry_payment.js | 41 ++++++++++++++------------------------- 1 file changed, 15 insertions(+), 26 deletions(-) diff --git a/api/blackberry_payment.js b/api/blackberry_payment.js index 0899612e2a..62710f2cba 100644 --- a/api/blackberry_payment.js +++ b/api/blackberry_payment.js @@ -63,6 +63,7 @@ blackberry.payment = { *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * * Note: The actual values may be different when {@link blackberry.payment.developmentMode} equals true. + * @since Version 1.0 * @PB10 * @BB50+ */ @@ -90,6 +91,7 @@ blackberry.payment = { *
  • Digital Good not Found = 4
    • *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * + * @since Version 1.0 * @PB10 * @BB50+ * @example @@ -126,7 +128,7 @@ blackberry.payment = { }, /** * @function - * @description Initiates a request for the price of a digital good. The request can be initiated by using either the ID or the SKU of the digital good to be purchased, but it is not necessary to provide both. + * @description Initiates a request for the price of a digital good. The request can be initiated by using either the digital good ID or the digital good SKU to be purchased, but it is not necessary to provide both. * @param {Object} args Contains information about the digital good to query. * @callback {String} args.digitalGoodSKU SKU of the digital good to query. * @callback {String} args.digitalGoodID ID of the digital good to query. @@ -152,7 +154,7 @@ blackberry.payment = { *
  • Digital Good not Found = 4
    • *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * - * @PB10 + * @since Version 1.5.0 * @BB50+ * @example * <script type="text/javascript"> @@ -210,7 +212,7 @@ blackberry.payment = { *
  • Digital Good not Found = 4
    • *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * - * @PB10 + * @since Version 1.5.0 * @BB50+ * @example * <script type="text/javascript"> @@ -246,12 +248,12 @@ blackberry.payment = { * } * </script> */ - get : function( sku, callbackOnSuccess, callbackOnFailure ) { + get : function( digitalGoodSKU, callbackOnSuccess, callbackOnFailure ) { }, /** * @function - * @description Initiates a request to cancel the digital good given it's TransactionID. - * @param {String} [transactionID] the transaction id of the digital good you would like to cancel + * @description Initiates a request to cancel the digital good subscription given it's TransactionID. + * @param {String} transactionID the transaction id of the digital good you would like to cancel * @callback {function} callbackOnSuccess Function to be called when the transaction is cancelled * @callback {function} [callbackOnFailure] Function to be called when an error occurs. * @callback {String} callbackOnFailure.errorText Retrieves the message set for an error. In addition to descriptive text, error code may appear at the end of the message. @@ -263,7 +265,7 @@ blackberry.payment = { *
  • Digital Good not Found = 4
    • *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * - * @PB10 + * @since Version 1.5.0 * @BB50+ * @example * <script type="text/javascript"> @@ -328,7 +330,6 @@ blackberry.payment = { *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * * @since version 1.8.0 - * @PB10 * @BB50+ */ getDigitalGoods : function (callbackOnSuccess, callbackOnFailure) { @@ -365,15 +366,14 @@ blackberry.payment = { *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * * @since version 1.8.0 - * @PB10 * @BB50+ */ getPurchaseHistory : function (callbackOnSuccess, callbackOnFailure) { }, /** * @function - * @description Invokes callbackOnSuccess if the logged in BBID user has rights for this SKU at the time of calling this method. - * @param {String} [sku] the SKU of the digital goods requested + * @description Invokes callbackOnSuccess if the logged in BBID user has rights for this digital good SKU at the time of calling this method. + * @param {String} sku the SKU of the digital goods requested * @callback {function} callbackOnSuccess Function to be invoked on successful call. * @callback {function} [callbackOnFailure] Function to be invoked when an error occurs. * @callback {String} callbackOnFailure.errorText Retrieves the message set for an error. In addition to descriptive text, error code may appear at the end of the message. @@ -385,10 +385,10 @@ blackberry.payment = { *
  • Digital Good not Found = 4
    • *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * - * @PB10 + * @since Version 1.5.0 * @BB50+ */ - checkExisting : function (sku, callbackOnSuccess, callbackOnFailure) { + checkExisting : function (digitalGoodSKU, callbackOnSuccess, callbackOnFailure) { }, /** * @function @@ -404,10 +404,10 @@ blackberry.payment = { *
  • Digital Good not Found = 4
    • *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * - * @PB10 + * @since Version 1.5.0 * @BB50+ */ - upDateAppWorld : function( callbackOnSuccess, callbackOnFailure) { + updateAppWorld : function( callbackOnSuccess, callbackOnFailure) { }, /** * @function @@ -424,7 +424,6 @@ blackberry.payment = { *
  • Illegal Application Error = 5 [BlackBerry OS 5.0+ only]
    • * * @since version 1.5.0 - * @PB10 * @BB50+ */ isAppWorldInstalledAndAtCorrectVersion : function( callbackOnSuccess, callbackOnFailure) { @@ -512,7 +511,6 @@ DigitalGood = { }; /** * @type String * @description The sku of the digital good. - * @PB10 * @BB50+ */ DigitalGood.prototype.sku = null; @@ -520,7 +518,6 @@ DigitalGood.prototype.sku = null; /** * @type String * @description The vendor of the digital good. - * @PB10 * @BB50+ */ DigitalGood.prototype.vendor = null; @@ -528,7 +525,6 @@ DigitalGood.prototype.vendor = null; /** * @type String * @description The name of the digital good. - * @PB10 * @BB50+ */ DigitalGood.prototype.name = null; @@ -536,7 +532,6 @@ DigitalGood.prototype.name = null; /** * @type String * @description The short description of the digital good. - * @PB10 * @BB50+ */ DigitalGood.prototype.shortDescription = null; @@ -544,7 +539,6 @@ DigitalGood.prototype.shortDescription = null; /** * @type String * @description The long description of the digital good. - * @PB10 * @BB50+ */ DigitalGood.prototype.longDescription = null; @@ -552,7 +546,6 @@ DigitalGood.prototype.longDescription = null; /** * @type String * @description The price of the digital good. - * @PB10 * @BB50+ */ DigitalGood.prototype.price = null; @@ -560,7 +553,6 @@ DigitalGood.prototype.price = null; /** * @type String * @description The initial price of the subscription for the digital good, or null if this digital good is not a subscription item. - * @PB10 * @BB50+ */ DigitalGood.prototype.subscriptionInitialPrice = null; @@ -568,7 +560,6 @@ DigitalGood.prototype.subscriptionInitialPrice = null; /** * @type String * @description The renewal price of the subscription for the digital good, or null if this digital good is not a subscription item. - * @PB10 * @BB50+ */ DigitalGood.prototype.subscriptionRenewalPrice = null; @@ -576,7 +567,6 @@ DigitalGood.prototype.subscriptionRenewalPrice = null; /** * @type String * @description The lenght of the subscription for the digital good, or null if this digital good is not a subscription item. - * @PB10 * @BB50+ */ DigitalGood.prototype.subscriptionPeriod = null; @@ -584,7 +574,6 @@ DigitalGood.prototype.subscriptionPeriod = null; /** * @type String * @description The intial subscription period for the digital good, or null if this digital good is not a subscription item. - * @PB10 * @BB50+ */ DigitalGood.prototype.subscriptionInitialPeriod = null; \ No newline at end of file