程序包 ohos.bluetooth.ble

类 BlePeripheralManager

java.lang.Object

ohos.bluetooth.ble.BlePeripheralManager

public class BlePeripheralManager
extends Object

Provides a Bluetooth GATT server for managing BLE peripheral devices.

Your application can use this class to create BLE services and characteristics.

从以下版本开始:

3

构造器概要

构造器

构造器	说明
BlePeripheralManager(Context context, BlePeripheralManagerCallback callback, int transport)	A constructor used to create a BlePeripheralManager instance.

方法概要

限定符和类型	方法	说明
boolean	addService(GattService service)	Adds a specified service to be hosted.
void	cancelConnection(BlePeripheralDevice device)	Disconnects an established connection or cancels an ongoing connection attempt.
void	clearServices()	Removes all services from the list of GATT services provided by this device.
void	close()	Closes this BlePeripheralManager object and deregisters its callbacks.
List<BlePeripheralDevice>	getDevicesByStates(int[] states)	Obtains the list of BLE peripheral devices in a specified state.
List<GattService>	getServices()	Obtains the list of GATT services provided by this device.
boolean	notifyCharacteristicChanged(BlePeripheralDevice device, GattCharacteristic characteristic, boolean confirm)	Sends a notification or indication of a change in a specified local characteristic.
boolean	removeGattService(GattService service)	Removes a specified service from the list of GATT services provided by this device.
boolean	sendResponse(BlePeripheralDevice device, int requestId, int status, int offset, byte[] value)	Sends a response to a specified read or write request to a given BLE peripheral device.

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

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

构造器详细资料

BlePeripheralManager

public BlePeripheralManager(Context context,
                            BlePeripheralManagerCallback callback,
                            int transport)

A constructor used to create a BlePeripheralManager instance.

参数:

context - Indicates the context.

callback - Indicates the callback of the BlePeripheralManager instance.

transport - Indicates the data transmission type.

从以下版本开始:

3

方法详细资料

getServices

public List<GattService> getServices()

Obtains the list of GATT services provided by this device.

返回:

Returns the list of GATT services provided by this device.

从以下版本开始:

3

addService

public boolean addService(GattService service)

Adds a specified service to be hosted.

The added service and its characteristics are provided by the local device.

参数:

service - Indicates the service to add.

返回:

Returns true if the service is added; returns false otherwise.

从以下版本开始:

3

cancelConnection

public void cancelConnection(BlePeripheralDevice device)

Disconnects an established connection or cancels an ongoing connection attempt.

参数:

device - Indicates the BLE peripheral device.

从以下版本开始:

3

close

public void close()

Closes this BlePeripheralManager object and deregisters its callbacks.

从以下版本开始:

3

clearServices

public void clearServices()

Removes all services from the list of GATT services provided by this device.

从以下版本开始:

3

getDevicesByStates

public List<BlePeripheralDevice> getDevicesByStates(int[] states)

Obtains the list of BLE peripheral devices in a specified state.

参数:

states - Indicates the specified state.

返回:

Returns the list of BLE peripheral devices in the specified state.

从以下版本开始:

3

notifyCharacteristicChanged

public boolean notifyCharacteristicChanged(BlePeripheralDevice device,
                                           GattCharacteristic characteristic,
                                           boolean confirm)

Sends a notification or indication of a change in a specified local characteristic.

This method should be called for every BLE peripheral device that has requested notifications or indications.

参数:

device - Indicates the BLE peripheral device to receive the notification or indication.

characteristic - Indicates the local characteristic that has changed.

confirm - Specifies whether to request confirmation from the BLE peripheral device (indication) or send a notification. Value true indicates the former and false indicates the latter.

返回:

Returns true if the notification or indication is sent successfully; returns false otherwise.

从以下版本开始:

3

removeGattService

public boolean removeGattService(GattService service)

Removes a specified service from the list of GATT services provided by this device.

参数:

service - Indicates the service to remove.

返回:

Returns true if the service is removed; returns false otherwise.

从以下版本开始:

3

sendResponse

public boolean sendResponse(BlePeripheralDevice device,
                            int requestId,
                            int status,
                            int offset,
                            byte[] value)

Sends a response to a specified read or write request to a given BLE peripheral device.

参数:

device - Indicates the BLE peripheral device to which to send the response.

requestId - Indicates the ID of the read or write request.

status - Indicates the status of the read or write request.

offset - Indicates the offset for a partial read or write response.

value - Indicates the attribute value that was read or written.

返回:

Returns true if the response is sent successfully; returns false otherwise.

从以下版本开始:

3