AdvertiseData

public final class AdvertiseData
extends Object implements Parcelable

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


Advertise data packet container for Bluetooth LE advertising. This represents the data to be advertised as well as the scan response data for active scans.

Use AdvertiseData.Builder to create an instance of AdvertiseData to be advertised.

Summary

Nested classes

class AdvertiseData.Builder

Builder for AdvertiseData

Inherited constants

Fields

public static final Creator<AdvertiseData> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean getIncludeDeviceName()

Whether the device name will be included in the advertisement packet.

boolean getIncludeTxPowerLevel()

Whether the transmission power level will be included in the advertisement packet.

SparseArray<byte[]> getManufacturerSpecificData()

Returns an array of manufacturer Id and the corresponding manufacturer specific data.

Map<ParcelUuid, byte[]> getServiceData()

Returns a map of 16-bit UUID and its corresponding service data.

List<ParcelUuid> getServiceUuids()

Returns a list of service UUIDs within the advertisement that are used to identify the Bluetooth GATT services.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 21
public static final Creator<AdvertiseData> CREATOR

Public methods

describeContents

added in API level 21
public int describeContents ()

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.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getIncludeDeviceName

added in API level 21
public boolean getIncludeDeviceName ()

Whether the device name will be included in the advertisement packet.

Returns
boolean

getIncludeTxPowerLevel

added in API level 21
public boolean getIncludeTxPowerLevel ()

Whether the transmission power level will be included in the advertisement packet.

Returns
boolean

getManufacturerSpecificData

added in API level 21
public SparseArray<byte[]> getManufacturerSpecificData ()

Returns an array of manufacturer Id and the corresponding manufacturer specific data. The manufacturer id is a non-negative number assigned by Bluetooth SIG.

Returns
SparseArray<byte[]>

getServiceData

added in API level 21
public Map<ParcelUuid, byte[]> getServiceData ()

Returns a map of 16-bit UUID and its corresponding service data.

Returns
Map<ParcelUuid, byte[]>

getServiceUuids

added in API level 21
public List<ParcelUuid> getServiceUuids ()

Returns a list of service UUIDs within the advertisement that are used to identify the Bluetooth GATT services.

Returns
List<ParcelUuid>

toString

added in API level 21
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 21
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.