com.radiusnetworks.transmission

Class Advertisement.Builder

java.lang.Object

com.radiusnetworks.transmission.Advertisement.Builder

Enclosing class:

Advertisement

public static final class Advertisement.Builder
extends Object

Builder class for Advertisement.

Since:

0.12.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Advertisement	build() Build the Advertisement object.
Advertisement.Builder	setAdvertiseMode(int advertiseMode) Set advertise mode to control the advertising power and latency.
Advertisement.Builder	setIdentifiers(List ids) Set ID strings for advertisement.
Advertisement.Builder	setLayout(Advertisement.BeaconLayout layout) Set beacon layout.
Advertisement.Builder	setTxPower(int txPower) Set the calibrated measured Tx power of the Beacon in RSSI This value is baked into an Beacon when it is manufactured, and it is transmitted with each packet to aid in the mDistance estimate
Advertisement.Builder	setTxPowerLevel(int txPowerLevel) Set advertise TX power level to control the transmission power level for the advertising.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setLayout

public Advertisement.Builder setLayout(Advertisement.BeaconLayout layout)

Set beacon layout.

Parameters:

layout - beacon layout BeaconLayout

Throws:

NullPointerException - If the layout are null.

setIdentifiers

public Advertisement.Builder setIdentifiers(List ids)

Set ID strings for advertisement.

Parameters:

ids - list of beacon's ids

Throws:

NullPointerException - If the ids are null.

setAdvertiseMode

public Advertisement.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 AdvertiseSettings.ADVERTISE_MODE_LOW_POWER, AdvertiseSettings.ADVERTISE_MODE_BALANCED, or AdvertiseSettings.ADVERTISE_MODE_LOW_LATENCY.

Throws:

IllegalArgumentException - If the advertiseMode is invalid.

setTxPower

public Advertisement.Builder setTxPower(int txPower)

Set the calibrated measured Tx power of the Beacon in RSSI This value is baked into an Beacon when it is manufactured, and it is transmitted with each packet to aid in the mDistance estimate

Parameters:

txPower - calibrated measured Tx power of the Beacon in RSSI. The valid range is from -128 to 0

Throws:

IllegalArgumentException - If the txPower is invalid.

setTxPowerLevel

public Advertisement.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 AdvertiseSettings.ADVERTISE_TX_POWER_ULTRA_LOW, AdvertiseSettings.ADVERTISE_TX_POWER_LOW, AdvertiseSettings.ADVERTISE_TX_POWER_MEDIUM or AdvertiseSettings.ADVERTISE_TX_POWER_HIGH.

Throws:

IllegalArgumentException - If the txPowerLevel is invalid.

build

public Advertisement build()

Build the Advertisement object.