Improve QUALITY_* constant documentation

Given devs a better idea of how these quality constant may work.

Bug: 168624248
Test: n/a
Change-Id: I16910bc45d013b4a366d4e8036f63fdfbef55461
This commit is contained in:
Soonil Nagarkar
2020-10-20 11:36:22 -07:00
parent 5fbbee8e29
commit c73cecefc1

View File

@@ -74,19 +74,27 @@ public final class LocationRequest implements Parcelable {
/**
* A quality constant indicating a location provider may choose to satisfy this request by
* providing very accurate locations at the expense of potentially increased power usage.
* providing very accurate locations at the expense of potentially increased power usage. Each
* location provider may interpret this field differently, but as an example, the network
* provider may choose to return only wifi based locations rather than cell based locations in
* order to have greater accuracy when this flag is present.
*/
public static final int QUALITY_HIGH_ACCURACY = 100;
/**
* A quality constant indicating a location provider may choose to satisfy this request by
* equally balancing power and accuracy constraints.
* equally balancing power and accuracy constraints. Each location provider may interpret this
* field differently, but location providers will generally use their default behavior when this
* flag is present.
*/
public static final int QUALITY_BALANCED_POWER_ACCURACY = 102;
/**
* A quality constant indicating a location provider may choose to satisfy this request by
* providing less accurate locations in order to save power.
* providing less accurate locations in order to save power. Each location provider may
* interpret this field differently, but as an example, the network provider may choose to
* return cell based locations rather than wifi based locations in order to save power when this
* flag is present.
*/
public static final int QUALITY_LOW_POWER = 104;