Added in API level 23

CarrierIdentifier

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
Public constructors
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)

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

Creates a carrier identifier instance.

Public methods
open Int

open Boolean
equals(other: Any?)

open Int

Returns the carrier id.

open String?

Get the group identifier level 1.

open String?

Get the group identifier level 2.

open String?

Get the international mobile subscriber identity.

open String!

Get the mobile country code.

open String!

Get the mobile network code.

open Int

A specific carrier ID returns the fine-grained carrier ID of the current subscription.

open String?

Get the service provider name.

open Int

open String

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

Properties
static Parcelable.Creator<CarrierIdentifier!>

Used to create a CarrierIdentifier from a Parcel.

Public constructors

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 23
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()

CarrierIdentifier

Added in API level 23
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.

Public methods

describeContents

Added in API level 23
open fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 23
open fun equals(other: Any?): Boolean
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.

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.

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
Return
Int a hash code value for this object.

toString

Added in API level 23
open fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 23
open fun writeToParcel(
    out: Parcel,
    flags: Int
): Unit
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 23
static val CREATOR: Parcelable.Creator<CarrierIdentifier!>

Used to create a CarrierIdentifier from a Parcel.