From 5508591b92bbbdf6dee9738bbbcf4e13d29e222e Mon Sep 17 00:00:00 2001 From: Hall Liu Date: Thu, 27 Feb 2020 18:34:11 -0800 Subject: [PATCH] Update docs for getGenericConferenceActiveChildCall Update the documentation for getGenericConferenceActiveChildCall to make it more clear what a generic conference is and which call the method will actually return. Fixes: 148515394 Test: none, docs only change Change-Id: Idfee3fc23c7f6035f7b980fbb4dfe68c2834c388 --- telecomm/java/android/telecom/Call.java | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/telecomm/java/android/telecom/Call.java b/telecomm/java/android/telecom/Call.java index c5fcf67c9be9f..ead90bb4561f0 100755 --- a/telecomm/java/android/telecom/Call.java +++ b/telecomm/java/android/telecom/Call.java @@ -2075,6 +2075,17 @@ public final class Call { /** * Returns the child {@link Call} in a generic conference that is currently active. + * + * A "generic conference" is the mechanism used to support two simultaneous calls on a device + * in CDMA networks. It is effectively equivalent to having one call active and one call on hold + * in GSM or IMS calls. This method returns the currently active call. + * + * In a generic conference, the network exposes the conference to us as a single call, and we + * switch between talking to the two participants using a CDMA flash command. Since the network + * exposes no additional information about the call, the only way we know which caller we're + * currently talking to is by keeping track of the flash commands that we've sent to the + * network. + * * For calls that are not generic conferences, or when the generic conference has more than * 2 children, returns {@code null}. * @see Details#PROPERTY_GENERIC_CONFERENCE