Adobe DPS - Library and Store SDK 2.27

Class adobeDPS-ReceiptService

Extends:
adobeDPS-ReceiptService -> adobeDPS-Service -> adobeDPS-Class

Service for accessing receipt information.
Accessible from adobeDPS.receiptService

Constructor

adobeDPS-ReceiptService()
[inner] Create an instance of the ReceiptService.

Static Fields

Field Defined By
adobeDPS-ReceiptService.instance
The singleton of the ReceiptService.
ReceiptService

Fields

Field Defined By
Signal to indicate that new receipt(s) are available.
ReceiptService
receipts : Object.
An associative array containing all the single folio receipts, indexed by adobeDPS-Receipt#productId.
ReceiptService
An associative array containing all the subscription receipts, indexed by adobeDPS-SubscriptionReceipt#productId + adobeDPS-SubscriptionReceipt#startDate.
ReceiptService
An associative array containing all the available subscriptions, indexed by adobeDPS-Subscription#productId.
ReceiptService
Signal to indicate that new subscription(s) have been added to availableSubscriptions.
ReceiptService
Signal to indicate that subscription(s) have been removed from availableSubscriptions.
ReceiptService
Entitlement Type enum accessor.
ReceiptService

Methods

Method Defined By
Start a restore purchases transaction.
ReceiptService
addSubscription(subscriptionProductId:String)
Add a single subscription product to the list of subscriptions available for purchase
ReceiptService
addSubscriptions(subscriptionProductIds:Array)
Add a list of subscription products to the list of subscriptions available for purchase
ReceiptService
removeSubscription(subscriptionProductId:String)
Remove a single subscription product from the list of subscriptions available for purchase
ReceiptService
removeSubscriptions(subscriptionProductIds:Array)
Remove a list of subscription products from the list of subscriptions available for purchase
ReceiptService
setSubscription(subscriptionProductId:String)
Set a single subscription product as the only subscription available for purchase
ReceiptService
setSubscriptions(subscriptionProductIds:Array)
Set a list of subscription products as the new list of subscriptions available for purchase
ReceiptService
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-ReceiptService()
[inner] Create an instance of the ReceiptService.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-ReceiptService.instance
The singleton of the ReceiptService.
Field Details
newReceiptsAvailableSignal : adobeDPS-Signal
Signal to indicate that new receipt(s) are available.
Callback Signature: newReceiptsAvailable([ adobeDPS-Receipt, ...])
receipts : Object.
An associative array containing all the single folio receipts, indexed by adobeDPS-Receipt#productId.
subscriptionReceipts : Object.
An associative array containing all the subscription receipts, indexed by adobeDPS-SubscriptionReceipt#productId + adobeDPS-SubscriptionReceipt#startDate.
availableSubscriptions : Object.
An associative array containing all the available subscriptions, indexed by adobeDPS-Subscription#productId.
subscriptionsAddedSignal : adobeDPS-Signal
Signal to indicate that new subscription(s) have been added to availableSubscriptions.
Callback Signature: documentsAddedHandler([ adobeDPS-Subscription, ...])
subscriptionsRemovedSignal : adobeDPS-Signal
Signal to indicate that subscription(s) have been removed from availableSubscriptions.
Callback Signature: documentsRemovedHandler([ adobeDPS-Subscription, ...])
entitlementTypes : adobeDPS-EntitlementType
Entitlement Type enum accessor.
This is where you should access the adobeDPS-EntitlementType enums from.
Method Details
restorePurchases() : adobeDPS-RestorePurchasesTransaction
Start a restore purchases transaction.
WARNING: This function should be used sparingly as it may be limited by the broker.
Returns:
adobeDPS-RestorePurchasesTransaction The started restore purchase transaction
addSubscription(subscriptionProductId:String) : adobeDPS-ModifySubscriptionsListTransaction
Add a single subscription product to the list of subscriptions available for purchase
Parameters
subscriptionProductId String The product ID of the subscription to be added
Throws:
Error If the subscription Id to be added is new
Returns:
adobeDPS-ModifySubscriptionsListTransaction The started transaction
addSubscriptions(subscriptionProductIds:Array) : adobeDPS-ModifySubscriptionsListTransaction
Add a list of subscription products to the list of subscriptions available for purchase
Parameters
subscriptionProductIds Array The product IDs of the subscriptions to be added
Throws:
Error If none of the subscription Ids to be added are new
Returns:
adobeDPS-ModifySubscriptionsListTransaction The started transaction
removeSubscription(subscriptionProductId:String) : adobeDPS-ModifySubscriptionsListTransaction
Remove a single subscription product from the list of subscriptions available for purchase
Parameters
subscriptionProductId String The product ID of the subscription to be added
Throws:
Error If the subscription Id to be removed does not exist
Returns:
adobeDPS-ModifySubscriptionsListTransaction The started transaction
removeSubscriptions(subscriptionProductIds:Array) : adobeDPS-ModifySubscriptionsListTransaction
Remove a list of subscription products from the list of subscriptions available for purchase
Parameters
subscriptionProductIds Array The product IDs of the subscriptions to be added
Throws:
Error If none of the subscription Ids to be removed exist
Returns:
adobeDPS-ModifySubscriptionsListTransaction The started transaction
setSubscription(subscriptionProductId:String) : adobeDPS-ModifySubscriptionsListTransaction
Set a single subscription product as the only subscription available for purchase
Parameters
subscriptionProductId String The product ID of the subscription to be set
Returns:
adobeDPS-ModifySubscriptionsListTransaction The started transaction
setSubscriptions(subscriptionProductIds:Array) : adobeDPS-ModifySubscriptionsListTransaction
Set a list of subscription products as the new list of subscriptions available for purchase
Parameters
subscriptionProductIds Array The product IDs of the subscriptions to be set
Returns:
adobeDPS-ModifySubscriptionsListTransaction The started transaction
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 24 2013 16:54:21 GMT-0700 (PDT)