Added in API level 37

WifiPdRangingCapabilities

---

Kotlin |Java

class WifiPdRangingCapabilities : Parcelable

kotlin.Any
↳	android.ranging.wifi.pd.WifiPdRangingCapabilities

The ranging capabilities for Wi-Fi Proximity Detection (PD).

This class defines the ranging capabilities for Wi-Fi PD, which allows devices to measure the distance to each other using Wi-Fi signals. These capabilities include supported PASN modes, channel widths, preamble types, and discovery channels.

Summary

Constants
static Int	AUTHENTICATED_PASN_MODE Authenticated PASN mode.
static Int	UNAUTHENTICATED_PASN_MODE Unauthenticated PASN mode.

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() 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.
Duration	get80211azNtbMinRangingInterval() Gets the minimum ranging interval for 802.
Duration	get80211mcMinRangingInterval() Gets the minimum ranging interval for 802.
Int	getMaxChannelWidth() Gets the maximum supported channel width.
Int	getMaxPreamble() Gets the maximum supported preamble type.
MacAddress	getProximityDetectionMacAddress() Gets the proximity detection MAC address.
MutableSet<Int!>	getSupportedDiscoveryChannelFrequenciesMhz() Gets a set of supported discovery channel frequencies in Mhz.
MutableSet<Int!>	getSupportedPasnModes() Gets a set of supported PASN modes.
Int	getTechnology()
Int	hashCode() Returns a hash code value for the object.
Boolean	is80211azNtbSupported() Returns whether 802.
Boolean	is80211mcSupported() Returns whether 802.
String	toString() Returns a string representation of the object.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WifiPdRangingCapabilities!>	CREATOR A creator for creating WifiPdRangingCapabilities from a Parcel.

Constants

AUTHENTICATED_PASN_MODE

Added in API level 37

static val AUTHENTICATED_PASN_MODE: Int

Authenticated PASN mode. In this mode, ranging is performed over a secure link established using a password.

Value: 1

UNAUTHENTICATED_PASN_MODE

Added in API level 37

static val UNAUTHENTICATED_PASN_MODE: Int

Unauthenticated PASN mode. In this mode, ranging is performed without establishing a secure link.

Value: 0

Public methods

describeContents

Added in API level 37

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(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 CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 37

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.

get80211azNtbMinRangingInterval

Added in API level 37

fun get80211azNtbMinRangingInterval(): Duration

Gets the minimum ranging interval for 802.11az NTB based ranging.

Return
Duration	Duration The ranging interval for 802.11az NTB. This value cannot be null.

get80211mcMinRangingInterval

Added in API level 37

fun get80211mcMinRangingInterval(): Duration

Gets the minimum ranging interval for 802.11mc based ranging.

Return
Duration	Duration The minimum ranging interval for 802.11mc. This value cannot be null.

getMaxChannelWidth

Added in API level 37

fun getMaxChannelWidth(): Int

Gets the maximum supported channel width.

Return
Int	The maximum supported android.net.wifi.WifiAnnotations.ChannelWidth. Value is one of the following: android.net.wifi.ScanResult#CHANNEL_WIDTH_20MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_40MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_160MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_80MHZ_PLUS_MHZ android.net.wifi.ScanResult#CHANNEL_WIDTH_320MHZ

getMaxPreamble

Added in API level 37

fun getMaxPreamble(): Int

Gets the maximum supported preamble type.

Return
Int	The maximum supported android.net.wifi.WifiAnnotations.PreambleType. Value is one of the following: android.net.wifi.ScanResult#PREAMBLE_LEGACY android.net.wifi.ScanResult#PREAMBLE_HT android.net.wifi.ScanResult#PREAMBLE_VHT android.net.wifi.ScanResult#PREAMBLE_HE android.net.wifi.ScanResult#PREAMBLE_EHT

getProximityDetectionMacAddress

Added in API level 37

fun getProximityDetectionMacAddress(): MacAddress

Gets the proximity detection MAC address.

Return
MacAddress	a byte array representing the MAC address. This value cannot be null.

getSupportedDiscoveryChannelFrequenciesMhz

Added in API level 37

fun getSupportedDiscoveryChannelFrequenciesMhz(): MutableSet<Int!>

Gets a set of supported discovery channel frequencies in Mhz.

Return
MutableSet<Int!>	a set of supported discovery channel frequencies in Mhz. Value is between 2400 and 7125 inclusive. This value cannot be null.

getSupportedPasnModes

Added in API level 37

fun getSupportedPasnModes(): MutableSet<Int!>

Gets a set of supported PASN modes.

Return
MutableSet<Int!>	an unmodifiable set of supported android.ranging.wifi.pd.WifiPdRangingCapabilities.PasnMode. Value is one of the following: UNAUTHENTICATED_PASN_MODE AUTHENTICATED_PASN_MODE . This value cannot be null.

getTechnology

Added in API level 37

fun getTechnology(): Int

hashCode

Added in API level 37

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.

is80211azNtbSupported

Added in API level 37

fun is80211azNtbSupported(): Boolean

Returns whether 802.11az NTB (Next Generation Trigger-Based) is supported.

Return
Boolean	true if 802.11az NTB is supported, false otherwise.

is80211mcSupported

Added in API level 37

fun is80211mcSupported(): Boolean

Returns whether 802.11mc (Wi-Fi Round Trip Time) is supported.

Return
Boolean	true if 802.11mc is supported, false otherwise.

toString

Added in API level 37

fun toString(): String

Returns a string representation of the object.

Return
String	a string representation of the object.

writeToParcel

Added in API level 37

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

Flatten this object in to a Parcel.

Parameters
dest	Parcel: 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: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 37

static val CREATOR: Parcelable.Creator<WifiPdRangingCapabilities!>

A creator for creating WifiPdRangingCapabilities from a Parcel.