Class adobeDPS-ReceiptService

Extends:: adobeDPS-ReceiptService -> adobeDPS-Service -> adobeDPS-Class
Platforms:: iOS, Windows

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
	newReceiptsAvailableSignal : adobeDPS-Signal Signal to indicate that new receipt(s) are available.	ReceiptService
	updatedSignal : adobeDPS-Signal Signal to indicate that this service has been updated.	ReceiptService
	receipts : Object. An associative array containing all the single folio receipts, indexed by adobeDPS-Receipt#productId.	ReceiptService
	subscriptionReceipts : Object. An associative array containing all the subscription receipts, indexed by adobeDPS-SubscriptionReceipt#productId + adobeDPS-SubscriptionReceipt#endDate.	ReceiptService
	availableSubscriptions : Object. An associative array containing all the available subscriptions, indexed by adobeDPS-Subscription#productId.	ReceiptService
	subscriptionsAddedSignal : adobeDPS-Signal Signal to indicate that new subscription(s) have been added to availableSubscriptions.	ReceiptService
	subscriptionsRemovedSignal : adobeDPS-Signal Signal to indicate that subscription(s) have been removed from availableSubscriptions.	ReceiptService
	entitlementTypes : adobeDPS-EntitlementType Entitlement Type enum accessor.	ReceiptService
	activeSubscription : Object. Property will be populated when there is an active subscription.	ReceiptService
	bundleReceipt : String Property which stores the bundle receipt.	ReceiptService

Methods

	Method	Defined By
	restorePurchases() 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
	displaySubscribe() Ask the receipt service to present the subscribe dialog.	ReceiptService
	toString() Gets the string representation of this instance.	Class

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.

Platforms:: iOS

Field Details

newReceiptsAvailableSignal : adobeDPS-Signal

Signal to indicate that new receipt(s) are available.
Callback Signature: newReceiptsAvailable([ adobeDPS-Receipt, ...])

Platforms:: iOS

updatedSignal : adobeDPS-Signal

Signal to indicate that this service has been updated. It will pass an array of Strings containing the names of the properties that have been updated.
Callback Signature: updatedHandler([String, ...])

Platforms:: iOS

receipts : Object.

An associative array containing all the single folio receipts, indexed by adobeDPS-Receipt#productId.

Platforms:: iOS

subscriptionReceipts : Object.

An associative array containing all the subscription receipts, indexed by adobeDPS-SubscriptionReceipt#productId + adobeDPS-SubscriptionReceipt#endDate.

Platforms:: iOS

availableSubscriptions : Object.

An associative array containing all the available subscriptions, indexed by adobeDPS-Subscription#productId.

Platforms:: iOS

subscriptionsAddedSignal : adobeDPS-Signal

Signal to indicate that new subscription(s) have been added to availableSubscriptions.
Callback Signature: documentsAddedHandler([ adobeDPS-Subscription, ...])

Platforms:: iOS

subscriptionsRemovedSignal : adobeDPS-Signal

Signal to indicate that subscription(s) have been removed from availableSubscriptions.
Callback Signature: documentsRemovedHandler([ adobeDPS-Subscription, ...])

Platforms:: iOS

entitlementTypes : adobeDPS-EntitlementType

Entitlement Type enum accessor.
This is where you should access the adobeDPS-EntitlementType enums from.

Platforms:: iOS, Windows

activeSubscription : Object.

Property will be populated when there is an active subscription.

Platforms:: iOS

bundleReceipt : String

Property which stores the bundle receipt.
Apple replaced single receipts for purchases with a bundle receipt for all purchases in iOS7. The bundle receipt is a cumulative collection of purchases and can be used for purchase validation with Apple.
Note: Support for the bundle receipt is in the V32.5.6 release and later.

Platforms:: iOS

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
Platforms:: iOS

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
Platforms:: iOS

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
Platforms:: iOS

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
Platforms:: iOS

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
Platforms:: iOS

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
Platforms:: iOS

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
Platforms:: iOS

displaySubscribe()

Ask the receipt service to present the subscribe dialog.

Platforms:: iOS

Adobe DPS - Library and Store SDK 2.32

Class adobeDPS-ReceiptService

Constructor

Static Fields

Fields

Methods