com.google.api.services.androidpublisher.model

Class SubscriptionPurchase

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.androidpublisher.model.SubscriptionPurchase

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SubscriptionPurchase
extends GenericJson

A SubscriptionPurchase resource indicates the status of a user's subscription purchase.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Developer API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SubscriptionPurchase()

Method Summary

Methods

Modifier and Type	Method and Description
SubscriptionPurchase	clone()
Boolean	getAutoRenewing() Whether the subscription will automatically be renewed when it reaches its current expiry time.
Integer	getCancelReason() The cancel reason of the subscription, if the subscription is not auto renewing.
String	getCountryCode() ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
String	getDeveloperPayload() A developer-specified string that contains supplemental information about an order.
Long	getExpiryTimeMillis() Time at which the subscription will expire, in milliseconds since Epoch.
String	getKind() This kind represents a subscriptionPurchase object in the androidpublisher service.
Integer	getPaymentState() The payment state of the subscription.
Long	getPriceAmountMicros() Price of the subscription, not including tax.
String	getPriceCurrencyCode() ISO 4217 currency code for the subscription price.
Long	getStartTimeMillis() Time at which the subscription was granted, in milliseconds since Epoch.
SubscriptionPurchase	set(String fieldName, Object value)
SubscriptionPurchase	setAutoRenewing(Boolean autoRenewing) Whether the subscription will automatically be renewed when it reaches its current expiry time.
SubscriptionPurchase	setCancelReason(Integer cancelReason) The cancel reason of the subscription, if the subscription is not auto renewing.
SubscriptionPurchase	setCountryCode(String countryCode) ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
SubscriptionPurchase	setDeveloperPayload(String developerPayload) A developer-specified string that contains supplemental information about an order.
SubscriptionPurchase	setExpiryTimeMillis(Long expiryTimeMillis) Time at which the subscription will expire, in milliseconds since Epoch.
SubscriptionPurchase	setKind(String kind) This kind represents a subscriptionPurchase object in the androidpublisher service.
SubscriptionPurchase	setPaymentState(Integer paymentState) The payment state of the subscription.
SubscriptionPurchase	setPriceAmountMicros(Long priceAmountMicros) Price of the subscription, not including tax.
SubscriptionPurchase	setPriceCurrencyCode(String priceCurrencyCode) ISO 4217 currency code for the subscription price.
SubscriptionPurchase	setStartTimeMillis(Long startTimeMillis) Time at which the subscription was granted, in milliseconds since Epoch.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscriptionPurchase

public SubscriptionPurchase()

Method Detail

getAutoRenewing

public Boolean getAutoRenewing()

Whether the subscription will automatically be renewed when it reaches its current expiry time.

Returns:

value or null for none

setAutoRenewing

public SubscriptionPurchase setAutoRenewing(Boolean autoRenewing)

Whether the subscription will automatically be renewed when it reaches its current expiry time.

Parameters:

autoRenewing - autoRenewing or null for none

getCancelReason

public Integer getCancelReason()

The cancel reason of the subscription, if the subscription is not auto renewing. Possible values are: - User cancelled the subscription - Subscription was cancelled by the system, for example because of a billing problem

Returns:

value or null for none

setCancelReason

public SubscriptionPurchase setCancelReason(Integer cancelReason)

The cancel reason of the subscription, if the subscription is not auto renewing. Possible values are: - User cancelled the subscription - Subscription was cancelled by the system, for example because of a billing problem

Parameters:

cancelReason - cancelReason or null for none

getCountryCode

public String getCountryCode()

ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.

Returns:

value or null for none

setCountryCode

public SubscriptionPurchase setCountryCode(String countryCode)

ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.

Parameters:

countryCode - countryCode or null for none

getDeveloperPayload

public String getDeveloperPayload()

A developer-specified string that contains supplemental information about an order.

Returns:

value or null for none

setDeveloperPayload

public SubscriptionPurchase setDeveloperPayload(String developerPayload)

A developer-specified string that contains supplemental information about an order.

Parameters:

developerPayload - developerPayload or null for none

getExpiryTimeMillis

public Long getExpiryTimeMillis()

Time at which the subscription will expire, in milliseconds since Epoch.

Returns:

value or null for none

setExpiryTimeMillis

public SubscriptionPurchase setExpiryTimeMillis(Long expiryTimeMillis)

Time at which the subscription will expire, in milliseconds since Epoch.

Parameters:

expiryTimeMillis - expiryTimeMillis or null for none

getKind

public String getKind()

This kind represents a subscriptionPurchase object in the androidpublisher service.

Returns:

value or null for none

setKind

public SubscriptionPurchase setKind(String kind)

This kind represents a subscriptionPurchase object in the androidpublisher service.

Parameters:

kind - kind or null for none

getPaymentState

public Integer getPaymentState()

The payment state of the subscription. Possible values are: - Payment pending - Payment received

Returns:

value or null for none

setPaymentState

public SubscriptionPurchase setPaymentState(Integer paymentState)

The payment state of the subscription. Possible values are: - Payment pending - Payment received

Parameters:

paymentState - paymentState or null for none

getPriceAmountMicros

public Long getPriceAmountMicros()

Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units equal one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.

Returns:

value or null for none

setPriceAmountMicros

public SubscriptionPurchase setPriceAmountMicros(Long priceAmountMicros)

Price of the subscription, not including tax. Price is expressed in micro-units, where 1,000,000 micro-units equal one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.

Parameters:

priceAmountMicros - priceAmountMicros or null for none

getPriceCurrencyCode

public String getPriceCurrencyCode()

ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".

Returns:

value or null for none

setPriceCurrencyCode

public SubscriptionPurchase setPriceCurrencyCode(String priceCurrencyCode)

ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".

Parameters:

priceCurrencyCode - priceCurrencyCode or null for none

getStartTimeMillis

public Long getStartTimeMillis()

Time at which the subscription was granted, in milliseconds since Epoch.

Returns:

value or null for none

setStartTimeMillis

public SubscriptionPurchase setStartTimeMillis(Long startTimeMillis)

Time at which the subscription was granted, in milliseconds since Epoch.

Parameters:

startTimeMillis - startTimeMillis or null for none

set

public SubscriptionPurchase set(String fieldName,
                       Object value)

Overrides:

set in class GenericJson

clone

public SubscriptionPurchase clone()

Overrides:

clone in class GenericJson