Intents

Kotlin |Java

class Intents

kotlin.Any
↳	android.provider.Telephony.Sms.Intents

Contains constants for SMS related Intents that are broadcast.

Summary

Constants
static String	`ACTION_CHANGE_DEFAULT` Activity action: Ask the user to change the default SMS application.
static String	`ACTION_DEFAULT_SMS_PACKAGE_CHANGED` Broadcast action: When the default SMS package changes, the previous default SMS package and the new default SMS package are sent this broadcast to notify them of the change.
static String	`ACTION_EXTERNAL_PROVIDER_CHANGE` Broadcast action: When a change is made to the SmsProvider or MmsProvider by a process other than the default SMS application, this intent is broadcast to the default SMS application so it can re-sync or update the change.
static String	`DATA_SMS_RECEIVED_ACTION` Broadcast Action: A new data based SMS message has been received by the device.
static String	`EXTRA_IS_DEFAULT_SMS_APP` The IsDefaultSmsApp boolean passed as an extra for `ACTION_DEFAULT_SMS_PACKAGE_CHANGED` to indicate whether the SMS app is becoming the default SMS app or is no longer the default.
static String	`EXTRA_PACKAGE_NAME` The PackageName string passed in as an extra for `ACTION_CHANGE_DEFAULT`
static Int	`RESULT_SMS_DATABASE_ERROR` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate a telephony database error.
static Int	`RESULT_SMS_DISPATCH_FAILURE` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate a dispatch failure.
static Int	`RESULT_SMS_DUPLICATED` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate a duplicate incoming message.
static Int	`RESULT_SMS_GENERIC_ERROR` Set by BroadcastReceiver to indicate a generic error while processing the message.
static Int	`RESULT_SMS_HANDLED` Set by BroadcastReceiver to indicate that the message was handled successfully.
static Int	`RESULT_SMS_INVALID_URI` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate an invalid uri.
static Int	`RESULT_SMS_NULL_MESSAGE` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate a null message was encountered.
static Int	`RESULT_SMS_NULL_PDU` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate a null PDU was received.
static Int	`RESULT_SMS_OUT_OF_MEMORY` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate insufficient memory to store the message.
static Int	`RESULT_SMS_RECEIVED_WHILE_ENCRYPTED` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate an sms was received while the phone was in encrypted state.
static Int	`RESULT_SMS_UNSUPPORTED` Set as a "result" extra in the `SMS_REJECTED_ACTION` intent to indicate that the message, while possibly valid, is of a format or encoding that is not supported.
static String	`SECRET_CODE_ACTION` Broadcast Action: A debug code has been entered in the dialer.
static String	`SIM_FULL_ACTION` Broadcast Action: The SIM storage for SMS messages is full.
static String	`SMS_CB_RECEIVED_ACTION` Broadcast Action: A new Cell Broadcast message has been received by the device.
static String	`SMS_DELIVER_ACTION` Broadcast Action: A new text-based SMS message has been received by the device.
static String	`SMS_RECEIVED_ACTION` Broadcast Action: A new text-based SMS message has been received by the device.
static String	`SMS_REJECTED_ACTION` Broadcast Action: An incoming SMS has been rejected by the telephony framework.
static String	`SMS_SERVICE_CATEGORY_PROGRAM_DATA_RECEIVED_ACTION` Broadcast Action: A new CDMA SMS has been received containing Service Category Program Data (updates the list of enabled broadcast channels).
static String	`WAP_PUSH_DELIVER_ACTION` Broadcast Action: A new WAP PUSH message has been received by the device.
static String	`WAP_PUSH_RECEIVED_ACTION` Broadcast Action: A new WAP PUSH message has been received by the device.

Public methods
static Array<SmsMessage!>!	`getMessagesFromIntent(intent: Intent!)` Read the PDUs out of an `SMS_RECEIVED_ACTION` or a `DATA_SMS_RECEIVED_ACTION` intent.

Constants

ACTION_CHANGE_DEFAULT

Added in API level 19

static val ACTION_CHANGE_DEFAULT: String

Activity action: Ask the user to change the default SMS application. This will show a dialog that asks the user whether they want to replace the current default SMS application with the one specified in EXTRA_PACKAGE_NAME.

This is no longer supported since Q, please use android.app.role.RoleManager#createRequestRoleIntent(String) with android.app.role.RoleManager#ROLE_SMS instead.

Value: "android.provider.Telephony.ACTION_CHANGE_DEFAULT"

ACTION_DEFAULT_SMS_PACKAGE_CHANGED

Added in API level 24

static val ACTION_DEFAULT_SMS_PACKAGE_CHANGED: String

Broadcast action: When the default SMS package changes, the previous default SMS package and the new default SMS package are sent this broadcast to notify them of the change. A boolean is specified in EXTRA_IS_DEFAULT_SMS_APP to indicate whether the package is the new default SMS package.

Value: "android.provider.action.DEFAULT_SMS_PACKAGE_CHANGED"

ACTION_EXTERNAL_PROVIDER_CHANGE

Added in API level 24

static val ACTION_EXTERNAL_PROVIDER_CHANGE: String

Broadcast action: When a change is made to the SmsProvider or MmsProvider by a process other than the default SMS application, this intent is broadcast to the default SMS application so it can re-sync or update the change. The uri that was used to call the provider can be retrieved from the intent with getData(). The actual affected uris (which would depend on the selection specified) are not included.

Value: "android.provider.action.EXTERNAL_PROVIDER_CHANGE"

DATA_SMS_RECEIVED_ACTION

Added in API level 19

static val DATA_SMS_RECEIVED_ACTION: String

Broadcast Action: A new data based SMS message has been received by the device. This intent will be delivered to all registered receivers as a notification. The intent will have the following extra values:

"pdus" - An Object[] of byte[]s containing the PDUs that make up the message.

The extra values can be extracted using getMessagesFromIntent(android.content.Intent).

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.intent.action.DATA_SMS_RECEIVED"

EXTRA_IS_DEFAULT_SMS_APP

Added in API level 24

static val EXTRA_IS_DEFAULT_SMS_APP: String

The IsDefaultSmsApp boolean passed as an extra for ACTION_DEFAULT_SMS_PACKAGE_CHANGED to indicate whether the SMS app is becoming the default SMS app or is no longer the default.

Value: "android.provider.extra.IS_DEFAULT_SMS_APP"

See Also

#ACTION_DEFAULT_SMS_PACKAGE_CHANGED

EXTRA_PACKAGE_NAME

Added in API level 19

static val EXTRA_PACKAGE_NAME: String

The PackageName string passed in as an extra for ACTION_CHANGE_DEFAULT

Value: "package"

See Also

#ACTION_CHANGE_DEFAULT

RESULT_SMS_DATABASE_ERROR

Added in API level 30

static val RESULT_SMS_DATABASE_ERROR: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate a telephony database error.

Value: 10

RESULT_SMS_DISPATCH_FAILURE

Added in API level 30

static val RESULT_SMS_DISPATCH_FAILURE: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate a dispatch failure.

Value: 6

RESULT_SMS_DUPLICATED

Added in API level 19

static val RESULT_SMS_DUPLICATED: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate a duplicate incoming message.

Value: 5

RESULT_SMS_GENERIC_ERROR

Added in API level 19

static val RESULT_SMS_GENERIC_ERROR: Int

Set by BroadcastReceiver to indicate a generic error while processing the message.

Value: 2

RESULT_SMS_HANDLED

Added in API level 19

static val RESULT_SMS_HANDLED: Int

Set by BroadcastReceiver to indicate that the message was handled successfully.

Value: 1

RESULT_SMS_INVALID_URI

Added in API level 30

static val RESULT_SMS_INVALID_URI: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate an invalid uri.

Value: 11

RESULT_SMS_NULL_MESSAGE

Added in API level 30

static val RESULT_SMS_NULL_MESSAGE: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate a null message was encountered.

Value: 8

RESULT_SMS_NULL_PDU

Added in API level 30

static val RESULT_SMS_NULL_PDU: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate a null PDU was received.

Value: 7

RESULT_SMS_OUT_OF_MEMORY

Added in API level 19

static val RESULT_SMS_OUT_OF_MEMORY: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate insufficient memory to store the message.

Value: 3

RESULT_SMS_RECEIVED_WHILE_ENCRYPTED

Added in API level 30

static val RESULT_SMS_RECEIVED_WHILE_ENCRYPTED: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate an sms was received while the phone was in encrypted state.

This result code is only used on devices that use Full Disk Encryption. Support for Full Disk Encryption was entirely removed in API level 33, having been replaced by File Based Encryption. Devices that use File Based Encryption never reject incoming SMS messages due to the encryption state.

Value: 9

RESULT_SMS_UNSUPPORTED

Added in API level 19

static val RESULT_SMS_UNSUPPORTED: Int

Set as a "result" extra in the SMS_REJECTED_ACTION intent to indicate that the message, while possibly valid, is of a format or encoding that is not supported.

Value: 4

SECRET_CODE_ACTION

Added in API level 28
Deprecated in API level 29

static val SECRET_CODE_ACTION: String

Deprecated: it is no longer supported, use android.telephony.TelephonyManager#ACTION_SECRET_CODE instead

Broadcast Action: A debug code has been entered in the dialer. This intent is broadcast by the system and OEM telephony apps may need to receive these broadcasts. These "secret codes" are used to activate developer menus by dialing certain codes. And they are of the form *#*#<code>#*#*. The intent will have the data URI: android_secret_code://<code>. It is possible that a manifest receiver would be woken up even if it is not currently running.

Requires android.Manifest.permission#CONTROL_INCALL_EXPERIENCE to send and receive.

Value: "android.provider.Telephony.SECRET_CODE"

SIM_FULL_ACTION

Added in API level 19

static val SIM_FULL_ACTION: String

Broadcast Action: The SIM storage for SMS messages is full. If space is not freed, messages targeted for the SIM (class 2) may not be saved.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.provider.Telephony.SIM_FULL"

SMS_CB_RECEIVED_ACTION

Added in API level 19

static val SMS_CB_RECEIVED_ACTION: String

Broadcast Action: A new Cell Broadcast message has been received by the device. The intent will have the following extra values:

"message" - An SmsCbMessage object containing the broadcast message data. This is not an emergency alert, so ETWS and CMAS data will be null.

The extra values can be extracted using getMessagesFromIntent(android.content.Intent).

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.provider.Telephony.SMS_CB_RECEIVED"

SMS_DELIVER_ACTION

Added in API level 19

static val SMS_DELIVER_ACTION: String

Broadcast Action: A new text-based SMS message has been received by the device. This intent will only be delivered to the default sms app. That app is responsible for writing the message and notifying the user. The intent will have the following extra values:

"pdus" - An Object[] of byte[]s containing the PDUs that make up the message.
"format" - A String describing the format of the PDUs. It can be either "3gpp" or "3gpp2".
"subscription" - An optional long value of the subscription id which received the message.
"slot" - An optional int value of the SIM slot containing the subscription.
"phone" - An optional int value of the phone id associated with the subscription.
"errorCode" - An optional int error code associated with receiving the message.

The extra values can be extracted using getMessagesFromIntent(android.content.Intent).

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

Note: The broadcast receiver that filters for this intent must declare android.Manifest.permission#BROADCAST_SMS as a required permission in the <receiver> tag.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.provider.Telephony.SMS_DELIVER"

SMS_RECEIVED_ACTION

Added in API level 19

static val SMS_RECEIVED_ACTION: String

Broadcast Action: A new text-based SMS message has been received by the device. This intent will be delivered to all registered receivers as a notification. These apps are not expected to write the message or notify the user. The intent will have the following extra values:

"pdus" - An Object[] of byte[]s containing the PDUs that make up the message.

The extra values can be extracted using getMessagesFromIntent(android.content.Intent).

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.provider.Telephony.SMS_RECEIVED"

SMS_REJECTED_ACTION

Added in API level 19

static val SMS_REJECTED_ACTION: String

Broadcast Action: An incoming SMS has been rejected by the telephony framework. This intent is sent in lieu of any of the RECEIVED_ACTION intents. The intent will have the following extra value:

"result" - An int result code, e.g. RESULT_SMS_OUT_OF_MEMORY indicating the error returned to the network.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.provider.Telephony.SMS_REJECTED"

SMS_SERVICE_CATEGORY_PROGRAM_DATA_RECEIVED_ACTION

Added in API level 19

static val SMS_SERVICE_CATEGORY_PROGRAM_DATA_RECEIVED_ACTION: String

Broadcast Action: A new CDMA SMS has been received containing Service Category Program Data (updates the list of enabled broadcast channels). The intent will have the following extra values:

"operations" - An array of CdmaSmsCbProgramData objects containing the service category operations (add/delete/clear) to perform.

The extra values can be extracted using getMessagesFromIntent(android.content.Intent).

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

Requires android.Manifest.permission#RECEIVE_SMS to receive.

Value: "android.provider.Telephony.SMS_SERVICE_CATEGORY_PROGRAM_DATA_RECEIVED"

WAP_PUSH_DELIVER_ACTION

Added in API level 19

static val WAP_PUSH_DELIVER_ACTION: String

Broadcast Action: A new WAP PUSH message has been received by the device. This intent will only be delivered to the default sms app. That app is responsible for writing the message and notifying the user. The intent will have the following extra values:

"transactionId" - (Integer) The WAP transaction ID
"pduType" - (Integer) The WAP PDU type
"header" - (byte[]) The header of the message
"data" - (byte[]) The data payload of the message
"contentTypeParameters" -(HashMap<String,String>) Any parameters associated with the content type (decoded from the WSP Content-Type header)
"subscription" - An optional long value of the subscription id which received the message.
"slot" - An optional int value of the SIM slot containing the subscription.
"phone" - An optional int value of the phone id associated with the subscription.

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

The contentTypeParameters extra value is map of content parameters keyed by their names.

If any unassigned well-known parameters are encountered, the key of the map will be 'unassigned/0x...', where '...' is the hex value of the unassigned parameter. If a parameter has No-Value the value in the map will be null.

Requires android.Manifest.permission#RECEIVE_MMS or android.Manifest.permission#RECEIVE_WAP_PUSH (depending on WAP PUSH type) to receive.

Note: The broadcast receiver that filters for this intent must declare android.Manifest.permission#BROADCAST_WAP_PUSH as a required permission in the <receiver> tag.

Value: "android.provider.Telephony.WAP_PUSH_DELIVER"

WAP_PUSH_RECEIVED_ACTION

Added in API level 19

static val WAP_PUSH_RECEIVED_ACTION: String

Broadcast Action: A new WAP PUSH message has been received by the device. This intent will be delivered to all registered receivers as a notification. These apps are not expected to write the message or notify the user. The intent will have the following extra values:

"transactionId" - (Integer) The WAP transaction ID
"pduType" - (Integer) The WAP PDU type
"header" - (byte[]) The header of the message
"data" - (byte[]) The data payload of the message
"contentTypeParameters" - (HashMap<String,String>) Any parameters associated with the content type (decoded from the WSP Content-Type header)

If a BroadcastReceiver encounters an error while processing this intent it should set the result code appropriately.

The contentTypeParameters extra value is map of content parameters keyed by their names.

Requires android.Manifest.permission#RECEIVE_MMS or android.Manifest.permission#RECEIVE_WAP_PUSH (depending on WAP PUSH type) to receive.

Value: "android.provider.Telephony.WAP_PUSH_RECEIVED"

Public methods

getMessagesFromIntent

Added in API level 19

static fun getMessagesFromIntent(intent: Intent!): Array<SmsMessage!>!

Read the PDUs out of an SMS_RECEIVED_ACTION or a DATA_SMS_RECEIVED_ACTION intent.

Parameters
`intent`	Intent!: the intent to read from

Return
`Array<SmsMessage!>!`	an array of SmsMessages for the PDUs