程序包 ohos.bluetooth.ble

类 BleScanFilter

java.lang.Object

ohos.bluetooth.ble.BleScanFilter

所有已实现的接口:

Sequenceable

public final class BleScanFilter
extends Object
implements Sequenceable

Filters BLE scanning results.

The criteria for filtering scanning results can be set.

Constructing a filter requires the address, name, service data, service UUID, and manufacturer of a BLE peripheral device.

从以下版本开始:

1

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

Sequenceable.Producer<T>

构造器概要

构造器

构造器	说明
BleScanFilter()

方法概要

限定符和类型	方法	说明
String	getPeripheralAddress()	Obtains the Bluetooth MAC address of the peripheral device to scan.
byte[]	getPeripheralManufacturerData()	Obtains the manufacturer data of the peripheral device to scan.
String	getPeripheralName()	Obtains the name of the peripheral device to scan.
UUID	getPeripheralServcieUuid()	Obtains the service UUID of the peripheral device to scan.
byte[]	getPeripheralServiceData()	Obtains the service data of the peripheral device to scan.
boolean	marshalling(Parcel out)	Marshals this Sequenceable object into a Parcel.
void	setPeripheralAddress(String address)	Sets the address of a BLE peripheral device.
void	setPeripheralManufacturerData(int manufacturerId, byte[] data, byte[] mask)	Sets the manufacturer data.
void	setPeripheralName(String name)	Sets the name of a BLE peripheral device.
void	setPeripheralServiceData(UUID uuid, byte[] data, byte[] mask)	Sets the service data of a BLE peripheral device.
void	setPeripheralServiceUuid(UUID uuid, UUID mask)	Sets the service UUID of a BLE peripheral device.
boolean	unmarshalling(Parcel in)	Unmarshals this Sequenceable object from a Parcel.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable

hasFileDescriptor

构造器详细资料

BleScanFilter

public BleScanFilter()

方法详细资料

setPeripheralAddress

public void setPeripheralAddress(String address)

Sets the address of a BLE peripheral device.

Ensure that the input address is valid.

参数:

address - Indicates the address in string.

从以下版本开始:

1

setPeripheralName

public void setPeripheralName(String name)

Sets the name of a BLE peripheral device.

Ensure that the input name is valid.

参数:

name - Indicates the name in string.

从以下版本开始:

1

setPeripheralServiceData

public void setPeripheralServiceData(UUID uuid,
                                     byte[] data,
                                     byte[] mask)

Sets the service data of a BLE peripheral device.

Empty data or mask is not allowed.

参数:

uuid - Indicates the service data UUID.

data - Indicates the service data content.

mask - Indicates the service data mask.

从以下版本开始:

1

setPeripheralServiceUuid

public void setPeripheralServiceUuid(UUID uuid,
                                     UUID mask)

Sets the service UUID of a BLE peripheral device.

参数:

uuid - Indicates the service UUID.

mask - Indicates the mask used by the service UUID.

从以下版本开始:

1

setPeripheralManufacturerData

public void setPeripheralManufacturerData(int manufacturerId,
                                          byte[] data,
                                          byte[] mask)

Sets the manufacturer data.

Empty data or mask is not allowed.

参数:

manufacturerId - Indicates the device manufacturer ID.

data - Indicates the manufacturer data.

mask - Indicates the manufacturer data mask.

从以下版本开始:

1

getPeripheralAddress

public String getPeripheralAddress()

Obtains the Bluetooth MAC address of the peripheral device to scan.

返回:

Returns the Bluetooth MAC address of the peripheral device.

getPeripheralName

public String getPeripheralName()

Obtains the name of the peripheral device to scan.

返回:

Returns the name of the peripheral device.

getPeripheralServiceData

public byte[] getPeripheralServiceData()

Obtains the service data of the peripheral device to scan.

返回:

Returns the service data of the peripheral device.

getPeripheralServcieUuid

public UUID getPeripheralServcieUuid()

Obtains the service UUID of the peripheral device to scan.

返回:

Returns the service UUID of the peripheral device.

getPeripheralManufacturerData

public byte[] getPeripheralManufacturerData()

Obtains the manufacturer data of the peripheral device to scan.

返回:

Returns the manufacturer data of the peripheral device.

marshalling

public boolean marshalling(Parcel out)

从接口复制的说明: Sequenceable

Marshals this Sequenceable object into a Parcel.

指定者:

marshalling 在接口中 Sequenceable

参数:

out - Indicates the Parcel object to which the Sequenceable object will be marshaled..

返回:

Returns true if the marshalling is successful; returns false otherwise.

unmarshalling

public boolean unmarshalling(Parcel in)

从接口复制的说明: Sequenceable

Unmarshals this Sequenceable object from a Parcel.

指定者:

unmarshalling 在接口中 Sequenceable

参数:

in - Indicates the Parcel object into which the Sequenceable object has been marshaled.

返回:

Returns true if the unmarshalling is successful; returns false otherwise.