eg.com.espace.wenear.client
Class WeNearClient.UserFriendsService

java.lang.Object
  eg.com.espace.wenear.client.WeNearClient.UserFriendsService

Enclosing class:

WeNearClient

public static class WeNearClient.UserFriendsService
extends java.lang.Object

Service interface for managing friendship associations.

Nested Class Summary

static class	WeNearClient.UserFriendsService.TFriendInfo
static class	WeNearClient.UserFriendsService.TFriendUpdateInfo
static class	WeNearClient.UserFriendsService.TInvitee

Constructor Summary

WeNearClient.UserFriendsService(WeNearClient client)

Method Summary

void	checkPendingInvitations(java.lang.String inviteePhoneNumber) Causes any pending invitations intended for the specified invitee to be sent at the given phone number via SMS.
void	deleteFriendship(java.lang.String friendLogin) Removes the association with the specified friend.
WeNearClient.UserFriendsService.TFriendInfo	getFriendInfo(java.lang.String friendLogin) Retrieves the location and status of the specified friend
WeNearClient.UserFriendsService.TFriendInfo[]	getFriendsInfo(int page) Retrieves the location and status of all friends.
WeNearClient.UserFriendsService.TFriendUpdateInfo[]	getUpdatedFriends() Retrieves friends whose location has changed since the last time this method was invoked successfully.
void	inviteUsers(java.lang.String inviterPhoneNumber, WeNearClient.UserFriendsService.TInvitee[] invitees) Sends invitations to join the service to the specified invitees.
void	respondToInvitation(java.lang.String invitationCode, java.lang.String inviteePhoneNumber, int personId, boolean accepted) Allows the user to accept/reject an invitation.
void	updateFriendship(java.lang.String friendLogin, boolean visible) Updates the mutual visibility status between the logged-in user and the friend specified by the given login name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeNearClient.UserFriendsService

public WeNearClient.UserFriendsService(WeNearClient client)

Method Detail

inviteUsers

public void inviteUsers(java.lang.String inviterPhoneNumber,
                        WeNearClient.UserFriendsService.TInvitee[] invitees)
                 throws WeNearClient.UnknownErrorException,
                        WeNearClient.BadResponseException,
                        WeNearClient.BadRequestException,
                        WeNearClient.InvalidArgumentsException,
                        WeNearClient.NoSuchClientException

Sends invitations to join the service to the specified invitees. The sender is identified by his/her phone number in the invitation SMS.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

WeNearClient.InvalidArgumentsException

WeNearClient.NoSuchClientException

updateFriendship

public void updateFriendship(java.lang.String friendLogin,
                             boolean visible)
                      throws WeNearClient.UnknownErrorException,
                             WeNearClient.BadResponseException,
                             WeNearClient.BadRequestException,
                             WeNearClient.NoSuchClientException

Updates the mutual visibility status between the logged-in user and the friend specified by the given login name.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

WeNearClient.NoSuchClientException

checkPendingInvitations

public void checkPendingInvitations(java.lang.String inviteePhoneNumber)
                             throws WeNearClient.UnknownErrorException,
                                    WeNearClient.BadResponseException,
                                    WeNearClient.BadRequestException

Causes any pending invitations intended for the specified invitee to be sent at the given phone number via SMS.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

respondToInvitation

public void respondToInvitation(java.lang.String invitationCode,
                                java.lang.String inviteePhoneNumber,
                                int personId,
                                boolean accepted)
                         throws WeNearClient.UnknownErrorException,
                                WeNearClient.BadResponseException,
                                WeNearClient.BadRequestException,
                                WeNearClient.NoSuchInvitationException,
                                WeNearClient.NoSuchClientException,
                                WeNearClient.NotAllowedException

Allows the user to accept/reject an invitation. In case of acceptance, a valid invitation code has to be supplied.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

WeNearClient.NoSuchInvitationException

WeNearClient.NoSuchClientException

WeNearClient.NotAllowedException

getUpdatedFriends

public WeNearClient.UserFriendsService.TFriendUpdateInfo[] getUpdatedFriends()
                                                                      throws WeNearClient.UnknownErrorException,
                                                                             WeNearClient.BadResponseException,
                                                                             WeNearClient.BadRequestException,
                                                                             WeNearClient.NoSuchClientException

Retrieves friends whose location has changed since the last time this method was invoked successfully.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

WeNearClient.NoSuchClientException

getFriendsInfo

public WeNearClient.UserFriendsService.TFriendInfo[] getFriendsInfo(int page)
                                                             throws WeNearClient.UnknownErrorException,
                                                                    WeNearClient.BadResponseException,
                                                                    WeNearClient.BadRequestException

Retrieves the location and status of all friends.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

getFriendInfo

public WeNearClient.UserFriendsService.TFriendInfo getFriendInfo(java.lang.String friendLogin)
                                                          throws WeNearClient.UnknownErrorException,
                                                                 WeNearClient.BadResponseException,
                                                                 WeNearClient.BadRequestException,
                                                                 WeNearClient.NoSuchClientException

Retrieves the location and status of the specified friend

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

WeNearClient.NoSuchClientException

deleteFriendship

public void deleteFriendship(java.lang.String friendLogin)
                      throws WeNearClient.UnknownErrorException,
                             WeNearClient.BadResponseException,
                             WeNearClient.BadRequestException,
                             WeNearClient.NoSuchClientException

Removes the association with the specified friend.

Throws:

WeNearClient.UnknownErrorException

WeNearClient.BadResponseException

WeNearClient.BadRequestException

WeNearClient.NoSuchClientException