PeriodicAdvertisingParameters.Builder

Kotlin |Java

public static final class PeriodicAdvertisingParameters.Builder
extends Object

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

Summary

Public constructors
`Builder()`

Public methods
`PeriodicAdvertisingParameters`	`build()` Build the `AdvertisingSetParameters` object.
`PeriodicAdvertisingParameters.Builder`	`setIncludeTxPower(boolean includeTxPower)` Whether the transmission power level should be included in the periodic packet.
`PeriodicAdvertisingParameters.Builder`	`setInterval(int interval)` Set advertising interval for periodic advertising, in 1.25ms unit.

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.

Public constructors

Builder

Added in API level 26

public Builder ()

Public methods

build

Added in API level 26

public PeriodicAdvertisingParameters build ()

Build the AdvertisingSetParameters object.

Returns
`PeriodicAdvertisingParameters`

setIncludeTxPower

Added in API level 26

public PeriodicAdvertisingParameters.Builder setIncludeTxPower (boolean includeTxPower)

Whether the transmission power level should be included in the periodic packet.

Parameters
`includeTxPower`	`boolean`

Returns
`PeriodicAdvertisingParameters.Builder`

setInterval

Added in API level 26

public PeriodicAdvertisingParameters.Builder setInterval (int interval)

Set advertising interval for periodic advertising, in 1.25ms unit. Valid values are from 80 (100ms) to 65519 (81.89875s). Value from range [interval, interval+20ms] will be picked as the actual value.

Parameters
`interval`	`int`

Returns
`PeriodicAdvertisingParameters.Builder`

Throws
`IllegalArgumentException`	If the interval is invalid.