FileDocCategorySizeDatePackage
SmsManager.javaAPI DocAndroid 1.5 API16988Wed May 06 22:42:00 BST 2009android.telephony.gsm

SmsManager

public final class SmsManager extends Object
Manages SMS operations such as sending data, text, and pdu SMS messages. Get this object by calling the static method SmsManager.getDefault().

Fields Summary
private static SmsManager
sInstance
public static final int
STATUS_ON_SIM_FREE
Free space (TS 51.011 10.5.3).
public static final int
STATUS_ON_SIM_READ
Received and read (TS 51.011 10.5.3).
public static final int
STATUS_ON_SIM_UNREAD
Received and unread (TS 51.011 10.5.3).
public static final int
STATUS_ON_SIM_SENT
Stored and sent (TS 51.011 10.5.3).
public static final int
STATUS_ON_SIM_UNSENT
Stored and unsent (TS 51.011 10.5.3).
public static final int
RESULT_ERROR_GENERIC_FAILURE
Generic failure cause
public static final int
RESULT_ERROR_RADIO_OFF
Failed because radio was explicitly turned off
public static final int
RESULT_ERROR_NULL_PDU
Failed because no pdu provided
public static final int
RESULT_ERROR_NO_SERVICE
Failed because service is currently unavailable
Constructors Summary
private SmsManager()

        // nothing to see here
Methods Summary
public booleancopyMessageToSim(byte[] smsc, byte[] pdu, int status)
Copy a raw SMS PDU to the SIM.

param
smsc the SMSC for this message, or NULL for the default SMSC
param
pdu the raw PDU to store
param
status message status (STATUS_ON_SIM_READ, STATUS_ON_SIM_UNREAD, STATUS_ON_SIM_SENT, STATUS_ON_SIM_UNSENT)
return
true for success {@hide}

        boolean success = false;

        try {
            ISms simISms = ISms.Stub.asInterface(ServiceManager.getService("isms"));
            if (simISms != null) {
                success = simISms.copyMessageToSimEf(status, pdu, smsc);
            }
        } catch (RemoteException ex) {
            // ignore it
        }

        return success;
private java.util.ArrayListcreateMessageListFromRawRecords(java.util.List records)
Create a list of SmsMessages from a list of RawSmsData records returned by getAllMessagesFromSim()

param
records SMS EF records, returned by getAllMessagesFromSim
return
ArrayList of SmsMessage objects.

        ArrayList<SmsMessage> messages = new ArrayList<SmsMessage>();
        if (records != null) {
            int count = records.size();
            for (int i = 0; i < count; i++) {
                SmsRawData data = (SmsRawData)records.get(i);
                // List contains all records, including "free" records (null)
                if (data != null) {
                    SmsMessage sms =
                            SmsMessage.createFromEfRecord(i+1, data.getBytes());
                    messages.add(sms);
                }
            }
        }
        return messages;
public booleandeleteMessageFromSim(int messageIndex)
Delete the specified message from the SIM.

param
messageIndex is the record index of the message on SIM
return
true for success {@hide}

        boolean success = false;
        byte[] pdu = new byte[SimConstants.SMS_RECORD_LENGTH-1];
        Arrays.fill(pdu, (byte)0xff);

        try {
            ISms simISms = ISms.Stub.asInterface(ServiceManager.getService("isms"));
            if (simISms != null) {
                success = simISms.updateMessageOnSimEf(messageIndex,
                        STATUS_ON_SIM_FREE, pdu);
            }
        } catch (RemoteException ex) {
            // ignore it
        }

        return success;
public java.util.ArrayListdivideMessage(java.lang.String text)
Divide a text message into several messages, none bigger than the maximum SMS message size.

param
text the original message. Must not be null.
return
an ArrayList of strings that, in order, comprise the original message

        int size = text.length();
        int[] params = SmsMessage.calculateLength(text, false);
            /* SmsMessage.calculateLength returns an int[4] with:
             *   int[0] being the number of SMS's required,
             *   int[1] the number of code units used,
             *   int[2] is the number of code units remaining until the next message.
             *   int[3] is the encoding type that should be used for the message.
             */
        int messageCount = params[0];
        int encodingType = params[3];
        ArrayList<String> result = new ArrayList<String>(messageCount);

        int start = 0;
        int limit;
        
        if (messageCount > 1) {
            limit = (encodingType == SmsMessage.ENCODING_7BIT) ?
                    SmsMessage.MAX_USER_DATA_SEPTETS_WITH_HEADER :
                        SmsMessage.MAX_USER_DATA_BYTES_WITH_HEADER;            
        } else {
            limit = (encodingType == SmsMessage.ENCODING_7BIT) ?
                SmsMessage.MAX_USER_DATA_SEPTETS : SmsMessage.MAX_USER_DATA_BYTES;            
        }

        try {
            while (start < size) {
                int end = GsmAlphabet.findLimitIndex(text, start, limit, encodingType);
                result.add(text.substring(start, end));
                start = end;
            }
        } catch (EncodeException e) {
            // ignore it.
        }
        return result;
public java.util.ArrayListgetAllMessagesFromSim()
Retrieves all messages currently stored on SIM.

return
ArrayList of SmsMessage objects {@hide}

        List<SmsRawData> records = null;

        try {
            ISms simISms = ISms.Stub.asInterface(ServiceManager.getService("isms"));
            if (simISms != null) {
                records = simISms.getAllMessagesFromSimEf();
            }
        } catch (RemoteException ex) {
            // ignore it
        }
        
        return createMessageListFromRawRecords(records);
public static android.telephony.gsm.SmsManagergetDefault()
Get the default instance of the SmsManager

return
the default instance of the SmsManager

        if (sInstance == null) {
            sInstance = new SmsManager();
        }
        return sInstance;
public voidsendDataMessage(java.lang.String destinationAddress, java.lang.String scAddress, short destinationPort, byte[] data, android.app.PendingIntent sentIntent, android.app.PendingIntent deliveryIntent)
Send a data based SMS to a specific application port.

param
destinationAddress the address to send the message to
param
scAddress is the service center address or null to use the current default SMSC
param
destinationPort the port to deliver the message to
param
data the body of the message to send
param
sentIntent if not NULL this PendingIntent is broadcast when the message is sucessfully sent, or failed. The result code will be Activity.RESULT_OK for success, or one of these errors: RESULT_ERROR_GENERIC_FAILURE RESULT_ERROR_RADIO_OFF RESULT_ERROR_NULL_PDU. The per-application based SMS control checks sentIntent. If sentIntent is NULL the caller will be checked against all unknown applicaitons, which cause smaller number of SMS to be sent in checking period.
param
deliveryIntent if not NULL this PendingIntent is broadcast when the message is delivered to the recipient. The raw pdu of the status report is in the extended data ("pdu").
throws
IllegalArgumentException if destinationAddress or data are empty

        if (TextUtils.isEmpty(destinationAddress)) {
            throw new IllegalArgumentException("Invalid destinationAddress");
        }

        if (data == null || data.length == 0) {
            throw new IllegalArgumentException("Invalid message data");
        }

        SmsMessage.SubmitPdu pdus = SmsMessage.getSubmitPdu(scAddress, destinationAddress,
                destinationPort, data, (deliveryIntent != null));
        sendRawPdu(pdus.encodedScAddress, pdus.encodedMessage, sentIntent, deliveryIntent);
public voidsendMultipartTextMessage(java.lang.String destinationAddress, java.lang.String scAddress, java.util.ArrayList parts, java.util.ArrayList sentIntents, java.util.ArrayList deliveryIntents)
Send a multi-part text based SMS. The callee should have already divided the message into correctly sized parts by calling divideMessage.

param
destinationAddress the address to send the message to
param
scAddress is the service center address or null to use the current default SMSC
param
parts an ArrayList of strings that, in order, comprise the original message
param
sentIntents if not null, an ArrayList of PendingIntents (one for each message part) that is broadcast when the corresponding message part has been sent. The result code will be Activity.RESULT_OK for success, or one of these errors: RESULT_ERROR_GENERIC_FAILURE RESULT_ERROR_RADIO_OFF RESULT_ERROR_NULL_PDU. The per-application based SMS control checks sentIntent. If sentIntent is NULL the caller will be checked against all unknown applicaitons, which cause smaller number of SMS to be sent in checking period.
param
deliveryIntents if not null, an ArrayList of PendingIntents (one for each message part) that is broadcast when the corresponding message part has been delivered to the recipient. The raw pdu of the status report is in the extended data ("pdu").

        if (TextUtils.isEmpty(destinationAddress)) {
            throw new IllegalArgumentException("Invalid destinationAddress");
        }
        if (parts == null || parts.size() < 1) {
            throw new IllegalArgumentException("Invalid message body");
        }
        
        if (parts.size() > 1) {
            try {
                ISms simISms = ISms.Stub.asInterface(ServiceManager.getService("isms"));
                if (simISms != null) {
                    simISms.sendMultipartText(destinationAddress, scAddress, parts,
                            sentIntents, deliveryIntents);
                }
            } catch (RemoteException ex) {
                // ignore it
            }
        } else {
            PendingIntent sentIntent = null;
            PendingIntent deliveryIntent = null;
            if (sentIntents != null && sentIntents.size() > 0) {
                sentIntent = sentIntents.get(0);
            }
            if (deliveryIntents != null && deliveryIntents.size() > 0) {
                deliveryIntent = deliveryIntents.get(0);
            }
            sendTextMessage(destinationAddress, scAddress, parts.get(0),
                    sentIntent, deliveryIntent);
        }
private voidsendRawPdu(byte[] smsc, byte[] pdu, android.app.PendingIntent sentIntent, android.app.PendingIntent deliveryIntent)
Send a raw SMS PDU.

param
smsc the SMSC to send the message through, or NULL for the default SMSC
param
pdu the raw PDU to send
param
sentIntent if not NULL this PendingIntent is broadcast when the message is sucessfully sent, or failed. The result code will be Activity.RESULT_OK for success, or one of these errors: RESULT_ERROR_GENERIC_FAILURE RESULT_ERROR_RADIO_OFF RESULT_ERROR_NULL_PDU. The per-application based SMS control checks sentIntent. If sentIntent is NULL the caller will be checked against all unknown applicaitons, which cause smaller number of SMS to be sent in checking period.
param
deliveryIntent if not NULL this PendingIntent is broadcast when the message is delivered to the recipient. The raw pdu of the status report is in the extended data ("pdu").

        try {
            ISms simISms = ISms.Stub.asInterface(ServiceManager.getService("isms"));
            if (simISms != null) {
                simISms.sendRawPdu(smsc, pdu, sentIntent, deliveryIntent);
            }
        } catch (RemoteException ex) {
            // ignore it
        }
public voidsendTextMessage(java.lang.String destinationAddress, java.lang.String scAddress, java.lang.String text, android.app.PendingIntent sentIntent, android.app.PendingIntent deliveryIntent)
Send a text based SMS.

param
destinationAddress the address to send the message to
param
scAddress is the service center address or null to use the current default SMSC
param
text the body of the message to send
param
sentIntent if not NULL this PendingIntent is broadcast when the message is sucessfully sent, or failed. The result code will be Activity.RESULT_OK for success, or one of these errors: RESULT_ERROR_GENERIC_FAILURE RESULT_ERROR_RADIO_OFF RESULT_ERROR_NULL_PDU. The per-application based SMS control checks sentIntent. If sentIntent is NULL the caller will be checked against all unknown applicaitons, which cause smaller number of SMS to be sent in checking period.
param
deliveryIntent if not NULL this PendingIntent is broadcast when the message is delivered to the recipient. The raw pdu of the status report is in the extended data ("pdu").
throws
IllegalArgumentException if destinationAddress or text are empty

        if (TextUtils.isEmpty(destinationAddress)) {
            throw new IllegalArgumentException("Invalid destinationAddress");
        }

        if (TextUtils.isEmpty(text)) {
            throw new IllegalArgumentException("Invalid message body");
        }

        SmsMessage.SubmitPdu pdus = SmsMessage.getSubmitPdu(
                scAddress, destinationAddress, text, (deliveryIntent != null));
        sendRawPdu(pdus.encodedScAddress, pdus.encodedMessage, sentIntent, deliveryIntent);
public booleanupdateMessageOnSim(int messageIndex, int newStatus, byte[] pdu)
Update the specified message on the SIM.

param
messageIndex record index of message to update
param
newStatus new message status (STATUS_ON_SIM_READ, STATUS_ON_SIM_UNREAD, STATUS_ON_SIM_SENT, STATUS_ON_SIM_UNSENT, STATUS_ON_SIM_FREE)
param
pdu the raw PDU to store
return
true for success {@hide}

        boolean success = false;

        try {
            ISms simISms = ISms.Stub.asInterface(ServiceManager.getService("isms"));
            if (simISms != null) {
                success = simISms.updateMessageOnSimEf(messageIndex, newStatus, pdu);
            }
        } catch (RemoteException ex) {
            // ignore it
        }

        return success;