RangingRequest

Kotlin |Java

class RangingRequest : Parcelable

kotlin.Any
↳	android.net.wifi.rtt.RangingRequest

Defines the ranging request to other devices. The ranging request is built using RangingRequest.Builder. A ranging request is executed using WifiRttManager#startRanging(RangingRequest, java.util.concurrent.Executor, RangingResultCallback).

The ranging request is a batch request - specifying a set of devices (specified using RangingRequest.Builder#addAccessPoint(ScanResult) and RangingRequest.Builder#addAccessPoints(List)).

Summary

Nested classes
	`Builder` Builder class used to construct `RangingRequest` objects.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
static Int	`getDefaultRttBurstSize()` Returns the default RTT burst size used to determine the average range.
static Int	`getMaxPeers()` Returns the maximum number of peers to range which can be specified in a single `RangingRequest`.
static Int	`getMaxRttBurstSize()` Returns the minimum RTT burst size that can be used to determine a average range.
static Int	`getMinRttBurstSize()` Returns the minimum RTT burst size that can be used to determine a average range.
Int	`getRttBurstSize()` Returns the RTT burst size used to determine the average range.
Int	`hashCode()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<RangingRequest!>	`CREATOR`

Public methods

describeContents

Added in API level 28

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 28

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.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDefaultRttBurstSize

Added in API level 31

static fun getDefaultRttBurstSize(): Int

Returns the default RTT burst size used to determine the average range.

Return
`Int`	the RTT burst size used by default

getMaxPeers

Added in API level 28

static fun getMaxPeers(): Int

Returns the maximum number of peers to range which can be specified in a single RangingRequest. The limit applies no matter how the peers are added to the request, e.g. through RangingRequest.Builder#addAccessPoint(ScanResult) or RangingRequest.Builder#addAccessPoints(List).

Return
`Int`	Maximum number of peers.

getMaxRttBurstSize

Added in API level 31

static fun getMaxRttBurstSize(): Int

Returns the minimum RTT burst size that can be used to determine a average range.

Return
`Int`	the maximum RTT burst size that can be used

getMinRttBurstSize

Added in API level 31

static fun getMinRttBurstSize(): Int

Returns the minimum RTT burst size that can be used to determine a average range.

Return
`Int`	the minimum RTT burst size that can be used

getRttBurstSize

Added in API level 31

fun getRttBurstSize(): Int

Returns the RTT burst size used to determine the average range.

Return
`Int`	the RTT burst size used

hashCode

Added in API level 28

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

writeToParcel

Added in API level 28

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	Parcel: 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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 28

static val CREATOR: Parcelable.Creator<RangingRequest!>