Update documentation for phone account sort order

Update documentation to reflect that the sort order extra
should contain integers.

Bug: 169153499
Test: docs only
Change-Id: Ic5269d577f007e01a0c9eaa95cd7e8814ab8f79a
This commit is contained in:
Hall Liu
2020-09-29 15:15:24 -07:00
parent b9e67709b2
commit 4bb53ec753

View File

@@ -49,12 +49,11 @@ import java.util.Objects;
public final class PhoneAccount implements Parcelable { public final class PhoneAccount implements Parcelable {
/** /**
* String extra which determines the order in which {@link PhoneAccount}s are sorted * Integer extra which determines the order in which {@link PhoneAccount}s are sorted
* *
* This is an extras key set via {@link Builder#setExtras} which determines the order in which * This is an extras key set via {@link Builder#setExtras} which determines the order in which
* {@link PhoneAccount}s from the same {@link ConnectionService} are sorted. The accounts * {@link PhoneAccount}s from the same {@link ConnectionService} are sorted. The accounts
* are sorted by this key via standard lexicographical order, (as implemented in * are sorted in ascending order by this key, and this ordering is used to
* {@link String#compareTo}), and this ordering is used to
* determine priority when a call can be placed via multiple accounts. * determine priority when a call can be placed via multiple accounts.
* *
* When multiple {@link PhoneAccount}s are supplied with the same sort order key, no ordering is * When multiple {@link PhoneAccount}s are supplied with the same sort order key, no ordering is