Adobe DPS - JavaScript Library API

Class adobeDPS-SubscriptionReceipt

Extends:
adobeDPS-SubscriptionReceipt -> adobeDPS-Receipt -> adobeDPS-Class

An object that wraps a broker subscription receipt.

Constructor

adobeDPS-SubscriptionReceipt(broker:String, productId:String, token:String, startDate:Date, endDate:Date)
[inner] Create a new subscription receipt.

Fields

Field Defined By
startDate : Date
The date the subscription period begins
SubscriptionReceipt
endDate : Date
The date the subscription period ends
SubscriptionReceipt
Inherited from adobeDPS-Receipt
broker : String
The broker that this receipt was issued by.
Inherited from adobeDPS-Receipt
productId : String
The productId that this receipt is associated with.
Inherited from adobeDPS-Receipt
token : String
The validation token for this receipt.
Inherited from adobeDPS-Receipt
isSubscription : Boolean
Whether this receipt is a subscription receipt.

Methods

Method Defined By
contains(date:Date)
Whether the subscription period of this subscription receipt covers the date provided.
SubscriptionReceipt
Inherited from adobeDPS-Class
Gets the string representation of this instance.
Class Detail
adobeDPS-SubscriptionReceipt(broker:String, productId:String, token:String, startDate:Date, endDate:Date)
[inner] Create a new subscription receipt.
Parameters
broker String The broker that this receipt is from.
productId String The productId that this receipt is associated with.
token String The receipt token, which is used to validate the receipt.
startDate Date The date the subscription begins
endDate Date The date the subscription expires
Field Details
startDate : Date
The date the subscription period begins
endDate : Date
The date the subscription period ends
Method Details
contains(date:Date) : Boolean
Whether the subscription period of this subscription receipt covers the date provided.
Parameters
date Date The date to check if this subscription receipt covers
Returns:
Boolean Whether the date is covered by this receipt
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 01 2013 13:18:39 GMT-0800 (PST)