AtlasCT.com
User Manual v5.0

Rule

The Rule class represent a specific rule information.


Summary
The Rule class represent a specific rule information.
The Rule constructor; Creates a new Rule instance by a separate rule fields.
The id of the rule.
Is this rule enabled or disabled?
A boolean if sending an sms.
A boolean if sending an email.
A boolean if sending an url.
The event type (ENTER, LEAVE, ENTER_LEAVE).
The recipient type (OWNER, EVENT_USER, BOTH).
The rule name.
A custom message to send instead of the default one.
The owner (User) of the rule.
The related user for this event.
The Poi obejct.
The Definitions object of the rule.

Constructors

Rule

Rule( string id
boolean enabled
boolean sendSms
boolean sendEmail
boolean sendUrl
string eventType
string recipientType
string name
string customMessageText
User owner
string eventUser
Poi poi
Definitions definitions)

The Rule constructor; Creates a new Rule instance by a separate rule fields.

Parameters

idThe id of the rule.
enabledIs this rule enabled or disabled?
sendSmsA boolean if sending an sms.
sendEmailA boolean if sending an email.
sendUrlA boolean if sending an url.
eventTypeThe event type (ENTER, LEAVE, ENTER_LEAVE).
recipientTypeThe recipient type (OWNER, EVENT_USER, BOTH).
nameThe rule name.
customMessageTextA custom message to send instead of the default one.
ownerThe owner (User) of the rule.
eventUserThe related user for this event.
poiThe Poi obejct.
definitionsThe Definitions object of the rule.

Properties

id

string id

The id of the rule. 

enabled

boolean enabled

Is this rule enabled or disabled? 

sendSms

boolean sendSms

A boolean if sending an sms. 

sendEmail

boolean sendEmail

A boolean if sending an email. 

sendUrl

boolean sendUrl

A boolean if sending an url. 

eventType

string eventType

The event type (ENTER, LEAVE, ENTER_LEAVE). 

recipientType

string recipientType

The recipient type (OWNER, EVENT_USER, BOTH). 

name

string name

The rule name. 

customMessageText

string customMessageText

A custom message to send instead of the default one. 

owner

User owner

The owner (User) of the rule. 

eventUser

string eventUser

The related user for this event. 

poi

Poi poi

The Poi obejct. 

definitions

Definitions definitions

The Definitions object of the rule. 

Address(string fullAddress)
The Address constructor; Creates a new Address instance by a full address value.
This is the base class of the provided coordinates classes.