com.estimote.mgmtsdk.feature.bulk_updater

Class BulkUpdaterBuilder

java.lang.Object

com.estimote.mgmtsdk.feature.bulk_updater.BulkUpdaterBuilder

public class BulkUpdaterBuilder
extends java.lang.Object

Builder class for BulkUpdater concrete implementations. You can configure here how your bulk updater should behave. Please remember that if you want to change those settings in a future, you will need to build a new object. "Don't let your device's pending_settings be pending settings. Yesterday you said tomorrow, So just do it. Yes you can! " - Shia LeBeacon

Author:

Pawel Dylag (pawel.dylag@estimote.com)

Constructor Summary

Constructors

Constructor and Description
BulkUpdaterBuilder(android.content.Context context) Public constructor for BulkUpdater concrete object.

Method Summary

Modifier and Type	Method and Description
BulkUpdater	build() If you are done configuring the bulk updater, use this method to construct concrete object.
BulkUpdaterBuilder	withCloudFetchInterval(long interval, java.util.concurrent.TimeUnit unit) Sets how often should bulk updater sync data from cloud.
BulkUpdaterBuilder	withFirmwareUpdate() Allows bulk updater to update firmware of devices.
BulkUpdaterBuilder	withRetryCount(int retryCount) Specifies how many retries should BU take to update each device.
BulkUpdaterBuilder	withTimeout(long timeoutMillis) Sets time after bulk uopdater should end it's job.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkUpdaterBuilder

public BulkUpdaterBuilder(android.content.Context context)

Public constructor for BulkUpdater concrete object. You should configure it's behaviour here and utilize built object.

Parameters:

context - app context needed for establishing connection to scanned devices.

Method Detail

withFirmwareUpdate

public BulkUpdaterBuilder withFirmwareUpdate()

Allows bulk updater to update firmware of devices. This feature is disabled by default.

Returns:

withRetryCount

public BulkUpdaterBuilder withRetryCount(int retryCount)

Specifies how many retries should BU take to update each device. After N unsuccessful attempts, the device status will be reported as Status.FAILED. Default value is 1.

Parameters:

retryCount - number of retries

Returns:

withTimeout

public BulkUpdaterBuilder withTimeout(long timeoutMillis)

Sets time after bulk uopdater should end it's job. It will simply destroy updating and fetching data. If the value is 0, the process will run constantly (forever and ever, for how long your battery can last)

Parameters:

timeoutMillis - timeout in milliseconds

Returns:

withCloudFetchInterval

public BulkUpdaterBuilder withCloudFetchInterval(long interval,
                                                 java.util.concurrent.TimeUnit unit)

Sets how often should bulk updater sync data from cloud. The shorter this interval is, the quicker devices will be updated as soon as they got new pending settings in cloud. Default value is 5 seconds (5000 millis).

build

public BulkUpdater build()

If you are done configuring the bulk updater, use this method to construct concrete object.

Returns: