CarrierIdentifier

Kotlin |Java

open class CarrierIdentifier : Parcelable

kotlin.Any
↳	android.service.carrier.CarrierIdentifier

Used to pass info to CarrierConfigService implementations so they can decide what values to return. Instead of passing mcc, mnc, gid1, gid2, spn, imsi to locate carrier information, CarrierIdentifier also include carrier id TelephonyManager.getSimCarrierId(), a platform-wide unique identifier for each carrier. CarrierConfigService can directly use carrier id as the key to look up the carrier info.

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`CarrierIdentifier(mccMnc: ByteArray!, gid1: String?, gid2: String?)` Creates a carrier identifier instance.
`CarrierIdentifier(mcc: String!, mnc: String!, spn: String?, imsi: String?, gid1: String?, gid2: String?)`
`CarrierIdentifier(mcc: String, mnc: String, spn: String?, imsi: String?, gid1: String?, gid2: String?, carrierid: Int, specificCarrierId: Int)`

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
open Int	`getCarrierId()` Returns the carrier id.
open String?	`getGid1()` Get the group identifier level 1.
open String?	`getGid2()` Get the group identifier level 2.
open String?	`getImsi()` Get the international mobile subscriber identity.
open String!	`getMcc()` Get the mobile country code.
open String!	`getMnc()` Get the mobile network code.
open Int	`getSpecificCarrierId()` A specific carrier ID returns the fine-grained carrier ID of the current subscription.
open String?	`getSpn()` Get the service provider name.
open Int	`hashCode()` Returns a hash code value for the object.
open String	`toString()` Returns a string representation of the object.
open Unit	`writeToParcel(out: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<CarrierIdentifier!>	`CREATOR` Used to create a `CarrierIdentifier` from a `Parcel`.

Public constructors

CarrierIdentifier

Added in API level 28

CarrierIdentifier(
    mccMnc: ByteArray!, 
    gid1: String?, 
    gid2: String?)

Creates a carrier identifier instance.

Parameters
`mccMnc`	ByteArray!: A 3-byte array as defined by 3GPP TS 24.008.
`gid1`	String?: The group identifier level 1. This value may be `null`.
`gid2`	String?: The group identifier level 2. This value may be `null`.

Exceptions
`java.lang.IllegalArgumentException`	If the length of `mccMnc` is not 3.

CarrierIdentifier

Added in API level 23

CarrierIdentifier(
    mcc: String!, 
    mnc: String!, 
    spn: String?, 
    imsi: String?, 
    gid1: String?, 
    gid2: String?)

Parameters
`spn`	String?: This value may be `null`.
`imsi`	String?: This value may be `null`.
`gid1`	String?: This value may be `null`.
`gid2`	String?: This value may be `null`.

CarrierIdentifier

Added in API level 29

CarrierIdentifier(
    mcc: String, 
    mnc: String, 
    spn: String?, 
    imsi: String?, 
    gid1: String?, 
    gid2: String?, 
    carrierid: Int, 
    specificCarrierId: Int)

Parameters
`mcc`	String: mobile country code. This value cannot be `null`.
`mnc`	String: mobile network code. This value cannot be `null`.
`spn`	String?: service provider name. This value may be `null`.
`imsi`	String?: International Mobile Subscriber Identity `TelephonyManager.getSubscriberId()` This value may be `null`.
`gid1`	String?: group id level 1 `TelephonyManager.getGroupIdLevel1()` This value may be `null`.
`gid2`	String?: group id level 2. This value may be `null`.
`carrierid`	Int: carrier unique identifier `TelephonyManager.getSimCarrierId()`, used to uniquely identify the carrier and look up the carrier configurations.
`specificCarrierId`	Int: specific carrier identifier `TelephonyManager.getSimSpecificCarrierId()`

Public methods

describeContents

Added in API level 23

open fun describeContents(): Int

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.

Return
`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 23

open fun equals(other: Any?): Boolean

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`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCarrierId

Added in API level 29

open fun getCarrierId(): Int

Returns the carrier id.

See Also

android.telephony.TelephonyManager#getSimCarrierId()

getGid1

Added in API level 23

open fun getGid1(): String?

Get the group identifier level 1.

Return
`String?`	This value may be `null`.

getGid2

Added in API level 23

open fun getGid2(): String?

Get the group identifier level 2.

Return
`String?`	This value may be `null`.

getImsi

Added in API level 23

open fun getImsi(): String?

Get the international mobile subscriber identity.

Return
`String?`	This value may be `null`.

getMcc

Added in API level 23

open fun getMcc(): String!

Get the mobile country code.

getMnc

Added in API level 23

open fun getMnc(): String!

Get the mobile network code.

getSpecificCarrierId

Added in API level 29

open fun getSpecificCarrierId(): Int

A specific carrier ID returns the fine-grained carrier ID of the current subscription. It can represent the fact that a carrier may be in effect an aggregation of other carriers (ie in an MVNO type scenario) where each of these specific carriers which are used to make up the actual carrier service may have different carrier configurations. A specific carrier ID could also be used, for example, in a scenario where a carrier requires different carrier configuration for different service offering such as a prepaid plan.

See Also

android.telephony.TelephonyManager#getSimSpecificCarrierId()

getSpn

Added in API level 23

open fun getSpn(): String?

Get the service provider name.

Return
`String?`	This value may be `null`.

hashCode

Added in API level 23

open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.

Return
`Int`	a hash code value for this object.

toString

Added in API level 23

open fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 23

open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 23

static val CREATOR: Parcelable.Creator<CarrierIdentifier!>

Used to create a CarrierIdentifier from a Parcel.