com.estimote.coresdk.cloud.api

Class EstimoteCloud

java.lang.Object

com.estimote.coresdk.cloud.api.EstimoteCloud

public class EstimoteCloud
extends java.lang.Object

Responsible for interaction with Estimote Cloud.

You need first to provide App id and token. You can find your App ID and App Token in the Apps section of the Estimote Cloud.

This object is a singleton. You can obtain instance to it by calling getInstance().

Usage:

   EstimoteSDK.initialize(applicationContext, appId, appToken);
   EstimoteCloud.getInstance().fetchBeaconDetails(beaconMacAddress, callback);
 

Author:

wiktor@estimote.com (Wiktor Gworek)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EstimoteCloud(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	fetchBeaconDetails(DeviceId deviceId, CloudCallback<BeaconInfo> callback) Fetches details of a beacon identified by its ID from Estimote Cloud.
void	fetchBeaconDetails(MacAddress macAddress, CloudCallback<BeaconInfo> callback) Fetches details of a beacon identified by its MAC address from Estimote Cloud.
void	fetchBeaconDetails(java.util.UUID uuid, int major, int minor, CloudCallback<BeaconInfo> callback) Fetches details of a beacon identified by its proximity UUID, major and minor numbers.
void	fetchDeviceDetails(DeviceId identifier, CloudCallback<Device> callback) Fetches device details (like color or type, status, advertised packers) of a device from Estimote Cloud.
void	fetchNearableDetails(java.lang.String identifier, CloudCallback<NearableInfo> callback) Fetches public details (like color or type) of a nearable from Estimote Cloud.
static EstimoteCloud	getInstance() Obtains instance of Estimote Cloud.
void	updateDeviceSettings(DeviceId identifier, Device.Settings settings, CloudCallback<Device> callback) Updates device settings (advertised packets, transmitPower modes, sensor settings).

Methods inherited from class java.lang.Object

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

Constructor Detail

EstimoteCloud

protected EstimoteCloud(android.content.Context context)

Method Detail

getInstance

public static EstimoteCloud getInstance()

Obtains instance of Estimote Cloud.

Returns:

Instance of EstimoteCloud.

fetchBeaconDetails

public void fetchBeaconDetails(MacAddress macAddress,
                               CloudCallback<BeaconInfo> callback)

Fetches details of a beacon identified by its MAC address from Estimote Cloud.

Parameters:

macAddress - Beacon's MAC address.

callback - Callback to be invoked after details are fetched.

fetchBeaconDetails

public void fetchBeaconDetails(DeviceId deviceId,
                               CloudCallback<BeaconInfo> callback)

Fetches details of a beacon identified by its ID from Estimote Cloud.

Parameters:

deviceId - Device identifier.

callback - Callback to be invoked after details are fetched.

fetchBeaconDetails

public void fetchBeaconDetails(java.util.UUID uuid,
                               int major,
                               int minor,
                               CloudCallback<BeaconInfo> callback)

Fetches details of a beacon identified by its proximity UUID, major and minor numbers.

Parameters:

uuid - Beacon's UUID.

major - Beacon's major number.

minor - Beacon's minor number.

callback - Callback to be invoked after details are fetched.

fetchNearableDetails

public void fetchNearableDetails(java.lang.String identifier,
                                 CloudCallback<NearableInfo> callback)

Fetches public details (like color or type) of a nearable from Estimote Cloud.

Parameters:

identifier - Nearable's identifier (Nearable.identifier).

callback - Callback to be invoked after details are fetched.

fetchDeviceDetails

public void fetchDeviceDetails(DeviceId identifier,
                               CloudCallback<Device> callback)

Fetches device details (like color or type, status, advertised packers) of a device from Estimote Cloud.

Parameters:

identifier - Device identifier

callback - Callback to be invoked after details are fetched.

updateDeviceSettings

public void updateDeviceSettings(DeviceId identifier,
                                 Device.Settings settings,
                                 CloudCallback<Device> callback)

Updates device settings (advertised packets, transmitPower modes, sensor settings).

Parameters:

identifier - Device identifier.

settings - Device settings.

callback - Callback to be invoked after updated details are fetched.