From 07f21cf510610f9d468c671f071d58f4a1e5ef79 Mon Sep 17 00:00:00 2001 From: Nathan Harold Date: Mon, 29 Jan 2018 11:36:03 -0800 Subject: [PATCH] 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 Merged-In: Icf37af0a5940a6fb7798d7c7cafe7b97683bb689 Change-Id: Icf37af0a5940a6fb7798d7c7cafe7b97683bb689 --- telephony/java/android/telephony/SmsMessage.java | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/telephony/java/android/telephony/SmsMessage.java b/telephony/java/android/telephony/SmsMessage.java index dcdda8685e029..6e083c21cd5b7 100644 --- a/telephony/java/android/telephony/SmsMessage.java +++ b/telephony/java/android/telephony/SmsMessage.java @@ -16,6 +16,7 @@ package android.telephony; +import android.annotation.Nullable; import android.os.Binder; import android.os.Parcel; import android.content.res.Resources; @@ -534,8 +535,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. + * + *

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(); }