Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 41895157 authored by Grace Jia's avatar Grace Jia
Browse files

Annotation and doc improvement for adhoc conference APIs. 

Annotate Conference#onAnswer with @VideoState
Mark parameters of adhoc conference APIs with @NonNull.
Document the distinction between returning null and returning a failed conference.
Bug: 165801368
Test: make

Change-Id: Ic0bd1a1e431ca0dec52afc8a28996929684236ba
parent 942b71b4

core/api/current.txt

+5 −5
Original line number Diff line number Diff line
@@ -38674,22 +38674,22 @@ package android.telecom { 
    method public final void conferenceRemoteConnections(android.telecom.RemoteConnection, android.telecom.RemoteConnection);

    method public final void connectionServiceFocusReleased();

    method @Nullable public final android.telecom.RemoteConference createRemoteIncomingConference(@Nullable android.telecom.PhoneAccountHandle, @Nullable android.telecom.ConnectionRequest);

    method public final android.telecom.RemoteConnection createRemoteIncomingConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method @Nullable public final android.telecom.RemoteConnection createRemoteIncomingConnection(@NonNull android.telecom.PhoneAccountHandle, @NonNull android.telecom.ConnectionRequest);

    method @Nullable public final android.telecom.RemoteConference createRemoteOutgoingConference(@Nullable android.telecom.PhoneAccountHandle, @Nullable android.telecom.ConnectionRequest);

    method public final android.telecom.RemoteConnection createRemoteOutgoingConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method @Nullable public final android.telecom.RemoteConnection createRemoteOutgoingConnection(@NonNull android.telecom.PhoneAccountHandle, @NonNull android.telecom.ConnectionRequest);

    method public final java.util.Collection<android.telecom.Conference> getAllConferences();

    method public final java.util.Collection<android.telecom.Connection> getAllConnections();

    method public final android.os.IBinder onBind(android.content.Intent);

    method public void onConference(android.telecom.Connection, android.telecom.Connection);

    method public void onConnectionServiceFocusGained();

    method public void onConnectionServiceFocusLost();

    method @Nullable public android.telecom.Conference onCreateIncomingConference(@Nullable android.telecom.PhoneAccountHandle, @Nullable android.telecom.ConnectionRequest);

    method @Nullable public android.telecom.Conference onCreateIncomingConference(@NonNull android.telecom.PhoneAccountHandle, @NonNull android.telecom.ConnectionRequest);

    method public void onCreateIncomingConferenceFailed(@Nullable android.telecom.PhoneAccountHandle, @Nullable android.telecom.ConnectionRequest);

    method public android.telecom.Connection onCreateIncomingConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method public void onCreateIncomingConnectionFailed(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method public android.telecom.Connection onCreateIncomingHandoverConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method @Nullable public android.telecom.Conference onCreateOutgoingConference(@Nullable android.telecom.PhoneAccountHandle, @Nullable android.telecom.ConnectionRequest);

    method public void onCreateOutgoingConferenceFailed(@Nullable android.telecom.PhoneAccountHandle, @Nullable android.telecom.ConnectionRequest);

    method @Nullable public android.telecom.Conference onCreateOutgoingConference(@NonNull android.telecom.PhoneAccountHandle, @NonNull android.telecom.ConnectionRequest);

    method public void onCreateOutgoingConferenceFailed(@NonNull android.telecom.PhoneAccountHandle, @NonNull android.telecom.ConnectionRequest);

    method public android.telecom.Connection onCreateOutgoingConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method public void onCreateOutgoingConnectionFailed(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

    method public android.telecom.Connection onCreateOutgoingHandoverConnection(android.telecom.PhoneAccountHandle, android.telecom.ConnectionRequest);

telecomm/java/android/telecom/Conference.java

+1 −1
Original line number Diff line number Diff line
@@ -338,7 +338,7 @@ public abstract class Conference extends Conferenceable { 
     *

     * @param videoState The video state in which to answer the connection.

     */

    public void onAnswer(int videoState) {}

    public void onAnswer(@VideoProfile.VideoState int videoState) {}



    /**

     * Notifies this Conference, which is in {@code STATE_RINGING}, of

telecomm/java/android/telecom/ConnectionService.java

+20 −16
Original line number Diff line number Diff line
@@ -2463,9 +2463,9 @@ public abstract class ConnectionService extends Service { 
     * @return The {@code Connection} object to satisfy this call, or {@code null} to

     *         not handle the call.

     */

    public final RemoteConnection createRemoteIncomingConnection(

            PhoneAccountHandle connectionManagerPhoneAccount,

            ConnectionRequest request) {

    public final @Nullable RemoteConnection createRemoteIncomingConnection(

            @NonNull PhoneAccountHandle connectionManagerPhoneAccount,

            @NonNull ConnectionRequest request) {

        return mRemoteConnectionManager.createRemoteConnection(

                connectionManagerPhoneAccount, request, true);

    }
@@ -2482,9 +2482,9 @@ public abstract class ConnectionService extends Service { 
     * @return The {@code Connection} object to satisfy this call, or {@code null} to

     *         not handle the call.

     */

    public final RemoteConnection createRemoteOutgoingConnection(

            PhoneAccountHandle connectionManagerPhoneAccount,

            ConnectionRequest request) {

    public final @Nullable RemoteConnection createRemoteOutgoingConnection(

            @NonNull PhoneAccountHandle connectionManagerPhoneAccount,

            @NonNull ConnectionRequest request) {

        return mRemoteConnectionManager.createRemoteConnection(

                connectionManagerPhoneAccount, request, false);

    }
@@ -2724,12 +2724,14 @@ public abstract class ConnectionService extends Service { 
     * @param connectionManagerPhoneAccount See description at

     *         {@link #onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}.

     * @param request Details about the incoming conference call.

     * @return The {@code Conference} object to satisfy this call, or {@code null} to

     *         not handle the call.

     * @return The {@code Conference} object to satisfy this call. If the conference attempt is

     *         failed, the return value will be a result of an invocation of

     *         {@link Connection#createFailedConnection(DisconnectCause)}.

     *         Return {@code null} if the {@link ConnectionService} cannot handle the call.

     */

    public @Nullable Conference onCreateIncomingConference(

            @Nullable PhoneAccountHandle connectionManagerPhoneAccount,

            @Nullable ConnectionRequest request) {

            @NonNull PhoneAccountHandle connectionManagerPhoneAccount,

            @NonNull ConnectionRequest request) {

        return null;

    }
@@ -2832,8 +2834,8 @@ public abstract class ConnectionService extends Service { 
     * @param request The outgoing connection request.

     */

    public void onCreateOutgoingConferenceFailed(

            @Nullable PhoneAccountHandle connectionManagerPhoneAccount,

            @Nullable ConnectionRequest request) {

            @NonNull PhoneAccountHandle connectionManagerPhoneAccount,

            @NonNull ConnectionRequest request) {

    }
@@ -2897,12 +2899,14 @@ public abstract class ConnectionService extends Service { 
     *         a {@code PhoneAccount} registered by this {@code ConnectionService} to use for

     *         making the connection.

     * @param request Details about the outgoing call.

     * @return The {@code Conference} object to satisfy this call, or the result of an invocation

     *         of {@link Connection#createFailedConnection(DisconnectCause)} to not handle the call.

     * @return The {@code Conference} object to satisfy this call. If the conference attempt is

     *         failed, the return value will be a result of an invocation of

     *         {@link Connection#createFailedConnection(DisconnectCause)}.

     *         Return {@code null} if the {@link ConnectionService} cannot handle the call.

     */

    public @Nullable Conference onCreateOutgoingConference(

            @Nullable PhoneAccountHandle connectionManagerPhoneAccount,

            @Nullable ConnectionRequest request) {

            @NonNull PhoneAccountHandle connectionManagerPhoneAccount,

            @NonNull ConnectionRequest request) {

        return null;

    }