Added in API level 31

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
equals(other: Any?)

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

Returns a hash code value for the object.

String

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

Added in API level 31
static val ACCURACY_COARSE: Int

A constant indicating a coarser location accuracy.

Value: 2

ACCURACY_FINE

Added in API level 31
static val ACCURACY_FINE: Int

A constant indicating a finer location accuracy.

Value: 1

POWER_USAGE_HIGH

Added in API level 31
static val POWER_USAGE_HIGH: Int

A constant indicating high power usage.

Value: 3

POWER_USAGE_LOW

Added in API level 31
static val POWER_USAGE_LOW: Int

A constant indicating low power usage.

Value: 1

POWER_USAGE_MEDIUM

Added in API level 31
static val POWER_USAGE_MEDIUM: Int

A constant indicating a medium power usage.

Value: 2

Public methods

describeContents

Added in API level 31
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

Added in API level 31
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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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

Added in API level 31
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

Added in API level 31
fun getPowerUsage(): Int

Power usage for this provider.

Return
Int Value is one of the following:

hasAltitudeSupport

Added in API level 31
fun hasAltitudeSupport(): Boolean

True if the provider is able to provide altitude under at least some conditions.

hasBearingSupport

Added in API level 31
fun hasBearingSupport(): Boolean

True if the provider is able to provide bearing under at least some conditions.

hasCellRequirement

Added in API level 31
fun hasCellRequirement(): Boolean

True if the provider requires access to a cellular network (e.g., for cell tower IDs).

hasMonetaryCost

Added in API level 31
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

Added in API level 31
fun hasNetworkRequirement(): Boolean

True if provider requires access to a data network (e.g., the Internet).

hasSatelliteRequirement

Added in API level 31
fun hasSatelliteRequirement(): Boolean

True if the provider requires access to a satellite-based positioning system (e.g., GPS).

hasSpeedSupport

Added in API level 31
fun hasSpeedSupport(): Boolean

True if the provider is able to provide speed under at least some conditions.

hashCode

Added in API level 31
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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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

Added in API level 31
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 31
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.

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<ProviderProperties!>