Android APIs
public static final class

AdvertiseData.Builder

extends Object
java.lang.Object
   ↳ android.bluetooth.le.AdvertiseData.Builder

Class Overview

Builder for AdvertiseData.

Summary

Public Constructors
AdvertiseData.Builder()
Public Methods
AdvertiseData.Builder addManufacturerData(int manufacturerId, byte[] manufacturerSpecificData)
Add manufacturer specific data.
AdvertiseData.Builder addServiceData(ParcelUuid serviceDataUuid, byte[] serviceData)
Add service data to advertise data.
AdvertiseData.Builder addServiceUuid(ParcelUuid serviceUuid)
Add a service UUID to advertise data.
AdvertiseData build()
Build the AdvertiseData.
AdvertiseData.Builder setIncludeDeviceName(boolean includeDeviceName)
Set whether the device name should be included in advertise packet.
AdvertiseData.Builder setIncludeTxPowerLevel(boolean includeTxPowerLevel)
Whether the transmission power level should be included in the advertise packet.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AdvertiseData.Builder ()

Added in API level 21

Public Methods

public AdvertiseData.Builder addManufacturerData (int manufacturerId, byte[] manufacturerSpecificData)

Added in API level 21

Add manufacturer specific data.

Please refer to the Bluetooth Assigned Numbers document provided by the Bluetooth SIG for a list of existing company identifiers.

Parameters
manufacturerId Manufacturer ID assigned by Bluetooth SIG.
manufacturerSpecificData Manufacturer specific data
Throws
IllegalArgumentException If the manufacturerId is negative or manufacturerSpecificData is null.

public AdvertiseData.Builder addServiceData (ParcelUuid serviceDataUuid, byte[] serviceData)

Added in API level 21

Add service data to advertise data.

Parameters
serviceDataUuid 16-bit UUID of the service the data is associated with
serviceData Service data
Throws
IllegalArgumentException If the serviceDataUuid or serviceData is empty.

public AdvertiseData.Builder addServiceUuid (ParcelUuid serviceUuid)

Added in API level 21

Add a service UUID to advertise data.

Parameters
serviceUuid A service UUID to be advertised.
Throws
IllegalArgumentException If the serviceUuids are null.

public AdvertiseData build ()

Added in API level 21

Build the AdvertiseData.

public AdvertiseData.Builder setIncludeDeviceName (boolean includeDeviceName)

Added in API level 21

Set whether the device name should be included in advertise packet.

public AdvertiseData.Builder setIncludeTxPowerLevel (boolean includeTxPowerLevel)

Added in API level 21

Whether the transmission power level should be included in the advertise packet. Tx power level field takes 3 bytes in advertise packet.