Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 36b1c16d authored by Nathan Harold's avatar Nathan Harold
Browse files

Update Docstring for SmsMessage.getOriginatingAddress 

There was a public request for clarification on the address
format for getOriginatingAddress. I did a little research and
have added the answer to the docstring.

Bug: 64697463
Test: compilation
Change-Id: Icf37af0a5940a6fb7798d7c7cafe7b97683bb689
parent 78350411

telephony/java/android/telephony/SmsMessage.java

+10 −2
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ package android.telephony; 


import static android.telephony.TelephonyManager.PHONE_TYPE_CDMA;



import android.annotation.Nullable;

import android.annotation.StringDef;

import android.app.PendingIntent;

import android.content.res.Resources;

import android.os.Binder;

import android.text.TextUtils;
@@ -544,8 +544,16 @@ public class SmsMessage { 


    /**

     * Returns the originating address (sender) of this SMS message in String

     * form or null if unavailable

     * form or null if unavailable.

     *

     * <p>If the address is a GSM-formatted address, it will be in a format specified by 3GPP

     * 23.040 Sec 9.1.2.5. If it is a CDMA address, it will be a format specified by 3GPP2

     * C.S005-D Table 2.7.1.3.2.4-2. The choice of format is carrier-specific, so callers of the

     * should be careful to avoid assumptions about the returned content.

     *

     * @return a String representation of the address; null if unavailable.

     */

    @Nullable

    public String getOriginatingAddress() {

        return mWrappedSmsMessage.getOriginatingAddress();

    }