Merge "update CallControlCallback docs for the rejection case" into udc-dev

This commit is contained in:
Treehugger Robot
2023-05-04 05:28:00 +00:00
committed by Android (Google) Code Review

View File

@@ -44,9 +44,11 @@ public interface CallControlCallback {
*
* @param wasCompleted The {@link Consumer} to be completed. If the client can set the call
* active on their end, the {@link Consumer#accept(Object)} should be
* called with {@link Boolean#TRUE}. Otherwise,
* {@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}.
* called with {@link Boolean#TRUE}.
*
* Otherwise, {@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}. Telecom will effectively ignore the remote
* setActive request and the call will remain in whatever state it is in.
*/
void onSetActive(@NonNull Consumer<Boolean> wasCompleted);
@@ -56,9 +58,11 @@ public interface CallControlCallback {
*
* @param wasCompleted The {@link Consumer} to be completed. If the client can set the call
* inactive on their end, the {@link Consumer#accept(Object)} should be
* called with {@link Boolean#TRUE}. Otherwise,
* {@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}.
* called with {@link Boolean#TRUE}.
*
* Otherwise, {@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}. Telecom will effectively ignore the remote
* setInactive request and the call will remain in whatever state it is in.
*/
void onSetInactive(@NonNull Consumer<Boolean> wasCompleted);
@@ -68,8 +72,11 @@ public interface CallControlCallback {
* @param videoState see {@link android.telecom.CallAttributes.CallType} for valid states
* @param wasCompleted The {@link Consumer} to be completed. If the client can answer the call
* on their end, {@link Consumer#accept(Object)} should be called with
* {@link Boolean#TRUE}. Otherwise, {@link Consumer#accept(Object)} should
* be called with {@link Boolean#FALSE}.
* {@link Boolean#TRUE}.
*
* Otherwise,{@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}. However, Telecom will still disconnect
* the call and remove it from tracking.
*/
void onAnswer(@android.telecom.CallAttributes.CallType int videoState,
@NonNull Consumer<Boolean> wasCompleted);
@@ -80,9 +87,11 @@ public interface CallControlCallback {
* @param disconnectCause represents the cause for disconnecting the call.
* @param wasCompleted The {@link Consumer} to be completed. If the client can disconnect
* the call on their end, {@link Consumer#accept(Object)} should be
* called with {@link Boolean#TRUE}. Otherwise,
* {@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}.
* called with {@link Boolean#TRUE}.
*
* Otherwise,{@link Consumer#accept(Object)} should be called with
* {@link Boolean#FALSE}. However, Telecom will still disconnect
* the call and remove it from tracking.
*/
void onDisconnect(@NonNull DisconnectCause disconnectCause,
@NonNull Consumer<Boolean> wasCompleted);