RangingCapabilities
class RangingCapabilities : Parcelable
| kotlin.Any | |
| ↳ | android.ranging.RangingCapabilities |
Represents the capabilities and availability of various ranging technologies.
The RangingCapabilities class encapsulates the status of different ranging technologies. It also allows querying the availability of other ranging technologies through a mapping of technology identifiers to availability statuses.
Summary
| Constants | |
|---|---|
| static Int |
Indicates that the ranging technology is disabled due to regulatory restrictions. |
| static Int |
Indicates that the ranging technology is disabled by the user. |
| static Int |
Indicates that the ranging technology is disabled due to device usage restrictions. |
| static Int |
Indicates that the ranging technology is enabled and available for use. |
| static Int |
Indicates that the ranging technology is not supported on the current device. |
| 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. |
| BleCsRangingCapabilities? |
Gets the BLE channel sounding ranging capabilities. |
| RttRangingCapabilities? |
Gets the WiFi NAN-RTT ranging capabilities. |
| MutableMap<Int!, Int!> |
Gets a map containing the availability of various ranging technologies. |
| UwbRangingCapabilities? |
Gets the UWB ranging capabilities. |
| WifiPdRangingCapabilities? |
Gets the WiFi PD ranging capabilities. |
| Int |
hashCode()Returns a hash code value for the object. |
| 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<RangingCapabilities!> | |
Constants
DISABLED_REGULATORY
static val DISABLED_REGULATORY: Int
Indicates that the ranging technology is disabled due to regulatory restrictions.
Value: 2DISABLED_USER
static val DISABLED_USER: Int
Indicates that the ranging technology is disabled by the user.
Value: 1DISABLED_USER_RESTRICTIONS
static val DISABLED_USER_RESTRICTIONS: Int
Indicates that the ranging technology is disabled due to device usage restrictions.
Value: 4ENABLED
static val ENABLED: Int
Indicates that the ranging technology is enabled and available for use.
Value: 3NOT_SUPPORTED
static val NOT_SUPPORTED: Int
Indicates that the ranging technology is not supported on the current device.
Value: 0Public 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(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. |
getCsCapabilities
fun getCsCapabilities(): BleCsRangingCapabilities?
Gets the BLE channel sounding ranging capabilities.
| Return | |
|---|---|
BleCsRangingCapabilities? |
a BleCsRangingCapabilities object or null if not available. |
getRttRangingCapabilities
fun getRttRangingCapabilities(): RttRangingCapabilities?
Gets the WiFi NAN-RTT ranging capabilities.
| Return | |
|---|---|
RttRangingCapabilities? |
a RttRangingCapabilities object or null if not available. |
getTechnologyAvailability
fun getTechnologyAvailability(): MutableMap<Int!, Int!>
Gets a map containing the availability of various ranging technologies.
The map uses technology identifiers as keys and their respective availability statuses as values.
| Return | |
|---|---|
MutableMap<Int!, Int!> |
a Map with key android.ranging.RangingManager.RangingTechnology and value android.ranging.RangingCapabilities.RangingTechnologyAvailability. This value cannot be null. |
getUwbCapabilities
fun getUwbCapabilities(): UwbRangingCapabilities?
Gets the UWB ranging capabilities.
| Return | |
|---|---|
UwbRangingCapabilities? |
a UwbRangingCapabilities object or null if not available. |
getWifiPdRangingCapabilities
fun getWifiPdRangingCapabilities(): WifiPdRangingCapabilities?
Gets the WiFi PD ranging capabilities.
| Return | |
|---|---|
WifiPdRangingCapabilities? |
a WifiPdRangingCapabilities object or null if not available. |
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(
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:
|