Added in API level 37

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

WifiPdRangingCapabilities

Kotlin |Java

public final class WifiPdRangingCapabilities
extends Object implements Parcelable

java.lang.Object
↳	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.

See also:

ERROR(RangingManager.getRangingCapabilities()/android.ranging.RangingManager#getRangingCapabilities() RangingManager.getRangingCapabilities())

Summary

Constants
`int`	`AUTHENTICATED_PASN_MODE` Authenticated PASN mode.
`int`	`UNAUTHENTICATED_PASN_MODE` Unauthenticated PASN mode.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<WifiPdRangingCapabilities>`	`CREATOR` A creator for creating `WifiPdRangingCapabilities` from a `Parcel`.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`Duration`	`get80211azNtbMinRangingInterval()` Gets the minimum ranging interval for 802.11az NTB based ranging.
`Duration`	`get80211mcMinRangingInterval()` Gets the minimum ranging interval for 802.11mc based ranging.
`int`	`getMaxChannelWidth()` Gets the maximum supported channel width.
`int`	`getMaxPreamble()` Gets the maximum supported preamble type.
`MacAddress`	`getProximityDetectionMacAddress()` Gets the proximity detection MAC address.
`Set<Integer>`	`getSupportedDiscoveryChannelFrequenciesMhz()` Gets a set of supported discovery channel frequencies in Mhz.
`Set<Integer>`	`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.11az NTB (Next Generation Trigger-Based) is supported.
`boolean`	`is80211mcSupported()` Returns whether 802.11mc (Wi-Fi Round Trip Time) is supported.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

AUTHENTICATED_PASN_MODE

Added in API level 37

public static final int AUTHENTICATED_PASN_MODE

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

Constant Value: 1 (0x00000001)

UNAUTHENTICATED_PASN_MODE

Added in API level 37

public static final int UNAUTHENTICATED_PASN_MODE

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

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 37

public static final Creator<WifiPdRangingCapabilities> CREATOR

A creator for creating WifiPdRangingCapabilities from a Parcel.

Public methods

describeContents

Added in API level 37

public int describeContents ()

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.

Returns
`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

public boolean equals (Object o)

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
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

get80211azNtbMinRangingInterval

Added in API level 37

public Duration get80211azNtbMinRangingInterval ()

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

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

get80211mcMinRangingInterval

Added in API level 37

public Duration get80211mcMinRangingInterval ()

Gets the minimum ranging interval for 802.11mc based ranging.

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

getMaxChannelWidth

Added in API level 37

public int getMaxChannelWidth ()

Gets the maximum supported channel width.

Returns
`int`	The maximum supported `ERROR(WifiAnnotations.ChannelWidth/android.net.wifi.WifiAnnotations.ChannelWidth WifiAnnotations.ChannelWidth)`. Value is one of the following: `ScanResult.CHANNEL_WIDTH_20MHZ` `ScanResult.CHANNEL_WIDTH_40MHZ` `ScanResult.CHANNEL_WIDTH_80MHZ` `ScanResult.CHANNEL_WIDTH_160MHZ` `ScanResult.CHANNEL_WIDTH_80MHZ_PLUS_MHZ` `ScanResult.CHANNEL_WIDTH_320MHZ`

getMaxPreamble

Added in API level 37

public int getMaxPreamble ()

Gets the maximum supported preamble type.

Returns
`int`	The maximum supported `ERROR(WifiAnnotations.PreambleType/android.net.wifi.WifiAnnotations.PreambleType WifiAnnotations.PreambleType)`. Value is one of the following: `ScanResult.PREAMBLE_LEGACY` `ScanResult.PREAMBLE_HT` `ScanResult.PREAMBLE_VHT` `ScanResult.PREAMBLE_HE` `ScanResult.PREAMBLE_EHT`

getProximityDetectionMacAddress

Added in API level 37

public MacAddress getProximityDetectionMacAddress ()

Gets the proximity detection MAC address.

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

getSupportedDiscoveryChannelFrequenciesMhz

Added in API level 37

public Set<Integer> getSupportedDiscoveryChannelFrequenciesMhz ()

Gets a set of supported discovery channel frequencies in Mhz.

Returns
`Set<Integer>`	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

public Set<Integer> getSupportedPasnModes ()

Gets a set of supported PASN modes.

Returns
`Set<Integer>`	an unmodifiable set of supported `ERROR(PasnMode/android.ranging.wifi.pd.WifiPdRangingCapabilities.PasnMode PasnMode)`. Value is one of the following: `UNAUTHENTICATED_PASN_MODE` `AUTHENTICATED_PASN_MODE` . This value cannot be `null`.

getTechnology

Added in API level 37

public int getTechnology ()

Returns
`int`

hashCode

Added in API level 37

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
`int`	a hash code value for this object.

is80211azNtbSupported

Added in API level 37

public boolean is80211azNtbSupported ()

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

Returns
`boolean`	`true` if 802.11az NTB is supported, `false` otherwise.

is80211mcSupported

Added in API level 37

public boolean is80211mcSupported ()

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

Returns
`boolean`	`true` if 802.11mc is supported, `false` otherwise.

toString

Added in API level 37

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 37

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`