AtlasCT.com
User Manual v5.0

Users

Creating and maintaining user account, sign up and sign in, session management, password handling, search users, etc. it is also possible to create several applications and services, so the same user can subscribe to more than one application.
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 Users constructor.
Subscribes a user to an application.
This requests adds a new user in the Users module. The user details will be used by all applications the user is subscribed to.
Cancels a user's subscription to an application.
Changes the username.
Changes a user's password.
Delete the presence icon of the current logged in user.
Deletes the user.
Sends an email with the password details to a specific account.
Sends to the user's mobile phone SMS with a unique validation key.
Gets the presence details.
Gets the user's details.
Renew the current user's session.
Searchs for application users (searchs firstname or last name).
Sends to the current user's email box a validation email.
Sets a new app id.
Sets the presence details.
Sets the presence location.
Sets the presence status.
This is an application login request.
This is an application log out request.
This request is to update the user details. All the user details can be updated except for the userName. The user's password can only be updated using the change user password API.
This method will validate the user email.
Get the validation key from the user and validate his mobile phone.
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.
User object.
An array that contains a list of User objects.

Constructors

Users

Users()

The Users constructor.

Methods

addAppSubscription

addAppSubscription( string userName
string password)

Subscribes a user to an application.

Parameters

userNameThe user name.
passwordThe password.

See Also

cancelAppSubscription

addUser

addUser( string userName
string password
string email
string gender
string country
timestamp birthday
string firstName
string lastName
string phoneNumber
string field1
string field2
string field3
string phoneValidationKey)

This requests adds a new user in the Users module. The user details will be used by all applications the user is subscribed to.

Parameters

userNameThe user name.
passwordThe password.
emailThe email.
genderThe gender(M/F).
countryThe country.
birthdayThe birthday in timestamp.
firstNameThe firstName.
lastNameThe lastName.
phoneNumberThe phoneNumber.
field1Custum field number 1.
field2Custum field number 2.
field3Custum field number 3.
phoneValidationKeyThe key that the user got from server by SMS.

See Also

deleteUser

cancelAppSubscription

cancelAppSubscription( string userName
string password)

Cancels a user's subscription to an application.

Parameters

userNameThe user name.
passwordThe password.

See Also

addAppSubscription

changeUserName

changeUserName( string userName
string password
string newUserName)

Cancels a user's subscription to an application.

Parameters

userNameThe user name.
passwordThe password.
newUserNameThe new user name.

See Also

changeUserPassword, updateUser

changeUserPassword

changeUserPassword( string userName
string password
string newPassword)

Cancels a user's subscription to an application.

Parameters

userNameThe user name.
passwordThe password.
newPasswordThe new password.

See Also

changeUserName, updateUser

deletePresenceIcon

deletePresenceIcon()

Delete the presence icon of the current logged in user.

deleteUser

deleteUser( string userName
string password)

Deletes the user.

Parameters

userNameThe user name.
passwordThe password.

forgotUserPassword

forgotUserPassword(string userName)

Sends an email with the password details to a specific account.

Parameters

userNameThe user name.

See Also

changeUserPassword

getPhoneValidationKey

getPhoneValidationKey(string phoneNumber)

Sends to the user's mobile phone SMS with a unique validation key.

Parameters

phoneNumberThe phone number.

See Also

addUser

getPresenceDetails

getPresenceDetails()

Gets the presence details. This action initialize the users properties.

See Also

setPresenceDetails

getUser

getUser()

Gets the user's details. This action initialize the users properties.

See Also

getPresenceDetails

keepSessionAlive

keepSessionAlive()

Renew the current user's session.

See Also

signIn

searchUsers

searchUsers(string searchText)

Searchs for application users (searchs firstname or last name).

Parameters

searchTextThe query to search for.

sendValidationEmail

sendValidationEmail()

Sends to the current user's email box a validation email.

setAppId

setAppId(string appId)

Sets a new app id.

Parameters

appIdThe new app id.

setPresenceDetails

setPresenceDetails( boolean locationPermission
string nickName
string personnalMessage)

Sets the presence details.

Parameters

locationPermissionThe location permissions for the user. If equal to false - the location of the user will stay private.
nickNameThe user's nickname.
personnalMessageThe personnal message of the user.

See Also

getPresenceDetails

setPresenceLocation

setPresenceLocation( LatLong latLong
timestamp localTime
timestamp time)

Sets the presence location.

Parameters

latLongThe latLong presence location.
localTimeThe local time in timestamp.
timeThe current time in timestamp.

See Also

getPresenceDetails

setPresenceStatus

setPresenceStatus(string status)

Sets the presence status.

Parameters

statusThe new status.

See Also

getPresenceDetails

signIn

signIn(string userName, string password)

This is an application login request.

Parameters

userNameThe user name.
passwordThe password.

See Also

signOut

signOut

signOut()

This is an application log out request.

See Also

signIn

updateUser

updateUser( string email
string gender
string country
timestamp birthday
string firstName
string lastName
string phoneNumber
string field1
string field2
string field3
string phoneValidationKey)

This request is to update the user details. All the user details can be updated except for the userName. The user's password can only be updated using the change user password API.

Parameters

emailThe email.
genderThe gender(M/F).
countryThe country.
birthdayThe birthday in timestamp.
firstNameThe firstName.
lastNameThe lastName.
phoneNumberThe phoneNumber.
field1Custum field number 1.
field2Custum field number 2.
field3Custum field number 3.
phoneValidationKeyThe key that the user got from server by SMS. Should update only if the phoneNumber has been changed.

See Also

addUser

validateEmail

validateEmail()

This method will validate the user email.

validatePhone

validatePhone( string phoneNumber
string phoneValidationKey)

Get the validation key from the user and validate his mobile phone.

Parameters

phoneNumberThe phoneNumber.
phoneValidationKeyThe key that the user got from server by SMS. Should update only if the phoneNumber has been changed.

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.

user

User user

User object.

userList

Array[] userList

An array that contains a list of User 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.