AdvertiseParams
class AdvertiseParams
A class to provide a way to adjust advertising preferences and advertise data packet.
Summary
Public constructors |
|---|
AdvertiseParams( |
Public properties |
|
|---|---|
Long |
Advertising duration in milliseconds. |
Boolean |
Whether the advertisement will indicate connectable. |
Boolean |
Whether the advertisement will be discoverable. |
Map<Int, ByteArray> |
A map of company identifiers to manufacturer specific data. |
Map<UUID, ByteArray> |
A map of 16-bit UUIDs of the services to corresponding additional service data. |
List<UUID> |
A list of service solicitation UUIDs to advertise that we invite to connect. |
List<UUID> |
A list of service UUIDs to advertise. |
Boolean |
Whether the device address will be included in the advertisement packet. |
Boolean |
Whether the device name will be included in the advertisement packet. |
Public constructors
AdvertiseParams
AdvertiseParams(
shouldIncludeDeviceAddress: Boolean = false,
shouldIncludeDeviceName: Boolean = false,
isConnectable: Boolean = false,
isDiscoverable: Boolean = false,
durationMillis: @IntRange(from = 0, to = 180000) Long = 0,
manufacturerData: Map<Int, ByteArray> = emptyMap(),
serviceData: Map<UUID, ByteArray> = emptyMap(),
serviceUuids: List<UUID> = emptyList(),
serviceSolicitationUuids: List<UUID> = emptyList()
)
Public properties
durationMillis
val durationMillis: Long
Advertising duration in milliseconds.
It must not exceed 180000 milliseconds. A value of 0 means advertising continues until it is stopped explicitly.
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if it is not in the range 0..180000. |
isConnectable
val isConnectable: Boolean
Whether the advertisement will indicate connectable.
isDiscoverable
val isDiscoverable: Boolean
Whether the advertisement will be discoverable.
Please note that it would be ignored under API level 34 and isConnectable would be used instead.
manufacturerData
val manufacturerData: Map<Int, ByteArray>
A map of company identifiers to manufacturer specific data.
Please refer to the Bluetooth Assigned Numbers document provided by the Bluetooth SIG for the list of existing company identifiers.
serviceData
val serviceData: Map<UUID, ByteArray>
A map of 16-bit UUIDs of the services to corresponding additional service data.
serviceSolicitationUuids
val serviceSolicitationUuids: List<UUID>
A list of service solicitation UUIDs to advertise that we invite to connect.
serviceUuids
val serviceUuids: List<UUID>
A list of service UUIDs to advertise.
shouldIncludeDeviceAddress
val shouldIncludeDeviceAddress: Boolean
Whether the device address will be included in the advertisement packet.
shouldIncludeDeviceName
val shouldIncludeDeviceName: Boolean
Whether the device name will be included in the advertisement packet.