Log In

Returning objects

Each method can return a beacon, a zone or a place.

beacon object

{
	"type": "beacon",
	"id":"xxx",
	"uuid":"xxxxxxxxxxxx-xxxx-xxxx-xxxx",
	"major": xxxxx,
  "minor": xxxxx,
	"name":"beacon_name",
  "proximity":"immediate" | "near" | "far" | "unknown",
  "timestamp": xxxxxxxx
}

zone object

{
	"type":"place",
  "id":"xxxx",
  "name":"xxxxx",
	"timestamp": xxxxxxx,
}

place object

{
	"type": "place",
	"id":"xxx",
 	"name":"place_name",
	"uuid":"xxxxxxxxxxxx-xxxx-xxxx-xxxx",
	geofence: {
  	"lat": xx.xxxxx,
		"long": xx.xxxx,
    "accuracy":xx,
  }
  "timestamp": xxxxxxxx
}

Handle MOCA data ready event

MOCA.addDataReadyListener (function (e) {
     // e.detail.beacons -- array of beacon objects. 
  });

This method invoked when a proximity service loaded or updated a registry of beacons from MOCA cloud or from local cache.

Handle enter beacon range event:

MOCA.addEnterBeaconListener (function (e) {
     // e.detail -> beacon object
  });

Handle exit beacon range event:

MOCA.addExitBeaconListener (function (e) {
     // e.detail -> beacon object
  });

Method triggered when the state of a beacon proximity did changed:

MOCA.addBeaconProximityChangeListener (function (e) {
     // e.detail  proximity change details (previous proximity
    // current proximity, beacon object)
  });

Handle enter place event:

MOCA.addEnterPlaceListener (function (e) {
     // e.detail -> Place object
  });

Handle exit place event:

MOCA.addExitPlaceListener (function (e) {
     // e.detail -> Place object
  });

Handle enter zone event:

MOCA.addEnterZoneListener (function (e) {
     // e.detail -> Zone object
  });

Handle exit zone event:

MOCA.addExitZoneListener (function (e) {
     // e.detail -> Zone object
  });