Package com.arubanetworks.meridian.triggers

Class TriggersService.TriggerSubscription

java.lang.Object

com.arubanetworks.meridian.triggers.TriggersService.TriggerSubscription

All Implemented Interfaces:

Serializable

Enclosing class:

TriggersService

public static class TriggersService.TriggerSubscription
extends Object
implements Serializable

Subscription that can be used in conjunction with Triggers to be informed when a device is in range of Meridian proximity beacons

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
boolean	allBeacons
ArrayList<ProximityBeacon>	beacons
int	coolDown
String	name
int	RSSIThreshold

Constructor Summary

Constructors

Constructor	Description
TriggerSubscription(String name)	Listen for all proximity beacons of the location
TriggerSubscription(String name, int coolDown)	Listen for all proximity beacons of the location specifying the cool down
TriggerSubscription(String name, int coolDown, int RSSIThreshold)	Listen for all proximity beacons of the location specifying the RSSI threshold and cool down
TriggerSubscription(String name, ArrayList<ProximityBeacon> beacons)	Specifies a collection of proximity beacons to listen for
TriggerSubscription(String name, ArrayList<ProximityBeacon> beacons, int coolDown)	Specifies a collection of proximity beacons to listen for with a cooldown
TriggerSubscription(String name, ArrayList<ProximityBeacon> beacons, int coolDown, int RSSIThreshold)	Specifies a collection of proximity beacons to listen for specifying the RSSI threshold and cool down

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static TriggersService.TriggerSubscription	fromJsonObject(JSONObject json)

Methods inherited from class java.lang.Object

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

Field Details

name

public String name

allBeacons

public boolean allBeacons

beacons

public ArrayList<ProximityBeacon> beacons

coolDown

public int coolDown

RSSIThreshold

public int RSSIThreshold

Constructor Details

TriggerSubscription

public TriggerSubscription(String name,
 ArrayList<ProximityBeacon> beacons,
 int coolDown,
 int RSSIThreshold)

Specifies a collection of proximity beacons to listen for specifying the RSSI threshold and cool down

Parameters:

name - <ul> <li>the name of this subscription, must be unique</li> </ul>

beacons - <ul> <li>the list of beacons to listen for</li> </ul>

coolDown - <ul> <li>how long to wait between triggers in seconds (-1 for the default value of 10 seconds)</li> </ul>

RSSIThreshold - <ul> <li>the minimum RSSI value needed to trigger a beacon (range -99 -&gt; 0).</li> </ul>

TriggerSubscription

public TriggerSubscription(String name,
 ArrayList<ProximityBeacon> beacons,
 int coolDown)

Specifies a collection of proximity beacons to listen for with a cooldown

Parameters:

name - <ul> <li>the name of this subscription, must be unique</li> </ul>

beacons - <ul> <li>the list of beacons to listen for</li> </ul>

coolDown - <ul> <li>how long to wait between triggers in seconds</li> </ul>

TriggerSubscription

public TriggerSubscription(String name,
 ArrayList<ProximityBeacon> beacons)

Specifies a collection of proximity beacons to listen for

Parameters:

name - <ul> <li>the name of this subscription, must be unique</li> </ul>

beacons - <ul> <li>the list of beacons to listen for</li> </ul>

TriggerSubscription

public TriggerSubscription(String name,
 int coolDown,
 int RSSIThreshold)

Listen for all proximity beacons of the location specifying the RSSI threshold and cool down

Parameters:

name - <ul> <li>the name of this subscription, must be unique</li> </ul>

coolDown - <ul> <li>how long to wait between triggers in seconds (-1 for the default value of 10 seconds)</li> </ul>

RSSIThreshold - <ul> <li>the minimum RSSI value needed to trigger a beacon (range -99 -&gt; 0).</li> </ul>

TriggerSubscription

public TriggerSubscription(String name,
 int coolDown)

Listen for all proximity beacons of the location specifying the cool down

Parameters:

name - <ul> <li>the name of this subscription, must be unique</li> </ul>

coolDown - <ul> <li>how long to wait between triggers in seconds</li> </ul>

TriggerSubscription

public TriggerSubscription(String name)

Listen for all proximity beacons of the location

Parameters:

name - <ul> <li>the name of this subscription, must be unique</li> </ul>

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

fromJsonObject

public static TriggersService.TriggerSubscription fromJsonObject(JSONObject json)
                                                          throws JSONException

Throws:

JSONException