com.codename1.payment

Class Receipt

java.lang.Object

com.codename1.payment.Receipt

All Implemented Interfaces:

Externalizable

public class Receipt
extends Object
implements Externalizable

Encapsulates a receipt for an in-app purchase.

Author:

shannah

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORE_CODE_ITUNES
static String	STORE_CODE_PLAY
static String	STORE_CODE_SIMULATOR
static String	STORE_CODE_WINDOWS

Constructor Summary

Constructors

Constructor and Description
Receipt()
Receipt(String sku, Date expiryDate, Date cancellationDate, Date purchaseDate, int quantity, String transactionId, String orderData, String storeCode, String internalId) Convenience constructor

Method Summary

Modifier and Type	Method and Description
void	externalize(DataOutputStream out) Allows us to store an object state, this method must be implemented in order to save the state of an object
Date	getCancellationDate() Cancellation date of the receipt, if it has been cancelled.
Date	getExpiryDate() The expiry date of the receipt, in case this is a subscription receipt.
String	getInternalId() An internal ID that may be optionally used to link the receipt to an internal order ID.
String	getObjectId() The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.
String	getOrderData() The order data that may be used to verify the receipt with the appropriate REST service.
Date	getPurchaseDate() Date of purchase.
int	getQuantity() Quantity.
String	getSku()
String	getStoreCode() The store code from which this receipt originated.
String	getTransactionId() The store-specific transaction ID.
int	getVersion() Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions
void	internalize(int version, DataInputStream in) Loads the object from the input stream and allows deserialization
void	setCancellationDate(Date cancellationDate)
void	setExpiryDate(Date expiryDate)
void	setInternalId(String internalId)
void	setOrderData(String orderData)
void	setPurchaseDate(Date originalPurchaseDate)
void	setQuantity(int quantity)
void	setSku(String sku)
void	setStoreCode(String storeCode)
void	setTransactionId(String transactionId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STORE_CODE_ITUNES

public static final String STORE_CODE_ITUNES

See Also:

Constant Field Values

STORE_CODE_PLAY

public static final String STORE_CODE_PLAY

See Also:

Constant Field Values

STORE_CODE_WINDOWS

public static final String STORE_CODE_WINDOWS

See Also:

Constant Field Values

STORE_CODE_SIMULATOR

public static final String STORE_CODE_SIMULATOR

See Also:

Constant Field Values

Constructor Detail

Receipt

public Receipt()

Receipt

public Receipt(String sku,
               Date expiryDate,
               Date cancellationDate,
               Date purchaseDate,
               int quantity,
               String transactionId,
               String orderData,
               String storeCode,
               String internalId)

Convenience constructor

Method Detail

getSku

public String getSku()

Returns:

the sku

setSku

public void setSku(String sku)

Parameters:

sku - the sku to set

See Also:

getSku()

getExpiryDate

public Date getExpiryDate()

The expiry date of the receipt, in case this is a subscription receipt.

NOTE: The expiry date will NOT be set automatically when the receipt is generated by the platform. It should be set by the ReceiptStore in the ReceiptStore.submitReceipt(com.codename1.payment.Receipt, com.codename1.util.SuccessCallback) step, and usually on the server-side (in cases where a server is being used to track subscriptions), then the expiry date will be made available when the receipt is loaded using ReceiptStore.fetchReceipts(com.codename1.util.SuccessCallback).

Returns:

the expiryDate Will be null for non-subscriptions.

setExpiryDate

public void setExpiryDate(Date expiryDate)

Parameters:

expiryDate - the expiryDate to set

See Also:

getExpiryDate()

getVersion

public int getVersion()

Returns the version for the current persistance code, the version will be pased to internalized thus allowing the internalize method to recognize classes persisted in older revisions

Specified by:

getVersion in interface Externalizable

Returns:

version number for the persistant code

externalize

public void externalize(DataOutputStream out)
                 throws IOException

Allows us to store an object state, this method must be implemented in order to save the state of an object

Specified by:

externalize in interface Externalizable

Parameters:

out - the stream into which the object must be serialized

Throws:

IOException - the method may throw an exception

internalize

public void internalize(int version,
                        DataInputStream in)
                 throws IOException

Loads the object from the input stream and allows deserialization

Specified by:

internalize in interface Externalizable

Parameters:

version - the version the class returned during the externalization processs

in - the input stream used to load the class

Throws:

IOException - the method may throw an exception

getObjectId

public String getObjectId()

The object id must be unique, it is used to identify the object when loaded even when it is obfuscated.

Specified by:

getObjectId in interface Externalizable

Returns:

getCancellationDate

public Date getCancellationDate()

Cancellation date of the receipt, if it has been cancelled. A cancelled receipt should be treated as if the purchase had never been made in the first place.

Returns:

the cancellationDate

setCancellationDate

public void setCancellationDate(Date cancellationDate)

Parameters:

cancellationDate - the cancellationDate to set

See Also:

getCancellationDate()

getPurchaseDate

public Date getPurchaseDate()

Date of purchase.

Returns:

the purchaseDate

setPurchaseDate

public void setPurchaseDate(Date originalPurchaseDate)

Parameters:

originalPurchaseDate - the purchaseDate to set

See Also:

getPurchaseDate()

getQuantity

public int getQuantity()

Quantity. Currently this will always be 1, but potentially could be used internally to denote other quantities.

Returns:

the quantity

setQuantity

public void setQuantity(int quantity)

Parameters:

quantity - the quantity to set

See Also:

getQuantity()

getTransactionId

public String getTransactionId()

The store-specific transaction ID. This will match exactly the transaction id of the store the issued the receipt. Use the storeCode to differentiate between transactions of different stores, which may potentially have the same transaction Ids.

Returns:

the transactionId

setTransactionId

public void setTransactionId(String transactionId)

Parameters:

transactionId - the transactionId to set

See Also:

getTransactionId()

getOrderData

public String getOrderData()

The order data that may be used to verify the receipt with the appropriate REST service. This data will be in different formats for different stores.

iTunes has a base64 encoded string, Play has a JSON structure, Windows has an XML string, etc...

This will be filled in at the time that the receipt is generated by the platform's implementation, so developers should never have to explicitly set this.

Returns:

the orderData

setOrderData

public void setOrderData(String orderData)

Parameters:

orderData - the orderData to set

See Also:

getOrderData()

getStoreCode

public String getStoreCode()

The store code from which this receipt originated. Will usually be one of STORE_CODE_ITUNES, STORE_CODE_PLAY, STORE_CODE_WINDOWS, or STORE_CODE_SIMULATOR, but developers could also use custom codes if they use a different store, or no store at all. This code can be used for validating the receipt.

Returns:

the storeCode

setStoreCode

public void setStoreCode(String storeCode)

Parameters:

storeCode - the storeCode to set

See Also:

getStoreCode()

getInternalId

public String getInternalId()

An internal ID that may be optionally used to link the receipt to an internal order ID.

Returns:

the internalId

setInternalId

public void setInternalId(String internalId)

Parameters:

internalId - the internalId to set

See Also:

getInternalId()

toString

public String toString()

Overrides:

toString in class Object