ScanFilter
class ScanFilter : Parcelable
| kotlin.Any | |
| ↳ | android.bluetooth.le.ScanFilter |
Criteria for filtering result from Bluetooth LE scans. A ScanFilter allows clients to restrict scan results to only those that are of interest to them.
Current filtering on the following fields are supported:
Summary
| Nested classes | |
|---|---|
|
Builder class for |
|
| 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. |
| ByteArray? |
Returns the advertising data of this filter. |
| ByteArray? |
Returns the advertising data mask of this filter. |
| Int |
Returns the advertising data type of this filter. |
| String? | |
| String? |
Returns the filter set the device name field of Bluetooth advertisement data. |
| ByteArray? | |
| ByteArray? | |
| Int |
Returns the manufacturer id. |
| ByteArray? | |
| ByteArray? | |
| ParcelUuid? | |
| ParcelUuid? |
Returns the filter set on the service Solicitation uuid. |
| ParcelUuid? |
Returns the filter set on the service Solicitation uuid mask. |
| ParcelUuid? |
Returns the filter set on the service uuid. |
| ParcelUuid? | |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
matches(scanResult: ScanResult!)Check if the scan filter matches a |
| 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<ScanFilter!> |
A |
Public 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(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
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 |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAdvertisingData
fun getAdvertisingData(): ByteArray?
Returns the advertising data of this filter.
| Return | |
|---|---|
ByteArray? |
This value may be null. |
getAdvertisingDataMask
fun getAdvertisingDataMask(): ByteArray?
Returns the advertising data mask of this filter.
| Return | |
|---|---|
ByteArray? |
This value may be null. |
getAdvertisingDataType
fun getAdvertisingDataType(): Int
Returns the advertising data type of this filter. Returns ScanRecord.DATA_TYPE_NONE if the type is not set. The values of advertising data type are defined in the Bluetooth Generic Access Profile (https://www.bluetooth.com/specifications/assigned-numbers/)
getDeviceAddress
fun getDeviceAddress(): String?
| Return | |
|---|---|
String? |
This value may be null. |
getDeviceName
fun getDeviceName(): String?
Returns the filter set the device name field of Bluetooth advertisement data.
| Return | |
|---|---|
String? |
This value may be null. |
getManufacturerData
fun getManufacturerData(): ByteArray?
| Return | |
|---|---|
ByteArray? |
This value may be null. |
getManufacturerDataMask
fun getManufacturerDataMask(): ByteArray?
| Return | |
|---|---|
ByteArray? |
This value may be null. |
getManufacturerId
fun getManufacturerId(): Int
Returns the manufacturer id. -1 if the manufacturer filter is not set.
getServiceData
fun getServiceData(): ByteArray?
| Return | |
|---|---|
ByteArray? |
This value may be null. |
getServiceDataMask
fun getServiceDataMask(): ByteArray?
| Return | |
|---|---|
ByteArray? |
This value may be null. |
getServiceDataUuid
fun getServiceDataUuid(): ParcelUuid?
| Return | |
|---|---|
ParcelUuid? |
This value may be null. |
getServiceSolicitationUuid
fun getServiceSolicitationUuid(): ParcelUuid?
Returns the filter set on the service Solicitation uuid.
| Return | |
|---|---|
ParcelUuid? |
This value may be null. |
getServiceSolicitationUuidMask
fun getServiceSolicitationUuidMask(): ParcelUuid?
Returns the filter set on the service Solicitation uuid mask.
| Return | |
|---|---|
ParcelUuid? |
This value may be null. |
getServiceUuid
fun getServiceUuid(): ParcelUuid?
Returns the filter set on the service uuid.
| Return | |
|---|---|
ParcelUuid? |
This value may be null. |
getServiceUuidMask
fun getServiceUuidMask(): ParcelUuid?
| Return | |
|---|---|
ParcelUuid? |
This value may be null. |
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. |
matches
fun matches(scanResult: ScanResult!): Boolean
Check if the scan filter matches a scanResult. A scan result is considered as a match if it matches all the field filters.
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: 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:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<ScanFilter!>
A android.os.Parcelable.Creator to create ScanFilter from parcel.