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

Users
Constructors
Users	The Users constructor.
Methods
addAppSubscription	Subscribes a user to an application.
addUser	This requests adds a new user in the Users module. The user details will be used by all applications the user is subscribed to.
cancelAppSubscription	Cancels a user's subscription to an application.
changeUserName	Changes the username.
changeUserPassword	Changes a user's password.
deletePresenceIcon	Delete the presence icon of the current logged in user.
deleteUser	Deletes the user.
forgotUserPassword	Sends an email with the password details to a specific account.
getPhoneValidationKey	Sends to the user's mobile phone SMS with a unique validation key.
getPresenceDetails	Gets the presence details.
getUser	Gets the user's details.
keepSessionAlive	Renew the current user's session.
searchUsers	Searchs for application users (searchs firstname or last name).
sendValidationEmail	Sends to the current user's email box a validation email.
setAppId	Sets a new app id.
setPresenceDetails	Sets the presence details.
setPresenceLocation	Sets the presence location.
setPresenceStatus	Sets the presence status.
signIn	This is an application login request.
signOut	This is an application log out request.
updateUser	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.
validateEmail	This method will validate the user email.
validatePhone	Get the validation key from the user and validate his mobile phone.
Properties
responseMessage	The message from the LBS server.
responseStatus	The ResponseStatus object of the users which includes the results from the server.
responseText	The response text from the LBS server.
resultCauseName	The cause name result that return from the LBS server.
resultCausesList	An array that contains a list of the causes result that return from the LBS server.
resultCauseType	The cause type result that return from the LBS server.
resultId	The result id that return from the LBS server.
resultStatusCode	Equal to resultId.
user	User object.
userList	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

userName	The user name.
password	The password.

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

userName	The user name.
password	The password.
email	The email.
gender	The gender(M/F).
country	The country.
birthday	The birthday in timestamp.
firstName	The firstName.
lastName	The lastName.
phoneNumber	The phoneNumber.
field1	Custum field number 1.
field2	Custum field number 2.
field3	Custum field number 3.
phoneValidationKey	The key that the user got from server by SMS.

cancelAppSubscription

cancelAppSubscription( string userName
string password )

Cancels a user's subscription to an application.

Parameters

userName	The user name.
password	The password.

changeUserName

changeUserName( string userName
string password
string newUserName )

Cancels a user's subscription to an application.

Parameters

userName	The user name.
password	The password.
newUserName	The new user name.

changeUserPassword

changeUserPassword( string userName
string password
string newPassword )

Cancels a user's subscription to an application.

Parameters

userName	The user name.
password	The password.
newPassword	The new password.

deletePresenceIcon

deletePresenceIcon()

Delete the presence icon of the current logged in user.

deleteUser

deleteUser( string userName
string password )

Deletes the user.

Parameters

userName	The user name.
password	The password.

forgotUserPassword

forgotUserPassword(string userName)

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

Parameters

userName

The user name.

getPhoneValidationKey

getPhoneValidationKey(string phoneNumber)

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

Parameters

phoneNumber

The phone number.

getPresenceDetails

getPresenceDetails()

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

getUser

getUser()

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

keepSessionAlive

keepSessionAlive()

Renew the current user's session.

searchUsers

searchUsers(string searchText)

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

Parameters

searchText

The 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

appId

The new app id.

setPresenceDetails

setPresenceDetails( boolean locationPermission
string nickName
string personnalMessage )

Sets the presence details.

Parameters

locationPermission	The location permissions for the user. If equal to false - the location of the user will stay private.
nickName	The user's nickname.
personnalMessage	The personnal message of the user.

setPresenceLocation

setPresenceLocation( LatLong latLong
timestamp localTime
timestamp time )

Sets the presence location.

Parameters

latLong	The latLong presence location.
localTime	The local time in timestamp.
time	The current time in timestamp.

setPresenceStatus

setPresenceStatus(string status)

Sets the presence status.

Parameters

status

The new status.

signIn

signIn(string userName, string password)

This is an application login request.

Parameters

userName	The user name.
password	The password.

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

email	The email.
gender	The gender(M/F).
country	The country.
birthday	The birthday in timestamp.
firstName	The firstName.
lastName	The lastName.
phoneNumber	The phoneNumber.
field1	Custum field number 1.
field2	Custum field number 2.
field3	Custum field number 3.
phoneValidationKey	The key that the user got from server by SMS. Should update only if the phoneNumber has been changed.

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

phoneNumber	The phoneNumber.
phoneValidationKey	The 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.

Users

Constructors

Users

Methods

addAppSubscription

Parameters

See Also

addUser

Parameters

See Also

cancelAppSubscription

Parameters

See Also

changeUserName

Parameters

See Also

changeUserPassword

Parameters

See Also

deletePresenceIcon

deleteUser

Parameters

forgotUserPassword

Parameters

See Also

getPhoneValidationKey

Parameters

See Also

getPresenceDetails

See Also

getUser

See Also

keepSessionAlive

See Also

searchUsers

Parameters

sendValidationEmail

setAppId

Parameters

setPresenceDetails

Parameters

See Also

setPresenceLocation

Parameters

See Also

setPresenceStatus

Parameters

See Also

signIn

Parameters

See Also

signOut

See Also

updateUser

Parameters

See Also

validateEmail

validatePhone

Parameters

Properties

responseMessage

responseStatus

responseText

resultCauseName

resultCausesList

resultCauseType

resultId

resultStatusCode

user

userList