AtlasCT.com
User Manual v5.0

Social

Manage groups, friends, invitations, get and search friends and group members in geographic context.
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 Social constructor.
Creates a new social group.
Cancel an invitation.
Deletes a social group.
The invited friend's reply to a friend invitation.
Returns a list of all my friends or requested friends if the request is by friend ids.
Returns a requested group details.
Returns a list of all requested group members.
Returns a list of all the social groups the user can invite others to join.
Returns a list of the social groups the user belongs to.
Retruns all the invitations snt to the user (friend invitations and join group invitations).
Returns all the open join group requests - this request is group owners.
Returns a list of invitations sent by a requested user.
Returns a requested social member's details.
This is the invited user's replay to a join group invitation sent to him.
This request is invitations to users to be your friend.
This is a request to join a social group. If the group is public the requesting user will automically be joined to the group. If the requested group is restricted then the request must be approved by the group owner.
This is an invitation sent to a user to join a social group.
This is a group owner reply to a join group request.
This is request to leave a social group the requesting user is a member of.
Removes existing friends.
Request made by group owner to remove a group member.
Searchs for your friends.
Searchs for a group members.
Searches for groups by given text. Returns only the public and restricted groups (not the private groups).
Updates a social group details (group name, description etc.).
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.
Group object.
An array that contains a list of Group objects.

Constructors

Social

Social()

The Social constructor.

Methods

addNewGroup

addNewGroup( string groupName
string groupDescription
string accessType
string invitationType)

Creates a new social group.

Parameters

groupNameThe group name.
groupDescriptionThe group description.
accessTypeThe access type of the group (PUBLIC, PRIVATE, RESTRICTED).
invitationTypeThe invitation type of the group (OWNER, MEMBER).

See Also

deleteGroup, updateGroupDetails

cancelInvitation

cancelInvitation( string invitationId)

Cancel an invitation.

Parameters

invitationIdThe invitation id.

See Also

getSentInvitations

deleteGroup

deleteGroup( string groupId)

Deletes a social group.

Parameters

groupIdThe group id.

See Also

addNewGroup

friendInvitationReply

friendInvitationReply( string invitationIds
string reply)

The invited friend's reply to a friend invitation.

Parameters

invitationIdsThe invitation(s) id(s).
replyReply command (APPROVE, REJECT).

See Also

inviteNewFriends

getFriends

getFriends( string friendIds)

Returns a list of all my friends or requested friends if the request is by friend ids.

Parameters

friendIdsFriend(s) id(s).

See Also

inviteNewFriends

getGroupDetails

getGroupDetails( string groupId)

Returns a requested group details.

Parameters

groupIdThe group id.

See Also

addNewGroup

getGroupMembers

getGroupMembers( string groupId)

Returns a list of all requested group members.

Parameters

groupIdThe group id.

See Also

joinGroup

getGroupsForInvitation

getGroupsForInvitation( string invitedUserId)

Returns a list of all the social groups the user can invite others to join.

Parameters

invitedUserIdThe invited user id.

See Also

joinGroupInvitation

getMemberGroups

getMemberGroups( )

Returns a list of the social groups the user belongs to.

See Also

joinGroup

getOpenInvitations

getOpenInvitations( string invitationId)

Retruns all the invitations snt to the user (friend invitations and join group invitations).

Parameters

invitationIdThe invitation id.

See Also

getSentInvitations

getOpenJoinGroupRequests

getOpenJoinGroupRequests( string groupId)

Returns all the open join group requests - this request is group owners.

Parameters

groupIdThe group id.

getSentInvitations

getSentInvitations( string replyStatuses)

Returns a list of invitations sent by a requested user.

Parameters

replyStatusesThe reply status (OPEN, APPROVE, REJECT).

See Also

getOpenInvitations

getSocialMemberDetails

getSocialMemberDetails( string memberId)

Returns a requested social member's details.

Parameters

memberIdThe member id.

groupInvitationReply

groupInvitationReply( string groupId
string invitationId
string reply)

This is the invited user's replay to a join group invitation sent to him.

Parameters

groupIdThe group id.
invitationIdThe invitation id.
replyThe reply status (APPROVE, REJECT).

inviteNewFriends

inviteNewFriends( string friendIds)

This request is invitations to users to be your friend.

Parameters

friendIdsThe friends(s) id(s).

See Also

getFriends, friendInvitationReply

joinGroup

joinGroup( string groupId)

This is a request to join a social group. If the group is public the requesting user will automically be joined to the group. If the requested group is restricted then the request must be approved by the group owner.

Parameters

groupIdThe group id.

See Also

leaveGroup, joinGroupReply

joinGroupInvitation

joinGroupInvitation( string groupId
string invitedUserIds)

This is an invitation sent to a user to join a social group.

Parameters

groupIdThe group id.
invitedUserIdsThe invited user id(s).

joinGroupReply

joinGroupReply( string groupId
string memberId
string joinGroupRequestId
string reply)

This is a group owner reply to a join group request.

Parameters

groupIdThe group id.
memberIdThe member id.
joinGroupRequestIdThe join group request id.
replyThe reply status (APPROVE, REJECT).

leaveGroup

leaveGroup( string groupId)

This is request to leave a social group the requesting user is a member of.

Parameters

groupIdThe group id.

See Also

joinGroup

removeFriends

removeFriends( string friendIds)

Removes existing friends.

Parameters

friendIdsThe friend(s) id(s).

See Also

inviteNewFriends

removeGroupMember

removeGroupMember( string groupId
string memberId)

Request made by group owner to remove a group member.

Parameters

groupIdThe group id.
memberIdThe member id.

See Also

joinGroup, joinGroupInvitation, joinGroupReply

searchGeoFriends

searchGeoFriends( string radius
LatLong latLong)

Searchs for your friends.

Parameters

radiusThe radius to search.
latLongThe latlong point.

searchGeoGroupsMembers

searchGeoGroupsMembers( string groupIds
string radius
LatLong latLong)

Searchs for a group members.

Parameters

groupIdsThe group(s) id(s).
radiusThe radius to search.
latLongThe latlong point.

searchGroups

searchGroups( string searchTexts)

Searches for groups by given text. Returns only the public and restricted groups (not the private groups).

Parameters

searchTextsThe search text.

updateGroupDetails

updateGroupDetails( string groupName
string groupDescription
string accessType
string invitationType
string groupId)

Updates a social group details (group name, description etc.).

Parameters

groupNameThe group name.
groupDescriptionThe group description.
accessTypeThe access type of the group (PUBLIC, PRIVATE, RESTRICTED).
invitationTypeThe invitation type of the group (OWNER, MEMBER).
groupIdThe group id.

See Also

addNewGroup, deleteGroup

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.

group

Group group

Group object.

groupList

Array[] groupList

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