Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

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.

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.

long TIME_UNKNOWN

Value indicating a timestamp is unknown.

Inherited constants

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.

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

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)

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(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.

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj Object: the reference object with which to compare.

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 in the System.currentTimeMillis() time base.

Returns
long

Value is a non-negative timestamp in the System.currentTimeMillis() time base.

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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

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. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.