SubscriptionPlan

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:

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.

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

SubscriptionPlan

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

BYTES_UNKNOWN

BYTES_UNLIMITED

LIMIT_BEHAVIOR_BILLED

LIMIT_BEHAVIOR_DISABLED

LIMIT_BEHAVIOR_THROTTLED

LIMIT_BEHAVIOR_UNKNOWN

SUBSCRIPTION_STATUS_ACTIVE

SUBSCRIPTION_STATUS_INACTIVE

SUBSCRIPTION_STATUS_SUSPENDED

SUBSCRIPTION_STATUS_TRIAL

SUBSCRIPTION_STATUS_UNKNOWN

TIME_UNKNOWN

Fields

CREATOR

Public methods

cycleIterator

describeContents

equals

getDataLimitBehavior

getDataLimitBytes

getDataUsageBytes

getDataUsageTime

getNetworkTypes

getPlanEndDate

getSubscriptionStatus

getSummary

getTitle

hashCode

toString

writeToParcel