Modules.Cloud.GeoFences
> Modules.Cloud.GeoFences

Provides methods for accessing ArrowDB geo-fence objects.

This feature is only available for enterprise users, and the current user must be an application admin to create, update or remove geo-fence objects.

The ArrowDB GeoFences API lets you manage geographic regions with an associated JSON data payload. Use this API to have the device query the ArrowDB server to retrieve data based on a location.

Examples

Create a geo-fence object

This example creates a new geo-fence object covering a 10 mile radius around San Francisco, CA, USA, and checks the response.

  Cloud.GeoFences.create({
      geo_fence: {
          "loc":{"coordinates":[-122.4167,37.7833], "radius":"10/3959"},
          "payload":{"alert":"24-hour sale at our SF flagship store on 12/26!"},
          "start_time": "2014-12-25T00:00",
          "end_time":"2014-12-26T19:00"
      }
  }, function (e) {
      if (e.success) {
          Ti.API.info(JSON.stringify(e.geo_fences));
      } else {
          alert('Error:\n' +
              ((e.error && e.message) || JSON.stringify(e)));
      }
  });

Query for geo-fence objects

This example searches for geo-fence objects within 2 km of Oakland, CA, USA, and checks the response.

  Cloud.GeoFences.query({
      where:{
          "loc": { 
              "$nearSphere" : { 
                  "$geometry" : { "type" : "Point", "coordinates" : [-122.2708,37.8044] },
                      "$maxDistance" : 2000
                  }
              }
      }
  }, function (e) {
      if (e.success) {
          Ti.API.info(JSON.stringify(e.geo_fences));
      } else {
          alert('Error:\n' +
              ((e.error && e.message) || JSON.stringify(e)));
      }
  });

Update a geo-fence object

This example updates a geo-fence object and checks the response.

Cloud.GeoFences.update({
    id: geoFenceId,
    geo_fence:{"loc":{"place_id":"531a1217447d300f05003b69","radius":"2/6371"}}
}, function (e) {
    if (e.success) {
        Ti.API.info(JSON.stringify(e.geo_fences));
    } else {
        alert('Error:\n' +
            ((e.error && e.message) || JSON.stringify(e)));
    }
});

Delete a geo-fence object

This example deletes a geo-fence object and checks the response.

Cloud.GeoFences.remove({
    id: geoFenceId
}, function (e) {
    if (e.success) {
        Ti.API.info(JSON.stringify(e));
    } else {
        alert('Error:\n' +
            ((e.error && e.message) || JSON.stringify(e)));
    }
});
  • 3.2.1
  • 3.2.1
  • 3.2.1
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2.0
  • 3.2.0
  • 3.2.0
Indicates if the proxy will bubble an event to its parent. ...

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

  • 3.0.0
  • 3.0.0
  • 3.0.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Defined By

Methods

Applies the properties to the proxy. ...

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Modules.Cloud.GeoFences
( parameters, callback )
Create a new geofence object. ...

Create a new geofence object.

You must be an enterprise application admin to use this API.

See geo_fences/create.json for the request parameters supported by this method.

Data is returned in the geo_fences property of the parameter passed to the callback.

Parameters

  • parameters : Dictionary

    Parameters to send in the request.

  • callback : Callback<CloudGeoFenceResponse>

    Callback function to execute when the method completes.

Returns

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Modules.Cloud.GeoFences
( [parameters], callback )
Retrieve a list of places with sorting and pagination. ...

Retrieve a list of places with sorting and pagination.

You must be an enterprise application user to use this API.

See geo_fences/query.json for the request parameters supported by this method.

Data is returned in the geo_fences property of the parameter passed to the callback.

Parameters

  • parameters : Dictionary (optional)

    Parameters to send in the request.

  • callback : Callback<CloudGeoFenceResponse>

    Callback function to execute when the method completes.

Returns

  • void
Modules.Cloud.GeoFences
( parameters, callback )
Delete a place. ...

Delete a place.

You must be an enterprise application admin to use this API.

See geo_fences/delete.json for the request parameters supported by this method.

Parameters

  • parameters : Dictionary

    Parameters to send in the request.

  • callback : Callback<CloudGeoFenceResponse>

    Callback function to execute when the method completes.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Modules.Cloud.GeoFences
( parameters, callback )
Update information about a place. ...

Update information about a place.

You must be an enterprise application admin to use this API.

See geo_fences/update.json for the request parameters supported by this method.

Data is returned in the geo_fences property of the parameter passed to the callback.

Parameters

  • parameters : Dictionary

    Parameters to send in the request.

  • callback : Callback<CloudGeoFenceResponse>

    Callback function to execute when the method completes.

Returns

  • void