Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Copyright (C) 2008 The Android Open Source Project
3
   *
4
   * Licensed under the Apache License, Version 2.0 (the "License");
5
   * you may not use this file except in compliance with the License.
6
   * You may obtain a copy of the License at
7
   *
8
   *      http://www.apache.org/licenses/LICENSE-2.0
9
   *
10
  * Unless required by applicable law or agreed to in writing, software
11
  * distributed under the License is distributed on an "AS IS" BASIS,
12
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
  * See the License for the specific language governing permissions and
14
  * limitations under the License.
15
  */
16
 
17
 package android.telephony;
18
 
21
 
28
 
29
 import java.lang.Math;
32
 
33
 import static android.telephony.TelephonyManager.PHONE_TYPE_CDMA;


A Short Message Service message. 
38
 
39
 public class SmsMessage {
40
     private static final boolean LOCAL_DEBUG = true;
41
     private static final String LOG_TAG = "SMS";

    
SMS Class enumeration. See TS 23.038. 
47
 
48
     public enum MessageClass{
49
         UNKNOWN, CLASS_0, CLASS_1, CLASS_2, CLASS_3;
50
     }

    
User data text encoding code unit size
52
 
53
     public static final int ENCODING_UNKNOWN = 0;
54
     public static final int ENCODING_7BIT = 1;
55
     public static final int ENCODING_8BIT = 2;
56
     public static final int ENCODING_16BIT = 3;

    
The maximum number of payload bytes per message
58
 
59
     public static final int MAX_USER_DATA_BYTES = 140;

    
The maximum number of payload bytes per message if a user data header is present. This assumes the header only contains the CONCATENATED_8_BIT_REFERENCE element. 
65
 
66
     public static final int MAX_USER_DATA_BYTES_WITH_HEADER = 134;

    
The maximum number of payload septets per message
68
 
69
     public static final int MAX_USER_DATA_SEPTETS = 160;

    
The maximum number of payload septets per message if a user data header is present. This assumes the header only contains the CONCATENATED_8_BIT_REFERENCE element. 
75
 
76
     public static final int MAX_USER_DATA_SEPTETS_WITH_HEADER = 153;

    
Contains actual SmsMessage. Only public for debugging and for framework layer.

Hide:
81
 
83
 
84
     public static class SubmitPdu {
85
 
86
         public byte[] encodedScAddress; // Null if not applicable.
87
         public byte[] encodedMessage;
88
 
89
         public String toString() {
90
             return "SubmitPdu: encodedScAddress = "
91
                     + Arrays.toString()
92
                     + ", encodedMessage = "
93
                     + Arrays.toString();
94
         }

        

Hide:
98
 
99
         protected SubmitPdu(SubmitPduBase spb) {
100
            this. = spb.encodedMessage;
101
            this. = spb.encodedScAddress;
102
        }
104
    }

    
Constructor

Hide:
111
    public SmsMessage() {
112
        this(getSmsFacility());
113
    }
115
    private SmsMessage(SmsMessageBase smb) {
116
         = smb;
117
    }

    
Create an SmsMessage from a raw PDU. 
122
    public static SmsMessage createFromPdu(byte[] pdu) {
123
        SmsMessageBase wrappedMessage;
124
        int activePhone = TelephonyManager.getDefault().getPhoneType();
126
        if ( == activePhone) {
127
            wrappedMessage = com.android.internal.telephony.cdma.SmsMessage.createFromPdu(pdu);
128
        } else {
129
            wrappedMessage = com.android.internal.telephony.gsm.SmsMessage.createFromPdu(pdu);
130
        }
132
        return new SmsMessage(wrappedMessage);
133
    }

    
TS 27.005 3.4.1 lines[0] and lines[1] are the two lines read from the +CMT unsolicited response (PDU mode, of course) +CMT: [<alpha>],<length><CR><LF><pdu> Only public for debugging and for RIL 
144
    public static SmsMessage newFromCMT(String[] lines){
145
        SmsMessageBase wrappedMessage;
146
        int activePhone = TelephonyManager.getDefault().getPhoneType();
148
        if ( == activePhone) {
149
            wrappedMessage = com.android.internal.telephony.cdma.SmsMessage.newFromCMT(lines);
150
        } else {
151
            wrappedMessage = com.android.internal.telephony.gsm.SmsMessage.newFromCMT(lines);
152
        }
154
        return new SmsMessage(wrappedMessage);
155
    }

    

Hide:
158
    protected static SmsMessage newFromCMTI(String line) {
159
        SmsMessageBase wrappedMessage;
160
        int activePhone = TelephonyManager.getDefault().getPhoneType();
162
        if ( == activePhone) {
163
            wrappedMessage = com.android.internal.telephony.cdma.SmsMessage.newFromCMTI(line);
164
        } else {
165
            wrappedMessage = com.android.internal.telephony.gsm.SmsMessage.newFromCMTI(line);
166
        }
168
        return new SmsMessage(wrappedMessage);
169
    }

    

Hide:
172
    public static SmsMessage newFromCDS(String line) {
173
        SmsMessageBase wrappedMessage;
174
        int activePhone = TelephonyManager.getDefault().getPhoneType();
176
        if ( == activePhone) {
177
            wrappedMessage = com.android.internal.telephony.cdma.SmsMessage.newFromCDS(line);
178
        } else {
179
            wrappedMessage = com.android.internal.telephony.gsm.SmsMessage.newFromCDS(line);
180
        }
182
        return new SmsMessage(wrappedMessage);
183
    }

    

Hide:
186
    public static SmsMessage newFromParcel(Parcel p) {
187
        SmsMessageBase wrappedMessage;
188
        int activePhone = TelephonyManager.getDefault().getPhoneType();
190
        if ( == activePhone) {
191
            wrappedMessage = com.android.internal.telephony.cdma.SmsMessage.newFromParcel(p);
192
        } else {
193
            wrappedMessage = com.android.internal.telephony.gsm.SmsMessage.newFromParcel(p);
194
        }
196
        return new SmsMessage(wrappedMessage);
197
    }

    
Create an SmsMessage from an SMS EF record.

Parameters:
index Index of SMS record. This should be index in ArrayList returned by SmsManager.getAllMessagesFromSim + 1.
data Record data.
Returns:
An SmsMessage representing the record.
Hide:
209
    public static SmsMessage createFromEfRecord(int index, byte[] data) {
210
        SmsMessageBase wrappedMessage;
211
        int activePhone = TelephonyManager.getDefault().getPhoneType();
213
        if ( == activePhone) {
214
            wrappedMessage = com.android.internal.telephony.cdma.SmsMessage.createFromEfRecord(
215
                    index, data);
216
        } else {
217
            wrappedMessage = com.android.internal.telephony.gsm.SmsMessage.createFromEfRecord(
218
                    index, data);
219
        }
221
        return wrappedMessage != null ? new SmsMessage(wrappedMessage) : null;
222
    }

    
Get the TP-Layer-Length for the given SMS-SUBMIT PDU Basically, the length in bytes (not hex chars) less the SMSC header 
228
    public static int getTPLayerLengthForPDU(String pdu) {
229
        int activePhone = TelephonyManager.getDefault().getPhoneType();
231
        if ( == activePhone) {
232
            return com.android.internal.telephony.cdma.SmsMessage.getTPLayerLengthForPDU(pdu);
233
        } else {
234
            return com.android.internal.telephony.gsm.SmsMessage.getTPLayerLengthForPDU(pdu);
235
        }
236
    }
238
    /*
239
     * TODO(cleanup): It would make some sense if the result of
240
     * preprocessing a message to determine the proper encoding (ie
241
     * the resulting datastructure from calculateLength) could be
242
     * passed as an argument to the actual final encoding function.
243
     * This would better ensure that the logic behind size calculation
244
     * actually matched the encoding.
245
     */

    
Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message.

Parameters:
msgBody the message to encode
use7bitOnly if true, characters that are not part of the radio-specific 7-bit encoding are counted as single space chars. If false, and if the messageBody contains non-7-bit encodable characters, length is calculated using a 16-bit encoding.
Returns:
an int[4] with int[0] being the number of SMS's required, int[1] the number of code units used, and int[2] is the number of code units remaining until the next message. int[3] is an indicator of the encoding code unit size (see the ENCODING_* definitions in this class).
264
    public static int[] calculateLength(CharSequence msgBody, boolean use7bitOnly) {
265
        int activePhone = TelephonyManager.getDefault().getPhoneType();
266
        TextEncodingDetails ted = ( == activePhone) ?
267
            com.android.internal.telephony.cdma.SmsMessage.calculateLength(msgBody, use7bitOnly) :
268
            com.android.internal.telephony.gsm.SmsMessage.calculateLength(msgBody, use7bitOnly);
269
        int ret[] = new int[4];
270
        ret[0] = ted.msgCount;
271
        ret[1] = ted.codeUnitCount;
272
        ret[2] = ted.codeUnitsRemaining;
273
        ret[3] = ted.codeUnitSize;
274
        return ret;
275
    }

    
Divide a message text into several fragments, none bigger than the maximum SMS message text size.

Parameters:
text text, must not be null.
Returns:
an ArrayList of strings that, in order, comprise the original msg text
Hide:
287
    public static ArrayList<String> fragmentText(String text) {
288
        int activePhone = TelephonyManager.getDefault().getPhoneType();
289
        TextEncodingDetails ted = ( == activePhone) ?
290
            com.android.internal.telephony.cdma.SmsMessage.calculateLength(text, false) :
291
            com.android.internal.telephony.gsm.SmsMessage.calculateLength(text, false);
293
        // TODO(cleanup): The code here could be rolled into the logic
294
        // below cleanly if these MAX_* constants were defined more
295
        // flexibly...
297
        int limit;
298
        if (ted.msgCount > 1) {
299
            limit = (ted.codeUnitSize == ) ?
301
        } else {
302
            limit = (ted.codeUnitSize == ) ?
303
                 : ;
304
        }
306
        int pos = 0;  // Index in code units.
307
        int textLen = text.length();
308
        ArrayList<String> result = new ArrayList<String>(ted.msgCount);
309
        while (pos < textLen) {
310
            int nextPos = 0;  // Counts code units.
311
            if (ted.codeUnitSize == ) {
312
                if (activePhone ==  && ted.msgCount == 1) {
313
                    // For a singleton CDMA message, the encoding must be ASCII...
314
                    nextPos = pos + Math.min(limit, textLen - pos);
315
                } else {
316
                    // For multi-segment messages, CDMA 7bit equals GSM 7bit encoding (EMS mode).
317
                    nextPos = GsmAlphabet.findGsmSeptetLimitIndex(text, pos, limit);
318
                }
319
            } else {  // Assume unicode.
320
                nextPos = pos + Math.min(limit / 2, textLen - pos);
321
            }
322
            if ((nextPos <= pos) || (nextPos > textLen)) {
323
                Log.e(, "fragmentText failed (" + pos + " >= " + nextPos + " or " +
324
                          nextPos + " >= " + textLen + ")");
325
                break;
326
            }
327
            result.add(text.substring(pos, nextPos));
328
            pos = nextPos;
329
        }
330
        return result;
331
    }

    
Calculates the number of SMS's required to encode the message body and the number of characters remaining until the next message, given the current encoding.

Parameters:
messageBody the message to encode
use7bitOnly if true, characters that are not part of the radio specific (GSM / CDMA) alphabet encoding are converted to as a single space characters. If false, a messageBody containing non-GSM or non-CDMA alphabet characters are encoded using 16-bit encoding.
Returns:
an int[4] with int[0] being the number of SMS's required, int[1] the number of code units used, and 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.
349
    public static int[] calculateLength(String messageBody, boolean use7bitOnly) {
350
        return calculateLength((CharSequence)messageBody, use7bitOnly);
351
    }
353
    /*
354
     * TODO(cleanup): It looks like there is now no useful reason why
355
     * apps should generate pdus themselves using these routines,
356
     * instead of handing the raw data to SMSDispatcher (and thereby
357
     * have the phone process do the encoding).  Moreover, CDMA now
358
     * has shared state (in the form of the msgId system property)
359
     * which can only be modified by the phone process, and hence
360
     * makes the output of these routines incorrect.  Since they now
361
     * serve no purpose, they should probably just return null
362
     * directly, and be deprecated.  Going further in that direction,
363
     * the above parsers of serialized pdu data should probably also
364
     * be gotten rid of, hiding all but the necessarily visible
365
     * structured data from client apps.  A possible concern with
366
     * doing this is that apps may be using these routines to generate
367
     * pdus that are then sent elsewhere, some network server, for
368
     * example, and that always returning null would thereby break
369
     * otherwise useful apps.
370
     */

    
Get an SMS-SUBMIT PDU for a destination address and a message

Parameters:
scAddress Service Centre address. Null means use default.
Returns:
a SubmitPdu containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.
Hide:
381
    public static SubmitPdu getSubmitPdu(String scAddress,
382
            String destinationAddress, String message,
383
            boolean statusReportRequested, byte[] header) {
384
        SubmitPduBase spb;
385
        int activePhone = TelephonyManager.getDefault().getPhoneType();
387
        if ( == activePhone) {
388
            spb = com.android.internal.telephony.cdma.SmsMessage.getSubmitPdu(scAddress,
389
                    destinationAddress, message, statusReportRequested,
390
                    SmsHeader.fromByteArray(header));
391
        } else {
392
            spb = com.android.internal.telephony.gsm.SmsMessage.getSubmitPdu(scAddress,
393
                    destinationAddress, message, statusReportRequested, header);
394
        }
396
        return new SubmitPdu(spb);
397
    }

    
Get an SMS-SUBMIT PDU for a destination address and a message

Parameters:
scAddress Service Centre address. Null means use default.
Returns:
a SubmitPdu containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.
407
    public static SubmitPdu getSubmitPdu(String scAddress,
408
            String destinationAddress, String message, boolean statusReportRequested) {
409
        SubmitPduBase spb;
410
        int activePhone = TelephonyManager.getDefault().getPhoneType();
412
        if ( == activePhone) {
413
            spb = com.android.internal.telephony.cdma.SmsMessage.getSubmitPdu(scAddress,
414
                    destinationAddress, message, statusReportRequested, null);
415
        } else {
416
            spb = com.android.internal.telephony.gsm.SmsMessage.getSubmitPdu(scAddress,
417
                    destinationAddress, message, statusReportRequested);
418
        }
420
        return new SubmitPdu(spb);
421
    }

    
Get an SMS-SUBMIT PDU for a data message to a destination address & port

Parameters:
scAddress Service Centre address. null == use default
destinationAddress the address of the destination for the message
destinationPort the port to deliver the message to at the destination
data the dat for the message
Returns:
a SubmitPdu containing the encoded SC address, if applicable, and the encoded message. Returns null on encode error.
435
    public static SubmitPdu getSubmitPdu(String scAddress,
436
            String destinationAddress, short destinationPort, byte[] data,
437
            boolean statusReportRequested) {
438
        SubmitPduBase spb;
439
        int activePhone = TelephonyManager.getDefault().getPhoneType();
441
        if ( == activePhone) {
442
            spb = com.android.internal.telephony.cdma.SmsMessage.getSubmitPdu(scAddress,
443
                    destinationAddress, destinationPort, data, statusReportRequested);
444
        } else {
445
            spb = com.android.internal.telephony.gsm.SmsMessage.getSubmitPdu(scAddress,
446
                    destinationAddress, destinationPort, data, statusReportRequested);
447
        }
449
        return new SubmitPdu(spb);
450
    }

    
Returns the address of the SMS service center that relayed this message or null if there is none. 
456
    public String getServiceCenterAddress() {
458
    }

    
Returns the originating address (sender) of this SMS message in String form or null if unavailable 
464
    public String getOriginatingAddress() {
465
        return .getOriginatingAddress();
466
    }

    
Returns the originating address, or email from address if this message was from an email gateway. Returns null if originating address unavailable. 
475
    }

    
Returns the message body as a String, if it exists and is text based.

Returns:
message body is there is one, otherwise null
481
    public String getMessageBody() {
482
        return .getMessageBody();
483
    }

    
Returns the class of this message. 
488
    public MessageClass getMessageClass() {
489
        return .getMessageClass();
490
    }

    
Returns the message body, or email message body if this message was from an email gateway. Returns null if message body unavailable. 
496
    public String getDisplayMessageBody() {
497
        return .getDisplayMessageBody();
498
    }

    
Unofficial convention of a subject line enclosed in parens empty string if not present 
504
    public String getPseudoSubject() {
505
        return .getPseudoSubject();
506
    }

    
Returns the service centre timestamp in currentTimeMillis() format 
511
    public long getTimestampMillis() {
512
        return .getTimestampMillis();
513
    }

    
Returns true if message is an email.

Returns:
true if this message came through an email gateway and email sender / subject / parsed body are available
521
    public boolean isEmail() {
522
        return .isEmail();
523
    }

     

Returns:
if isEmail() is true, body of the email sent through the gateway. null otherwise
529
    public String getEmailBody() {
530
        return .getEmailBody();
531
    }

    

Returns:
if isEmail() is true, email from address of email sent through the gateway. null otherwise
537
    public String getEmailFrom() {
538
        return .getEmailFrom();
539
    }

    
Get protocol identifier. 
544
    public int getProtocolIdentifier() {
545
        return .getProtocolIdentifier();
546
    }

    
See TS 23.040 9.2.3.9 returns true if this is a "replace short message" SMS 
552
    public boolean isReplace() {
553
        return .isReplace();
554
    }

    
Returns true for CPHS MWI toggle message.

Returns:
true if this is a CPHS MWI toggle message See CPHS 4.2 section B.4.2
562
    public boolean isCphsMwiMessage() {
563
        return .isCphsMwiMessage();
564
    }

    
returns true if this message is a CPHS voicemail / message waiting indicator (MWI) clear message 
570
    public boolean isMWIClearMessage() {
571
        return .isMWIClearMessage();
572
    }

    
returns true if this message is a CPHS voicemail / message waiting indicator (MWI) set message 
578
    public boolean isMWISetMessage() {
579
        return .isMWISetMessage();
580
    }

    
returns true if this message is a "Message Waiting Indication Group: Discard Message" notification and should not be stored. 
586
    public boolean isMwiDontStore() {
587
        return .isMwiDontStore();
588
    }

    
returns the user data section minus the user data header if one was present. 
594
    public byte[] getUserData() {
595
        return .getUserData();
596
    }

    
Return the user data header (UDH).

Hide:
603
    public SmsHeader getUserDataHeader() {
604
        return .getUserDataHeader();
605
    }

    
Returns the raw PDU for the message.

Returns:
the raw PDU for the message.
612
    public byte[] getPdu() {
613
        return .getPdu();
614
    }

    
Returns the status of the message on the SIM (read, unread, sent, unsent).

Deprecated:
Use getStatusOnIcc instead.
Returns:
the status of the message on the SIM. These are: SmsManager.STATUS_ON_SIM_FREE SmsManager.STATUS_ON_SIM_READ SmsManager.STATUS_ON_SIM_UNREAD SmsManager.STATUS_ON_SIM_SEND SmsManager.STATUS_ON_SIM_UNSENT
627
    @Deprecated public int getStatusOnSim() {
628
        return .getStatusOnIcc();
629
    }

    
Returns the status of the message on the ICC (read, unread, sent, unsent).

Returns:
the status of the message on the ICC. These are: SmsManager.STATUS_ON_ICC_FREE SmsManager.STATUS_ON_ICC_READ SmsManager.STATUS_ON_ICC_UNREAD SmsManager.STATUS_ON_ICC_SEND SmsManager.STATUS_ON_ICC_UNSENT
641
    public int getStatusOnIcc() {
643
        return .getStatusOnIcc();
644
    }

    
Returns the record index of the message on the SIM (1-based index).

Deprecated:
Use getIndexOnIcc instead.
Returns:
the record index of the message on the SIM, or -1 if this SmsMessage was not created from a SIM SMS EF record.
652
    @Deprecated public int getIndexOnSim() {
653
        return .getIndexOnIcc();
654
    }

    
Returns the record index of the message on the ICC (1-based index).

Returns:
the record index of the message on the ICC, or -1 if this SmsMessage was not created from a ICC SMS EF record.
661
    public int getIndexOnIcc() {
663
        return .getIndexOnIcc();
664
    }

    
GSM: For an SMS-STATUS-REPORT message, this returns the status field from the status report. This field indicates the status of a previously submitted SMS, if requested. See TS 23.040, 9.2.3.15 TP-Status for a description of values. CDMA: For not interfering with status codes from GSM, the value is shifted to the bits 31-16. The value is composed of an error class (bits 25-24) and a status code (bits 23-16). Possible codes are described in C.S0015-B, v2.0, 4.5.21.

Returns:
0 indicates the previously sent message was received. See TS 23.040, 9.9.2.3.15 and C.S0015-B, v2.0, 4.5.21 for a description of other possible values.
682
    public int getStatus() {
683
        return .getStatus();
684
    }

    
Return true iff the message is a SMS-STATUS-REPORT message. 
689
    public boolean isStatusReportMessage() {
690
        return .isStatusReportMessage();
691
    }

    
Returns true iff the TP-Reply-Path bit is set in this message. 
697
    public boolean isReplyPathPresent() {
698
        return .isReplyPathPresent();
699
    }

    
This method returns the reference to a specific SmsMessage object, which is used for accessing its static methods.

Returns:
Specific SmsMessage.
Hide:
707
    private static final SmsMessageBase getSmsFacility(){
708
        int activePhone = TelephonyManager.getDefault().getPhoneType();
709
        if ( == activePhone) {
710
            return new com.android.internal.telephony.cdma.SmsMessage();
711
        } else {
712
            return new com.android.internal.telephony.gsm.SmsMessage();
713
        }
714
    }
New to GrepCode? Check out our FAQ X