Added in API level 28

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

SubscriptionPlan

---

Kotlin |Java

public final class SubscriptionPlan
extends Object implements Parcelable

java.lang.Object
↳	android.telephony.SubscriptionPlan

---

Description of a billing relationship plan between a carrier and a specific subscriber. This information is used to present more useful UI to users, such as explaining how much mobile data they have remaining, and what will happen when they run out. If specifying network types, the developer must supply at least one plan that applies to all network types (default), and all additional plans may not include a particular network type more than once. This is enforced by SubscriptionManager when setting the plans. Plan selection will prefer plans that have specific network types defined over plans that apply to all network types.

See also:

• SubscriptionManager.setSubscriptionPlans(int, java.util.List)
• SubscriptionManager.getSubscriptionPlans(int)

Summary

Nested classes
class	SubscriptionPlan.Builder Builder for a SubscriptionPlan.

Constants
long	BYTES_UNKNOWN Value indicating a number of bytes is unknown.
long	BYTES_UNLIMITED Value indicating a number of bytes is unlimited.
int	LIMIT_BEHAVIOR_BILLED When a resource limit is hit, the user is billed automatically.
int	LIMIT_BEHAVIOR_DISABLED When a resource limit is hit, access is disabled.
int	LIMIT_BEHAVIOR_THROTTLED When a resource limit is hit, access is throttled to a slower rate.
int	LIMIT_BEHAVIOR_UNKNOWN When a resource limit is hit, the behavior is unknown.
int	SUBSCRIPTION_STATUS_ACTIVE Subscription is active.
int	SUBSCRIPTION_STATUS_INACTIVE Subscription is inactive.
int	SUBSCRIPTION_STATUS_SUSPENDED Subscription is suspended.
int	SUBSCRIPTION_STATUS_TRIAL Subscription is in a trial period.
int	SUBSCRIPTION_STATUS_UNKNOWN Subscription status is unknown.
long	TIME_UNKNOWN Value indicating a timestamp is unknown.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<SubscriptionPlan>	CREATOR

Public methods
Iterator<Range<ZonedDateTime>>	cycleIterator() Return an iterator that will return all valid data usage cycles based on any recurrence rules.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
int	getDataLimitBehavior() Return the behavior of data access when usage reaches getDataLimitBytes().
long	getDataLimitBytes() Return the usage threshold at which data access changes according to getDataLimitBehavior().
long	getDataUsageBytes() Return a snapshot of currently known mobile data usage at getDataUsageTime().
long	getDataUsageTime() Return the time at which getDataUsageBytes() was valid.
int[]	getNetworkTypes() Return an array containing all network types this SubscriptionPlan applies to.
ZonedDateTime	getPlanEndDate() Return the end date of this plan, or null if no end date exists.
int	getSubscriptionStatus() Returns the status of the subscription plan.
CharSequence	getSummary() Return the short summary of this plan.
CharSequence	getTitle() Return the short title of this plan.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

BYTES_UNKNOWN

Added in API level 28

public static final long BYTES_UNKNOWN

Value indicating a number of bytes is unknown.

Constant Value: -1 (0xffffffffffffffff)

BYTES_UNLIMITED

Added in API level 28

public static final long BYTES_UNLIMITED

Value indicating a number of bytes is unlimited.

Constant Value: 9223372036854775807 (0x7fffffffffffffff)

LIMIT_BEHAVIOR_BILLED

Added in API level 28

public static final int LIMIT_BEHAVIOR_BILLED

When a resource limit is hit, the user is billed automatically.

Constant Value: 1 (0x00000001)

LIMIT_BEHAVIOR_DISABLED

Added in API level 28

public static final int LIMIT_BEHAVIOR_DISABLED

When a resource limit is hit, access is disabled.

Constant Value: 0 (0x00000000)

LIMIT_BEHAVIOR_THROTTLED

Added in API level 28

public static final int LIMIT_BEHAVIOR_THROTTLED

When a resource limit is hit, access is throttled to a slower rate.

Constant Value: 2 (0x00000002)

LIMIT_BEHAVIOR_UNKNOWN

Added in API level 28

public static final int LIMIT_BEHAVIOR_UNKNOWN

When a resource limit is hit, the behavior is unknown.

Constant Value: -1 (0xffffffff)

SUBSCRIPTION_STATUS_ACTIVE

Added in Android Baklava

public static final int SUBSCRIPTION_STATUS_ACTIVE

Subscription is active.

Constant Value: 1 (0x00000001)

SUBSCRIPTION_STATUS_INACTIVE

Added in Android Baklava

public static final int SUBSCRIPTION_STATUS_INACTIVE

Subscription is inactive.

Constant Value: 2 (0x00000002)

SUBSCRIPTION_STATUS_SUSPENDED

Added in Android Baklava

public static final int SUBSCRIPTION_STATUS_SUSPENDED

Subscription is suspended.

Constant Value: 4 (0x00000004)

SUBSCRIPTION_STATUS_TRIAL

Added in Android Baklava

public static final int SUBSCRIPTION_STATUS_TRIAL

Subscription is in a trial period.

Constant Value: 3 (0x00000003)

SUBSCRIPTION_STATUS_UNKNOWN

Added in Android Baklava

public static final int SUBSCRIPTION_STATUS_UNKNOWN

Subscription status is unknown.

Constant Value: 0 (0x00000000)

TIME_UNKNOWN

Added in API level 28

public static final long TIME_UNKNOWN

Value indicating a timestamp is unknown.

Constant Value: -1 (0xffffffffffffffff)

Fields

CREATOR

Added in API level 28

public static final Creator<SubscriptionPlan> CREATOR

Public methods

cycleIterator

Added in API level 28

public Iterator<Range<ZonedDateTime>> cycleIterator ()

Return an iterator that will return all valid data usage cycles based on any recurrence rules. The iterator starts from the currently active cycle and walks backwards through time.

Returns
Iterator<Range<ZonedDateTime>>

describeContents

Added in API level 28

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 28

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getDataLimitBehavior

Added in API level 28

public int getDataLimitBehavior ()

Return the behavior of data access when usage reaches getDataLimitBytes().

Returns
int	Value is LIMIT_BEHAVIOR_UNKNOWN, LIMIT_BEHAVIOR_DISABLED, LIMIT_BEHAVIOR_BILLED, or LIMIT_BEHAVIOR_THROTTLED

getDataLimitBytes

Added in API level 28

public long getDataLimitBytes ()

Return the usage threshold at which data access changes according to getDataLimitBehavior().
Value is a non-negative number of bytes.

Returns
long	Value is a non-negative number of bytes.

getDataUsageBytes

Added in API level 28

public long getDataUsageBytes ()

Return a snapshot of currently known mobile data usage at getDataUsageTime().
Value is a non-negative number of bytes.

Returns
long	Value is a non-negative number of bytes.

getDataUsageTime

Added in API level 28

public long getDataUsageTime ()

Return the time at which getDataUsageBytes() was valid.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Returns
long	Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getNetworkTypes

Added in API level 30

public int[] getNetworkTypes ()

Return an array containing all network types this SubscriptionPlan applies to.

Returns

int[]

This value cannot be null. Value is TelephonyManager.NETWORK_TYPE_UNKNOWN, TelephonyManager.NETWORK_TYPE_GPRS, TelephonyManager.NETWORK_TYPE_EDGE, TelephonyManager.NETWORK_TYPE_UMTS, TelephonyManager.NETWORK_TYPE_CDMA, TelephonyManager.NETWORK_TYPE_EVDO_0, TelephonyManager.NETWORK_TYPE_EVDO_A, TelephonyManager.NETWORK_TYPE_1xRTT, TelephonyManager.NETWORK_TYPE_HSDPA, TelephonyManager.NETWORK_TYPE_HSUPA, TelephonyManager.NETWORK_TYPE_HSPA, TelephonyManager.NETWORK_TYPE_IDEN, TelephonyManager.NETWORK_TYPE_EVDO_B, TelephonyManager.NETWORK_TYPE_LTE, TelephonyManager.NETWORK_TYPE_EHRPD, TelephonyManager.NETWORK_TYPE_HSPAP, TelephonyManager.NETWORK_TYPE_GSM, TelephonyManager.NETWORK_TYPE_TD_SCDMA, TelephonyManager.NETWORK_TYPE_IWLAN, or TelephonyManager.NETWORK_TYPE_NR

See also:

• for network types values

getPlanEndDate

Added in Android Baklava

public ZonedDateTime getPlanEndDate ()

Return the end date of this plan, or null if no end date exists.

Returns
ZonedDateTime

getSubscriptionStatus

Added in Android Baklava

public int getSubscriptionStatus ()

Returns the status of the subscription plan.

Returns
int	The subscription status, or SUBSCRIPTION_STATUS_UNKNOWN if not available. Value is SUBSCRIPTION_STATUS_UNKNOWN, SUBSCRIPTION_STATUS_ACTIVE, SUBSCRIPTION_STATUS_INACTIVE, SUBSCRIPTION_STATUS_TRIAL, or SUBSCRIPTION_STATUS_SUSPENDED

getSummary

Added in API level 28

public CharSequence getSummary ()

Return the short summary of this plan.

Returns
CharSequence	This value may be null.

getTitle

Added in API level 28

public CharSequence getTitle ()

Return the short title of this plan.

Returns
CharSequence	This value may be null.

hashCode

Added in API level 28

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

Added in API level 28

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 28

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES