drgreen/android_frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Update PhoneAccountHandle API docs." am: 95a0ece6cc am: 36b124ccb7

Browse Source 
Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/1755371

Change-Id: I131e8b037099a84b9f43aba0a681ec9ddcf12644
This commit is contained in:
Treehugger Robot 2021-07-13 05:50:07 +00:00 committed by Automerger Merge Worker
commit a8c44879f1
1 changed files with 37 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
telecomm/java/android/telecom/PhoneAccountHandle.java
View File

@ -34,7 +34,10 @@ import java.util.Objects;
* <ul>
* <li>The component name of the associated connection service.</li>
* <li>A string identifier that is unique across {@code PhoneAccountHandle}s with the same
* component name.</li>
* component name. Apps registering {@link PhoneAccountHandle}s should ensure that the
* {@link #getId()} provided does not expose personally identifying information. A
* {@link ConnectionService} should use an opaque token as the {@link PhoneAccountHandle}
* identifier.</li>
* </ul>
*
* Note: This Class requires a non-null {@link ComponentName} and {@link UserHandle} to operate
@ -49,12 +52,35 @@ public final class PhoneAccountHandle implements Parcelable {
private final String mId;
private final UserHandle mUserHandle;
/**
* Creates a new {@link PhoneAccountHandle}.
*
* @param componentName The {@link ComponentName} of the {@link ConnectionService} which
* services this {@link PhoneAccountHandle}.
* @param id A string identifier that is unique across {@code PhoneAccountHandle}s with the same
* component name. Apps registering {@link PhoneAccountHandle}s should ensure that the
* ID provided does not expose personally identifying information. A
* {@link ConnectionService} should use an opaque token as the
* {@link PhoneAccountHandle} identifier.
*/
public PhoneAccountHandle(
@NonNull ComponentName componentName,
@NonNull String id) {
this(componentName, id, Process.myUserHandle());
}
/**
* Creates a new {@link PhoneAccountHandle}.
*
* @param componentName The {@link ComponentName} of the {@link ConnectionService} which
* services this {@link PhoneAccountHandle}.
* @param id A string identifier that is unique across {@code PhoneAccountHandle}s with the same
* component name. Apps registering {@link PhoneAccountHandle}s should ensure that the
* ID provided does not expose personally identifying information. A
* {@link ConnectionService} should use an opaque token as the
* {@link PhoneAccountHandle} identifier.
* @param userHandle The {@link UserHandle} associated with this {@link PhoneAccountHandle}.
*/
public PhoneAccountHandle(
@NonNull ComponentName componentName,
@NonNull String id,
@ -80,17 +106,17 @@ public final class PhoneAccountHandle implements Parcelable {
* others supported by the connection service that created it.
* <p>
* A connection service must select identifiers that are stable for the lifetime of
* their users' relationship with their service, across many Android devices. For example, a
* good set of identifiers might be the email addresses with which with users registered for
* their accounts with a particular service. Depending on how a service chooses to operate,
* a bad set of identifiers might be an increasing series of integers
* ({@code 0}, {@code 1}, {@code 2}, ...) that are generated locally on each phone and could
* collide with values generated on other phones or after a data wipe of a given phone.
*
* their users' relationship with their service, across many Android devices. The identifier
* should be a stable opaque token which uniquely identifies the user within the service.
* Depending on how a service chooses to operate, a bad set of identifiers might be an
* increasing series of integers ({@code 0}, {@code 1}, {@code 2}, ...) that are generated
* locally on each phone and could collide with values generated on other phones or after a data
* wipe of a given phone.
* <p>
* Important: A non-unique identifier could cause non-deterministic call-log backup/restore
* behavior.
*
* @return A service-specific unique identifier for this {@code PhoneAccountHandle}.
* @return A service-specific unique opaque identifier for this {@code PhoneAccountHandle}.
*/
public String getId() {
return mId;
@ -157,7 +183,8 @@ public final class PhoneAccountHandle implements Parcelable {
}
}
public static final @android.annotation.NonNull Creator<PhoneAccountHandle> CREATOR = new Creator<PhoneAccountHandle>() {
public static final @android.annotation.NonNull Creator<PhoneAccountHandle> CREATOR =
new Creator<PhoneAccountHandle>() {
@Override
public PhoneAccountHandle createFromParcel(Parcel in) {
return new PhoneAccountHandle(in);