Class adobeDPS-SubscriptionService
- Extends:
- adobeDPS-SubscriptionService -> adobeDPS-Service -> adobeDPS-Class
- Platforms:
- iOS
Service for accessing subscription information.
Accessible from adobeDPS.subscriptionService
Constructor
[inner]
Create an instance of the SubscriptionService.
Static Fields
| Field | Defined By | |
|---|---|---|
|
adobeDPS-SubscriptionService.instance
The singleton of the SubscriptionService.
|
SubscriptionService
|
Fields
| Field | Defined By | |
|---|---|---|
|
activeSubscription
: Object.
Property will be populated when there is an active subscription.
|
SubscriptionService
|
|
|
Signal to indicate that this service has been updated.
|
SubscriptionService
|
|
|
availableSubscriptions
: Object.
An associative array containing all the available subscriptions, indexed by adobeDPS-Subscription#productId.
|
SubscriptionService
|
|
|
Signal to indicate that new subscription(s) have been added to availableSubscriptions.
|
SubscriptionService
|
|
|
Signal to indicate that subscription(s) have been removed from availableSubscriptions.
|
SubscriptionService
|
|
|
Entitlement Type enum accessor.
|
SubscriptionService
|
|
|
bundleReceipt
: String
Property which stores the bundle receipt.
|
SubscriptionService
|
Methods
| Method | Defined By | |
|---|---|---|
|
addSubscription(subscriptionProductId:String)
Add a single subscription product to the list of
subscriptions available for purchase
|
SubscriptionService
|
|
|
addSubscriptions(subscriptionProductIds:Array)
Add a list of subscription products to the list of
subscriptions available for purchase
|
SubscriptionService
|
|
|
removeSubscription(subscriptionProductId:String)
Remove a single subscription product from the list of
subscriptions available for purchase
|
SubscriptionService
|
|
|
removeSubscriptions(subscriptionProductIds:Array)
Remove a list of subscription products from the list of
subscriptions available for purchase
|
SubscriptionService
|
|
|
setSubscription(subscriptionProductId:String)
Set a single subscription product as the only subscription
available for purchase
|
SubscriptionService
|
|
|
setSubscriptions(subscriptionProductIds:Array)
Set a list of subscription products as the new list of subscriptions
available for purchase
|
SubscriptionService
|
|
|
Ask the receipt service to present the subscribe dialog.
|
SubscriptionService
|
|
|
toString()
Gets the string representation of this instance.
|
Class Detail
adobeDPS-SubscriptionService()
[inner]
Create an instance of the SubscriptionService.
- This is an internal constructor and shouldn't be called by regular users.
- This is an internal constructor and shouldn't be called by regular users.
Static Field Details
adobeDPS-SubscriptionService.instance
The singleton of the SubscriptionService.
- Platforms:
- iOS
Field Details
activeSubscription
: Object.
Property will be populated when there is an active subscription.
- 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, ...])
Callback Signature: updatedHandler([String, ...])
- 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, ...])
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, ...])
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.
This is where you should access the adobeDPS-EntitlementType enums from.
- 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.
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
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
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
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
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
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
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
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:40 GMT-0700 (PDT)