ProviderProperties
class ProviderProperties : Parcelable
| kotlin.Any | |
| ↳ | android.location.provider.ProviderProperties |
Location provider properties.
Summary
| Nested classes | |
|---|---|
|
Builder for ProviderProperties. |
|
| Constants | |
|---|---|
| static Int |
A constant indicating a coarser location accuracy. |
| static Int |
A constant indicating a finer location accuracy. |
| static Int |
A constant indicating high power usage. |
| static Int |
A constant indicating low power usage. |
| static Int |
A constant indicating a medium power usage. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
Rough location accuracy for this provider, primarily with respect to horizontal location accuracy. |
| Int |
Power usage for this provider. |
| Boolean |
True if the provider is able to provide altitude under at least some conditions. |
| Boolean |
True if the provider is able to provide bearing under at least some conditions. |
| Boolean |
True if the provider requires access to a cellular network (e.g., for cell tower IDs). |
| Boolean |
True if this provider may result in a monetary charge to the user. |
| Boolean |
True if provider requires access to a data network (e.g., the Internet). |
| Boolean |
True if the provider requires access to a satellite-based positioning system (e.g., GPS). |
| Boolean |
True if the provider is able to provide speed under at least some conditions. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(parcel: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<ProviderProperties!> | |
Constants
ACCURACY_COARSE
static val ACCURACY_COARSE: Int
A constant indicating a coarser location accuracy.
Value: 2ACCURACY_FINE
static val ACCURACY_FINE: Int
A constant indicating a finer location accuracy.
Value: 1POWER_USAGE_HIGH
static val POWER_USAGE_HIGH: Int
A constant indicating high power usage.
Value: 3POWER_USAGE_LOW
static val POWER_USAGE_LOW: Int
A constant indicating low power usage.
Value: 1POWER_USAGE_MEDIUM
static val POWER_USAGE_MEDIUM: Int
A constant indicating a medium power usage.
Value: 2Public methods
describeContents
fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAccuracy
fun getAccuracy(): Int
Rough location accuracy for this provider, primarily with respect to horizontal location accuracy.
| Return | |
|---|---|
Int |
Value is one of the following: |
getPowerUsage
fun getPowerUsage(): Int
Power usage for this provider.
| Return | |
|---|---|
Int |
Value is one of the following: |
hasAltitudeSupport
fun hasAltitudeSupport(): Boolean
True if the provider is able to provide altitude under at least some conditions.
hasBearingSupport
fun hasBearingSupport(): Boolean
True if the provider is able to provide bearing under at least some conditions.
hasCellRequirement
fun hasCellRequirement(): Boolean
True if the provider requires access to a cellular network (e.g., for cell tower IDs).
hasMonetaryCost
fun hasMonetaryCost(): Boolean
True if this provider may result in a monetary charge to the user. Network usage is not considered a monetary cost.
hasNetworkRequirement
fun hasNetworkRequirement(): Boolean
True if provider requires access to a data network (e.g., the Internet).
hasSatelliteRequirement
fun hasSatelliteRequirement(): Boolean
True if the provider requires access to a satellite-based positioning system (e.g., GPS).
hasSpeedSupport
fun hasSpeedSupport(): Boolean
True if the provider is able to provide speed under at least some conditions.
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
parcel: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
The Parcel in which the object should be written. This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|
parcel |
Parcel: This value cannot be null. |