AdvertiseSettings.Builder

public static final class AdvertiseSettings.Builder
extends Object

java.lang.Object
   ↳ android.bluetooth.le.AdvertiseSettings.Builder


Builder class for AdvertiseSettings.

Summary

Public constructors

AdvertiseSettings.Builder()

Public methods

AdvertiseSettings build()

Build the AdvertiseSettings object.

AdvertiseSettings.Builder setAdvertiseMode(int advertiseMode)

Set advertise mode to control the advertising power and latency.

AdvertiseSettings.Builder setConnectable(boolean connectable)

Set whether the advertisement type should be connectable or non-connectable.

AdvertiseSettings.Builder setTimeout(int timeoutMillis)

Limit advertising to a given amount of time.

AdvertiseSettings.Builder setTxPowerLevel(int txPowerLevel)

Set advertise TX power level to control the transmission power level for the advertising.

Inherited methods

Public constructors

AdvertiseSettings.Builder

added in API level 21
public AdvertiseSettings.Builder ()

Public methods

build

added in API level 21
public AdvertiseSettings build ()

Build the AdvertiseSettings object.

Returns
AdvertiseSettings

setAdvertiseMode

added in API level 21
public AdvertiseSettings.Builder setAdvertiseMode (int advertiseMode)

Set advertise mode to control the advertising power and latency.

Parameters
advertiseMode int: Bluetooth LE Advertising mode, can only be one of AdvertiseSettings.ADVERTISE_MODE_LOW_POWER, AdvertiseSettings.ADVERTISE_MODE_BALANCED, or AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY.

Returns
AdvertiseSettings.Builder

Throws
IllegalArgumentException If the advertiseMode is invalid.

setConnectable

added in API level 21
public AdvertiseSettings.Builder setConnectable (boolean connectable)

Set whether the advertisement type should be connectable or non-connectable.

Parameters
connectable boolean: Controls whether the advertisment type will be connectable (true) or non-connectable (false).

Returns
AdvertiseSettings.Builder

setTimeout

added in API level 21
public AdvertiseSettings.Builder setTimeout (int timeoutMillis)

Limit advertising to a given amount of time.

Parameters
timeoutMillis int: Advertising time limit. May not exceed 180000 milliseconds. A value of 0 will disable the time limit.

Returns
AdvertiseSettings.Builder

Throws
IllegalArgumentException If the provided timeout is over 180000 ms.

setTxPowerLevel

added in API level 21
public AdvertiseSettings.Builder setTxPowerLevel (int txPowerLevel)

Set advertise TX power level to control the transmission power level for the advertising.

Parameters
txPowerLevel int: Transmission power of Bluetooth LE Advertising, can only be one of AdvertiseSettings.ADVERTISE_TX_POWER_ULTRA_LOW, AdvertiseSettings.ADVERTISE_TX_POWER_LOW, AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM or AdvertiseSettings.ADVERTISE_TX_POWER_HIGH.

Returns
AdvertiseSettings.Builder

Throws
IllegalArgumentException If the txPowerLevel is invalid.