SubscriptionPlan Class

Definition

Namespace:: Android.Telephony

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Description of a billing relationship plan between a carrier and a specific subscriber.

[Android.Runtime.Register("android/telephony/SubscriptionPlan", ApiSince=28, DoNotGenerateAcw=true)]
public sealed class SubscriptionPlan : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/telephony/SubscriptionPlan", ApiSince=28, DoNotGenerateAcw=true)>]
type SubscriptionPlan = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

JavaObject

Object
SubscriptionPlan

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

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.

Java documentation for android.telephony.SubscriptionPlan.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Fields

Name	Description
BitrateUnknown	Value indicating data rate is unknown.
BytesUnknown	Value indicating a number of bytes is unknown.
BytesUnlimited	Value indicating a number of bytes is unlimited.
LimitBehaviorBilled	Obsolete. Indicates that the user will be billed for data usage beyond the limit.
LimitBehaviorDisabled	Obsolete. Indicates that data access is disabled when the data limit is reached.
LimitBehaviorThrottled	Obsolete. Indicates that data access is throttled to a slower speed when the limit is reached.
LimitBehaviorUnknown	Obsolete. Indicates that the behavior for when a data limit is reached is unknown.
PlanTypeBusiness	Obsolete. The plan is for business or enterprise customers.
PlanTypeCellular	Obsolete. The plan provides conventional cellular service.
PlanTypeDataOnly	Obsolete. The plan is for data-only service.
PlanTypeFamily	Obsolete. The plan is a family plan, shared among multiple users.
PlanTypeIot	Obsolete. The plan is designed for Internet of Things (IoT) devices.
PlanTypePostpaid	Obsolete. The plan is a postpaid plan.
PlanTypePrepaid	Obsolete. The plan is a prepaid plan.
PlanTypeRoaming	Obsolete. The plan is specifically for roaming services.
PlanTypeSatellite	Obsolete. The plan provides satellite-based service.
PlanTypeTethering	Obsolete. The plan provides a data allowance specifically for tethering or mobile hotspot usage.
SubscriptionStatusActive	Obsolete. The subscription is active.
SubscriptionStatusInactive	Obsolete. The subscription is inactive.
SubscriptionStatusSuspended	Obsolete. The subscription is suspended.
SubscriptionStatusTrial	Obsolete. The subscription is in a trial period.
SubscriptionStatusUnknown	Obsolete. The subscription status is unknown.
TimeUnknown	Value indicating a timestamp is unknown.
UnspecifiedId	Value indicating that the SubscriptionPlan ID is not specified.

Properties

Name	Description
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Creator
DataLimitBehavior	Returns the behavior of data access when usage reaches the limit defined by `#getDataLimitBytes()`.
DataLimitBytes	Returns the data limit for the plan.
DataUsageBytes	Returns a snapshot of the mobile data usage, in bytes, as of the time reported by `#getDataUsageTime()`.
DataUsageResetTime	Returns the time at which the data usage will reset.
DataUsageTime	Returns the time at which `#getDataUsageBytes()` was measured, in milliseconds since the Unix epoch.
Handle	The handle to the underlying Android instance. (Inherited from Object)
Id	Returns the unique integer identifier for this subscription plan.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	(Inherited from JavaObject)
JniPeerMembers
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
PlanEndDate	Return the end date of this plan, or null if no end date exists.
SubscriptionStatus	Returns the status of the subscription plan.
Summary
SummaryFormatted	Return the short summary of this plan.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
Title
TitleFormatted	Return the short title of this plan.
Types	Returns the characteristics of this subscription plan as a set of type constants.

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
CycleIterator()	Return an iterator that will return all valid data usage cycles based on any recurrence rules.
DescribeContents()	Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
DisposeUnlessReferenced()	(Inherited from JavaObject)
Equals(Object)	(Inherited from JavaObject)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
GetNetworkTypes()	Returns the network types that this plan applies to.
JavaFinalize()	Obsolete. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)	Flatten this object in to a Parcel.

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	(Inherited from JavaObject)
IJavaPeerable.Finalized()	(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to