Added in API level 21

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

AdvertiseData

Kotlin |Java

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 `AdvertiseData`.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

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>`	`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 `TransportDiscoveryData` within the advertisement.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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(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 `CONTENTS_FILE_DESCRIPTOR`

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[]>`

getServiceSolicitationUuids

Added in API level 31

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

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>`

getTransportDiscoveryData

Added in API level 33

public List<TransportDiscoveryData> getTransportDiscoveryData ()

Returns a list of TransportDiscoveryData within the advertisement.

Returns
`List<TransportDiscoveryData>`	This value cannot be `null`.

toString

Added in API level 21

public String toString ()

Returns a string representation of the object.

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. 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 `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

AdvertiseData

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getIncludeDeviceName

getIncludeTxPowerLevel

getManufacturerSpecificData

getServiceData

getServiceSolicitationUuids

getServiceUuids

getTransportDiscoveryData

toString

writeToParcel