AtlasCT.com
User Manual v5.0

Alerts

Manage geofencing rules and alerts.
This class is not part of the basic SDK.
In order to use this class you must get an application id from AtlasCT.

Summary
The Alerts constructor.
Add a new geofencing rule.
Delete a specific rule.
Disable a specific rule.
Enable a specific rule.
Gets all previous alerts per a specific period.
Gets all geofencing rules for a specific user.
Send an emergency alert to another user.
Update a specific geofencing rule.
The message from the LBS server.
The ResponseStatus object of the users which includes the results from the server.
The response text from the LBS server.
The cause name result that return from the LBS server.
An array that contains a list of the causes result that return from the LBS server.
The cause type result that return from the LBS server.
The result id that return from the LBS server.
Equal to resultId.
Alert object.
An array that contains a list of Alert objects.
Rule object.
An array that contains a list of Rule objects.

Constructors

Alerts

Alerts()

The Alerts constructor.

Methods

addGeofencingRule

addGeofencingRule( string eventType
string eventUserId
string poiId
string recipientType
string ruleName
boolean sendEmail
boolean sendSMS
boolean sendURL
string startDate
string endDate
string daysInWeek
string storageId
string timeRangeStart
string timeRangeDuration
string customMessageText)

Add a new geofencing rule.

Parameters

eventTypeThe event type (ENTER, LEAVE, ENTER_LEAVE).
eventUserIdThe user id for this event.
poiIdThe poi id.
recipientTypeThe recipient type (OWNER, EVENT_USER, BOTH).
ruleNameThe rule name.
sendEmailA boolean if sending an email.
sendSMSA boolean if sending an sms.
sendURLA boolean if sending an url.
startDateWhen start checking for this rule (dd/mm/yyyy hh:mm:ss).
endDateWhen stop checking for this rule (dd/mm/yyyy hh:mm:ss).
daysInWeekWhich days to check this rule (1,2,3,4,5,6,7).
storageIdThe storage id for this rule.
timeRangeStartThe time range for this rule (hh:mm:ss).
timeRangeDurationThe time duration for this rule (in millis).
customMessageTextA custom message to send instead of the default one.

See Also

updateGeofencingRule

deleteRule

deleteRule( string storageId
string ruleId)

Delete a specific rule.

Parameters

storageIdThe storage id for this rule.
ruleIdThe rule id.

See Also

addGeofencingRule

disableRule

disableRule( string storageId
string ruleId)

Disable a specific rule.

Parameters

storageIdThe storage id for this rule.
ruleIdThe rule id.

See Also

enableRule

enableRule

enableRule( string storageId
string ruleId)

Enable a specific rule.

Parameters

storageIdThe storage id for this rule.
ruleIdThe rule id.

See Also

disableRule

getAlerts

getAlerts( string eventType
string hoursBack)

Gets all previous alerts per a specific period. Initiaze the alert and alertList object.

Parameters

eventTypeThe event type (ENTER, LEAVE, ENTER_LEAVE).
hoursBackHow much hours back to look for?

getGeofencingRules

getGeofencingRules( string storageId
string ruleId
string eventUserId
string poiId)

Gets all geofencing rules for a specific user.

Parameters

storageIdThe storage id for this rule.
ruleIdThe rule id.
eventUserIdThe user id for this event.
poiIdThe poi id.

See Also

addGeofencingRule

sendEmergencyAlert

sendEmergencyAlert( string storageId
string recipientId
timestamp time
timestamp localTime
boolean sendEmail
boolean sendSMS
boolean sendURL
string messageText
LatLong latLong)

Send an emergency alert to another user.

Parameters

storageIdThe storage id for this rule.
recipientIdThe recipient id.
timeThe current time in timestamp.
localTimeThe local time in timestamp.
sendEmailA boolean if sending an email.
sendSMSA boolean if sending an sms.
sendURLA boolean if sending an url.
messageTextThe message for the emergency alert.
latLongThe poi latLong point.

updateGeofencingRule

updateGeofencingRule( string eventType
string eventUserId
string poiId
string recipientType
string ruleName
boolean sendEmail
boolean sendSMS
boolean sendURL
string startDate
string endDate
string daysInWeek
string storageId
string timeRangeStart
string timeRangeDuration
string customMessageText
string ruleId)

Update a specific geofencing rule.

Parameters

eventTypeThe event type (ENTER, LEAVE, ENTER_LEAVE).
eventUserIdThe user id for this event.
poiIdThe poi id.
recipientTypeThe recipient type (OWNER, EVENT_USER, BOTH).
ruleNameThe rule name.
sendEmailA boolean if sending an email.
sendSMSA boolean if sending an sms.
sendURLA boolean if sending an url.
startDateWhen start checking for this rule (dd/mm/yyyy hh:mm:ss).
endDateWhen stop checking for this rule (dd/mm/yyyy hh:mm:ss).
daysInWeekWhich days to check this rule (1,2,3,4,5,6,7).
storageIdThe storage id for this rule.
timeRangeStartThe time range for this rule (hh:mm:ss).
timeRangeDurationThe time duration for this rule (in millis).
customMessageTextA custom message to send instead of the default one.

See Also

updateGeofencingRule

Properties

responseMessage

string responseMessage

The message from the LBS server.

responseStatus

ResponseStatus responseStatus

The ResponseStatus object of the users which includes the results from the server.

responseText

string responseText

The response text from the LBS server.

resultCauseName

string resultCauseName

The cause name result that return from the LBS server.

resultCausesList

Array[] resultCausesList

An array that contains a list of the causes result that return from the LBS server.

resultCauseType

string resultCauseType

The cause type result that return from the LBS server.

resultId

interger resultId

The result id that return from the LBS server.

resultStatusCode

interger resultStatusCode

Equal to resultId.

alert

Alert alert

Alert object.

alertList

Array[] alertList

An array that contains a list of Alert objects.

rule

Rule rule

Rule object.

ruleList

Array[] ruleList

An array that contains a list of Rule objects.

The EventListener class helps you to register event handlers defined by this API.
Some of the classes that inherit from this class are: Map, OverviewMap, LayersManager
Geocode()
The Geocode constructor.
find(Address address)
Convert an address to geographical location.
coordinateToAddress(Coordinate coordinate)
Convert a geographical location to an address.
An integer that contains the search result code.
An Address object that contains the geocode response address.
An array that contains a list of addresses that matching the requested address/coordinate.
This event dispatches after a geocode response has arrived from the server.
The Address class represent a specific address information, with its coordinates.
This is the base class of the provided coordinates classes.