SimRecords

class SimRecords

Constants for the contact records on a SIM card.

Data

Data is stored in a specific elementary file on a specific SIM card and these are isolated from each other. SIM cards are identified by their subscription ID. SIM cards may not support all or even any of the elementary file types. A SIM will have constraints on the values of the data that can be stored in each elementary file. The available SIMs, their supported elementary file types and the constraints on the data can be discovered by querying ElementaryFiles.CONTENT_URI. Each elementary file has a fixed capacity for the number of records that may be stored. This can be determined from the value of the ElementaryFiles.MAX_RECORDS column.

The SimRecords.PHONE_NUMBER column can only contain dialable characters and this applies regardless of the SIM that is being used. See android.telephony.PhoneNumberUtils#isDialable(char) for more details. Additionally the phone number can contain at most ElementaryFiles.PHONE_NUMBER_MAX_LENGTH characters. The SimRecords.NAME column can contain at most ElementaryFiles.NAME_MAX_LENGTH bytes when it is encoded for storage on the SIM. Encoding is done internally and so the name should be provided to these provider APIs as a Java String but the number of bytes required to encode it for storage will vary depending on the characters it contains. This length can be determined by calling SimRecords.getEncodedNameLength(ContentResolver, String).

Operations

Insert

Only ElementaryFiles.EF_ADN supports inserts. SimRecords.PHONE_NUMBER is a required column. If the value provided for this column is missing, null, empty or violates the requirements discussed in the Data section above an IllegalArgumentException will be thrown. The SimRecords.NAME column may be omitted but if provided and it violates any of the requirements discussed in the Data section above an IllegalArgumentException will be thrown.

If an insert is not possible because the elementary file is full then an IllegalStateException will be thrown.

Update

Updates can only be performed for individual records on ElementaryFiles.EF_ADN. A specific record is referenced via the Uri returned by SimRecords.getItemUri(int, int, int). Updates have the same constraints and behavior for the SimRecords.PHONE_NUMBER and SimRecords.NAME as insert. However, in the case of update the SimRecords.PHONE_NUMBER may be omitted as the existing record will already have a valid value.

Delete

Delete may only be performed for individual records on ElementaryFiles.EF_ADN. Deleting records will free up space for use by future inserts.

Query

All the records stored on a specific elementary file can be read via a Uri returned by SimRecords.getContentUri(int, int). This query always returns all records; there is no support for filtering via a selection. An individual record can be queried via a Uri returned by SimRecords.getItemUri(int, int, int). Queries will throw an IllegalArgumentException when the SIM with the subscription ID or the elementary file type are invalid or unavailable.

Summary

Constants

static val CONTENT_ITEM_TYPE: String

Value: "vnd.android.cursor.item/sim-contact_v2"

static val CONTENT_TYPE: String

Value: "vnd.android.cursor.dir/sim-contact_v2"

static val ELEMENTARY_FILE_TYPE: String

Value: "elementary_file_type"

static val ERROR_NAME_UNSUPPORTED: Int

Value: -1

static val NAME: String

Value: "name"

static val PHONE_NUMBER: String

Value: "phone_number"

static val RECORD_NUMBER: String

Value: "record_number"

static val SUBSCRIPTION_ID: String

Value: "subscription_id"

Public methods

static fun getContentUri(
    subscriptionId: Int, 
    efType: Int
): Uri

static fun getEncodedNameLength(
    resolver: ContentResolver, 
    name: String
): Int

static fun getItemUri(
    subscriptionId: Int, 
    efType: Int, 
    recordNumber: Int
): Uri