diff options
author | Nancy Chen <nancychen@google.com> | 2014-09-09 12:24:51 -0700 |
---|---|---|
committer | Nancy Chen <nancychen@google.com> | 2014-09-09 16:14:16 -0700 |
commit | 56fc25deec15a32ea5f37d7c8c82f16d1bf9d275 (patch) | |
tree | bfa5b747b299874a53638ce48580d0a18131d0ed /telecomm | |
parent | be5b6569407635eb8d23b1934f90a508da0e60be (diff) | |
download | frameworks_base-56fc25deec15a32ea5f37d7c8c82f16d1bf9d275.zip frameworks_base-56fc25deec15a32ea5f37d7c8c82f16d1bf9d275.tar.gz frameworks_base-56fc25deec15a32ea5f37d7c8c82f16d1bf9d275.tar.bz2 |
Add docs to Conference object.
All public methods now have docs.
Bug: 17329632
Change-Id: I0a0e87bd3d78bda85524853882f9fe8a4d18401c
Diffstat (limited to 'telecomm')
-rw-r--r-- | telecomm/java/android/telecomm/Conference.java | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/telecomm/java/android/telecomm/Conference.java b/telecomm/java/android/telecomm/Conference.java index f9c3ac3..a4f9c2c 100644 --- a/telecomm/java/android/telecomm/Conference.java +++ b/telecomm/java/android/telecomm/Conference.java @@ -50,22 +50,47 @@ public abstract class Conference { private int mCapabilities; private String mDisconnectMessage; + /** + * Constructs a new Conference with a mandatory {@link PhoneAccountHandle} + * + * @param phoneAccount The {@code PhoneAccountHandle} associated with the conference. + */ public Conference(PhoneAccountHandle phoneAccount) { mPhoneAccount = phoneAccount; } + /** + * Returns the {@link PhoneAccountHandle} the conference call is being placed through. + * + * @return A {@code PhoneAccountHandle} object representing the PhoneAccount of the conference. + */ public final PhoneAccountHandle getPhoneAccountHandle() { return mPhoneAccount; } + /** + * Returns the list of connections currently associated with the conference call. + * + * @return A list of {@code Connection} objects which represent the children of the conference. + */ public final List<Connection> getConnections() { return mUnmodifiableChildConnections; } + /** + * Gets the state of the conference call. See {@link Connection} for valid values. + * + * @return A constant representing the state the conference call is currently in. + */ public final int getState() { return mState; } + /** + * Returns the capabilities of a conference. See {@link PhoneCapabilities} for valid values. + * + * @return A bitmask of the {@code PhoneCapabilities} of the conference call. + */ public final int getCapabilities() { return mCapabilities; } @@ -135,7 +160,9 @@ public abstract class Conference { } /** - * Sets the capabilities of a conference. + * Sets the capabilities of a conference. See {@link PhoneCapabilities} for valid values. + * + * @param capabilities A bitmask of the {@code PhoneCapabilities} of the conference call. */ public final void setCapabilities(int capabilities) { if (capabilities != mCapabilities) { @@ -170,7 +197,6 @@ public abstract class Conference { * Removes the specified connection as a child of this conference. * * @param connection The connection to remove. - * @return True if the connection was successfully removed. */ public final void removeConnection(Connection connection) { Log.d(this, "removing %s from %s", connection, mChildConnections); |