Merge "Update Docs to clarify using a Message across IPC"

telephony/java/android/telephony/ims/feature/MmTelFeature.java

@@ -18,7 +18,6 @@ package android.telephony.ims.feature;
 
 import android.annotation.IntDef;
 import android.annotation.SystemApi;
-import android.net.Uri;
 import android.os.Bundle;
 import android.os.Message;
 import android.os.RemoteException;
@@ -644,7 +643,19 @@ public class MmTelFeature extends ImsFeature {
      *         {@link TelecomManager#TTY_MODE_FULL},
      *         {@link TelecomManager#TTY_MODE_HCO},
      *         {@link TelecomManager#TTY_MODE_VCO}
-     * @param onCompleteMessage A {@link Message} to be used when the mode has been set.
+     * @param onCompleteMessage If non-null, this MmTelFeature should call this {@link Message} when
+     *         the operation is complete by using the associated {@link android.os.Messenger} in
+     *         {@link Message#replyTo}. For example:
+     * {@code
+     *     // Set UI TTY Mode and other operations...
+     *     try {
+     *         // Notify framework that the mode was changed.
+     *         Messenger uiMessenger = onCompleteMessage.replyTo;
+     *         uiMessenger.send(onCompleteMessage);
+     *     } catch (RemoteException e) {
+     *         // Remote side is dead
+     *     }
+     * }
      */
     public void setUiTtyMode(int mode, Message onCompleteMessage) {
         // Base Implementation - Should be overridden

telephony/java/android/telephony/ims/stub/ImsCallSessionImplBase.java

@@ -30,8 +30,6 @@ import com.android.ims.internal.IImsCallSession;
 import com.android.ims.internal.IImsVideoCallProvider;
 import android.telephony.ims.ImsVideoCallProvider;
 
-import dalvik.system.CloseGuard;
-
 /**
  * Base implementation of IImsCallSession, which implements stub versions of the methods available.
  *
@@ -510,6 +508,21 @@ public class ImsCallSessionImplBase implements AutoCloseable {
      * and event flash to 16. Currently, event flash is not supported.
      *
      * @param c the DTMF to send. '0' ~ '9', 'A' ~ 'D', '*', '#' are valid inputs.
+     * @param result If non-null, the {@link Message} to send when the operation is complete. This
+     *         is done by using the associated {@link android.os.Messenger} in
+     *         {@link Message#replyTo}. For example:
+     * {@code
+     *     // Send DTMF and other operations...
+     *     try {
+     *         // Notify framework that the DTMF was sent.
+     *         Messenger dtmfMessenger = result.replyTo;
+     *         if (dtmfMessenger != null) {
+     *             dtmfMessenger.send(result);
+     *         }
+     *     } catch (RemoteException e) {
+     *         // Remote side is dead
+     *     }
+     * }
      */
     public void sendDtmf(char c, Message result) {
     }