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

java.lang.Object
  extended by eg.com.espace.wenear.client.WeNearClient.UserService
Enclosing class:
WeNearClient

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

Service interface for operations on user accounts.


Nested Class Summary
static class WeNearClient.UserService.TUser
           
 
Constructor Summary
WeNearClient.UserService(WeNearClient client)
           
 
Method Summary
 void appear()
          Causes the logged-in user to be visible to his/her friends.
 void createUser(java.lang.String login, java.lang.String password, java.lang.String fullName, java.lang.String email, java.lang.String secretQuestion, java.lang.String secretQuestionAnswer)
          Creates a new user account.
 void disableAccount(java.lang.String password)
          Disables the logged-in user's account (in case the handset is stolen, for example).
 void disappear()
          Causes the logged-in user to be invisible to his/her friends.
 void enableAccount(java.lang.String oldPassword, java.lang.String newPassword, java.lang.String secretQuestion, java.lang.String secretQuestionAnswer)
          Enables the logged-in user account, provided that the given credentials are correct.
 WeNearClient.UserService.TUser getUser()
          Retrieves the user object associated with the logged-in user.
 WeNearClient.UserService.TUser[] getUsers(int page)
          Retrieves all user objects within the specified page.
 void updateUser(java.lang.String oldPassword, java.lang.String newPassword, java.lang.String fullName, java.lang.String email)
          Updates the account information of the logged-in user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WeNearClient.UserService

public WeNearClient.UserService(WeNearClient client)
Method Detail

getUser

public WeNearClient.UserService.TUser getUser()
                                       throws WeNearClient.UnknownErrorException,
                                              WeNearClient.BadResponseException,
                                              WeNearClient.BadRequestException,
                                              WeNearClient.NoSuchClientException
Retrieves the user object associated with the logged-in user.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.NoSuchClientException

getUsers

public WeNearClient.UserService.TUser[] getUsers(int page)
                                          throws WeNearClient.UnknownErrorException,
                                                 WeNearClient.BadResponseException,
                                                 WeNearClient.BadRequestException
Retrieves all user objects within the specified page. Requires administrator privilege.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException

createUser

public void createUser(java.lang.String login,
                       java.lang.String password,
                       java.lang.String fullName,
                       java.lang.String email,
                       java.lang.String secretQuestion,
                       java.lang.String secretQuestionAnswer)
                throws WeNearClient.UnknownErrorException,
                       WeNearClient.BadResponseException,
                       WeNearClient.BadRequestException,
                       WeNearClient.DuplicateNameException
Creates a new user account.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.DuplicateNameException

updateUser

public void updateUser(java.lang.String oldPassword,
                       java.lang.String newPassword,
                       java.lang.String fullName,
                       java.lang.String email)
                throws WeNearClient.UnknownErrorException,
                       WeNearClient.BadResponseException,
                       WeNearClient.BadRequestException,
                       WeNearClient.NoSuchClientException,
                       WeNearClient.NotAllowedException
Updates the account information of the logged-in user.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.NoSuchClientException
WeNearClient.NotAllowedException

appear

public void appear()
            throws WeNearClient.UnknownErrorException,
                   WeNearClient.BadResponseException,
                   WeNearClient.BadRequestException,
                   WeNearClient.NoSuchClientException
Causes the logged-in user to be visible to his/her friends.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.NoSuchClientException

disappear

public void disappear()
               throws WeNearClient.UnknownErrorException,
                      WeNearClient.BadResponseException,
                      WeNearClient.BadRequestException,
                      WeNearClient.NoSuchClientException
Causes the logged-in user to be invisible to his/her friends.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.NoSuchClientException

disableAccount

public void disableAccount(java.lang.String password)
                    throws WeNearClient.UnknownErrorException,
                           WeNearClient.BadResponseException,
                           WeNearClient.BadRequestException,
                           WeNearClient.NoSuchClientException,
                           WeNearClient.NotAllowedException
Disables the logged-in user's account (in case the handset is stolen, for example).

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.NoSuchClientException
WeNearClient.NotAllowedException

enableAccount

public void enableAccount(java.lang.String oldPassword,
                          java.lang.String newPassword,
                          java.lang.String secretQuestion,
                          java.lang.String secretQuestionAnswer)
                   throws WeNearClient.UnknownErrorException,
                          WeNearClient.BadResponseException,
                          WeNearClient.BadRequestException,
                          WeNearClient.NoSuchClientException,
                          WeNearClient.NotAllowedException
Enables the logged-in user account, provided that the given credentials are correct.

Throws:
WeNearClient.UnknownErrorException
WeNearClient.BadResponseException
WeNearClient.BadRequestException
WeNearClient.NoSuchClientException
WeNearClient.NotAllowedException