AdvertiseSettings.Builder

Builder class for AdvertiseSettings.

Summary

Public Constructors
	AdvertiseSettings.Builder()

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	setTxPowerLevel(int txPowerLevel) Set advertise tx power level to control the transmission power level for the advertising.
AdvertiseSettings.Builder	setType(int type) Set advertise type to control the event type of advertising.

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

setTxPowerLevel(int txPowerLevel)

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

AdvertiseSettings.Builder

setType(int type)

Set advertise type to control the event type of advertising.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public AdvertiseSettings.Builder setAdvertiseMode (int advertiseMode)

Set advertise mode to control the advertising power and latency.

Parameters

advertiseMode	Bluetooth LE Advertising mode, can only be one of `ADVERTISE_MODE_LOW_POWER`, `ADVERTISE_MODE_BALANCED`, or `ADVERTISE_MODE_LOW_LATENCY`.

Throws

IllegalArgumentException	If the advertiseMode is invalid.

public AdvertiseSettings.Builder setTxPowerLevel (int txPowerLevel)

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

Parameters

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

Throws

IllegalArgumentException	If the `txPowerLevel` is invalid.

public AdvertiseSettings.Builder setType (int type)

Set advertise type to control the event type of advertising.

Parameters

type	Bluetooth LE Advertising type, can be either `ADVERTISE_TYPE_NON_CONNECTABLE`, `ADVERTISE_TYPE_SCANNABLE` or `ADVERTISE_TYPE_CONNECTABLE`.

Throws

IllegalArgumentException	If the `type` is invalid.

Results

Classes

Class Overview

Summary

Public Constructors

public AdvertiseSettings.Builder ()

Public Methods

public AdvertiseSettings build ()

public AdvertiseSettings.Builder setAdvertiseMode (int advertiseMode)

Parameters

Throws

public AdvertiseSettings.Builder setTxPowerLevel (int txPowerLevel)

Parameters

Throws

public AdvertiseSettings.Builder setType (int type)

Parameters

Throws

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