OSDN Git Service

Update onDeregistered docs to make capability change expectations clear.
authorTyler Gunn <tgunn@google.com>
Tue, 22 May 2018 22:01:43 +0000 (15:01 -0700)
committerTyler Gunn <tgunn@google.com>
Fri, 15 Jun 2018 16:15:32 +0000 (09:15 -0700)
Updating the onDeregistered docs to make it clear that the ImsService
must report any feature capability changes to the framework prior to
de-registration.

Bug: 73076695
Test: Docs only change.
Merged-In: Ib9bc88bfb43670f04c8afde36d0947255399397a
Change-Id: Ib9bc88bfb43670f04c8afde36d0947255399397a

telephony/java/android/telephony/ims/stub/ImsRegistrationImplBase.java

index 4334d3a..3138180 100644 (file)
@@ -213,6 +213,17 @@ public class ImsRegistrationImplBase {
 
     /**
      * Notify the framework that the device is disconnected from the IMS network.
+     * <p>
+     * Note: Prior to calling {@link #onDeregistered(ImsReasonInfo)}, you should ensure that any
+     * changes to {@link android.telephony.ims.feature.ImsFeature} capability availability is sent
+     * to the framework.  For example,
+     * {@link android.telephony.ims.feature.MmTelFeature.MmTelCapabilities#CAPABILITY_TYPE_VIDEO}
+     * and
+     * {@link android.telephony.ims.feature.MmTelFeature.MmTelCapabilities#CAPABILITY_TYPE_VOICE}
+     * may be set to unavailable to ensure the framework knows these services are no longer
+     * available due to de-registration.  If you do not report capability changes impacted by
+     * de-registration, the framework will not know which features are no longer available as a
+     * result.
      *
      * @param info the {@link ImsReasonInfo} associated with why registration was disconnected.
      */