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 |
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
|
long
|
getDataLimitBytes()
Return the usage threshold at which data access changes according to
|
long
|
getDataUsageBytes()
Return a snapshot of currently known mobile data usage at
|
long
|
getDataUsageTime()
Return the time at which |
int[]
|
getNetworkTypes()
Return an array containing all network types this SubscriptionPlan applies to. |
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
public static final long BYTES_UNKNOWN
Value indicating a number of bytes is unknown.
Constant Value: -1 (0xffffffffffffffff)
BYTES_UNLIMITED
public static final long BYTES_UNLIMITED
Value indicating a number of bytes is unlimited.
Constant Value: 9223372036854775807 (0x7fffffffffffffff)
LIMIT_BEHAVIOR_BILLED
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
public static final int LIMIT_BEHAVIOR_DISABLED
When a resource limit is hit, access is disabled.
Constant Value: 0 (0x00000000)
LIMIT_BEHAVIOR_THROTTLED
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
public static final int LIMIT_BEHAVIOR_UNKNOWN
When a resource limit is hit, the behavior is unknown.
Constant Value: -1 (0xffffffff)
TIME_UNKNOWN
public static final long TIME_UNKNOWN
Value indicating a timestamp is unknown.
Constant Value: -1 (0xffffffffffffffff)
Fields
Public methods
cycleIterator
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
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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
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
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
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
public int[] getNetworkTypes ()
Return an array containing all network types this SubscriptionPlan applies to.
See also:
getSummary
public CharSequence getSummary ()
Return the short summary of this plan.
Returns | |
---|---|
CharSequence |
This value may be null . |
getTitle
public CharSequence getTitle ()
Return the short title of this plan.
Returns | |
---|---|
CharSequence |
This value may be null . |
hashCode
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 inequals
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 thehashCode
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 thehashCode
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
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.