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.
See also:
Summary
Nested classes | |
|---|---|
class |
AdvertiseData.Builder
Builder for |
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
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
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>
|
getServiceSolicitationUuids()
Returns a list of service solicitation UUIDs within the advertisement that we invite to connect. |
List<ParcelUuid>
|
getServiceUuids()
Returns a list of service UUIDs within the advertisement that are used to identify the Bluetooth GATT services. |
List<TransportDiscoveryData>
|
getTransportDiscoveryData()
Returns a list of |
int
|
hashCode()
Returns a hash code value for the object. |
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
Public methods
describeContents
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(android.os.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.
Value is either 0 or
|
equals
public boolean equals (Object obj)
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 |
Object: This value may be null. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getIncludeDeviceName
public boolean getIncludeDeviceName ()
Whether the device name will be included in the advertisement packet.
| Returns | |
|---|---|
boolean |
|
getIncludeTxPowerLevel
public boolean getIncludeTxPowerLevel ()
Whether the transmission power level will be included in the advertisement packet.
| Returns | |
|---|---|
boolean |
|
getManufacturerSpecificData
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
public Map<ParcelUuid, byte[]> getServiceData ()
Returns a map of 16-bit UUID and its corresponding service data.
| Returns | |
|---|---|
Map<ParcelUuid, byte[]> |
|
getServiceSolicitationUuids
public List<ParcelUuid> getServiceSolicitationUuids ()
Returns a list of service solicitation UUIDs within the advertisement that we invite to connect.
| Returns | |
|---|---|
List<ParcelUuid> |
This value cannot be null. |
getServiceUuids
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> |
|
getTransportDiscoveryData
public List<TransportDiscoveryData> getTransportDiscoveryData ()
Returns a list of TransportDiscoveryData within the advertisement.
| Returns | |
|---|---|
List<TransportDiscoveryData> |
This value cannot be null. |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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.
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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.
This value cannot be null. |
flags |
int: Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-13 UTC.