Most visited

Recently visited

Added in API level 21

Summary: Ctors | Methods | Inherited Methods | [Expand All]

public static final class AdvertiseSettings.Builder
extends Object

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

Builder class for AdvertiseSettings.

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.

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

AdvertiseSettings.Builder ()

AdvertiseSettings build ()

Build the AdvertiseSettings object.

Returns
`AdvertiseSettings`

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 `ADVERTISE_MODE_LOW_POWER`, `ADVERTISE_MODE_BALANCED`, or `ADVERTISE_MODE_LOW_LATENCY`.

Returns
`AdvertiseSettings.Builder`

Throws
`IllegalArgumentException`	If the advertiseMode is invalid.

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`

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.

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 `ADVERTISE_TX_POWER_ULTRA_LOW`, `ADVERTISE_TX_POWER_LOW`, `ADVERTISE_TX_POWER_MEDIUM` or `ADVERTISE_TX_POWER_HIGH`.

Returns
`AdvertiseSettings.Builder`

Throws
`IllegalArgumentException`	If the `txPowerLevel` is invalid.