de.geomobile.joined.api.service
Class JoinedService

java.lang.Object
  de.geomobile.joined.api.service.JoinedService

public class JoinedService
extends Object

Constructor Summary

JoinedService()

Method Summary

String	acceptFriend(String userId, String secureToken, String friendId) Accept a friend invitation.
void	activateUser(String userId, String secureToken, boolean active) Activate or deactivate user
void	addFriend(String userId, String secureToken, String friendId) Add a friend.
static JoinedService	createJoinedService(String joinedServerUrl, String joinedSecretSalt)
boolean	deleteFriend(String userId, String secureToken, String friendId) Delete a friend.
void	deleteMessages(String userId, String secureToken) Deletes all Messages from Server of the User as recipient in the DB.
void	deleteUser(String userId, String secureToken) Delete current user
String	ffLogin(String name, String password)
String	ffRegister(String name, String password) Register for FriendFinder users.
String	getFriends(String userId, String secureToken)
String	getJoinedSecretSalt()
String	getJoinedServerUrl()
String	getMessages(String userId, String secureToken) Gets all unread Messages of the User.
void	logoutUser(String userId, String secureToken) User logout.
String	searchFriends(String userId, String secureToken, String nickname) Search for users by nickname
String	sendMessage(String userId, String secureToken, String friendsId, String msg) Send a text message to friend
void	setJoinedSecretSalt(String joinedSecretSalt)
void	setJoinedServerUrl(String joinedServerUrl)
void	updateUser(String userId, String secureToken, double latitude, double longitude) Update users current location

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinedService

public JoinedService()

Method Detail

createJoinedService

public static JoinedService createJoinedService(String joinedServerUrl,
                                                String joinedSecretSalt)

Parameters:

joinedServerUrl -

joinedSecretSalt -

Returns:

getJoinedServerUrl

public String getJoinedServerUrl()

Returns:

setJoinedServerUrl

public void setJoinedServerUrl(String joinedServerUrl)

Parameters:

joinedServerUrl -

getJoinedSecretSalt

public String getJoinedSecretSalt()

Returns:

setJoinedSecretSalt

public void setJoinedSecretSalt(String joinedSecretSalt)

Parameters:

joinedSecretSalt -

ffRegister

public String ffRegister(String name,
                         String password)
                  throws FriendFinderHTTPException,
                         FriendFinderUnexpectedException,
                         FriendFinderServerException,
                         FriendFinderConflictException

Register for FriendFinder users. The nickname and password are mandatory.

Parameters:

name - The users nickname.

password - The users password.

profilImage - The users profile image exists.

Returns:

the generated attributes userid and secureToken as json object.

Throws:

FriendFinderHTTPException - when another exception runs

FriendFinderUnexpectedException

FriendFinderServerException

FriendFinderConflictException - when nickname already exists

ffLogin

public String ffLogin(String name,
                      String password)
               throws FriendFinderHTTPException,
                      FriendFinderServerException,
                      FriendFinderUnexpectedException,
                      FriendFinderLoginException

Parameters:

name -

password -

Returns:

Throws:

FriendFinderHTTPException

FriendFinderServerException

FriendFinderUnexpectedException

FriendFinderLoginException

getFriends

public String getFriends(String userId,
                         String secureToken)
                  throws FriendFinderHTTPException,
                         FriendFinderServerException,
                         FriendFinderUnexpectedException,
                         FriendFinderLoginException

Parameters:

userId -

secureToken -

Returns:

Throws:

FriendFinderHTTPException

FriendFinderServerException

FriendFinderUnexpectedException

FriendFinderLoginException

addFriend

public void addFriend(String userId,
                      String secureToken,
                      String friendId)
               throws FriendFinderHTTPException,
                      FriendFinderServerException,
                      FriendFinderUnexpectedException,
                      FriendFinderSourceException

Add a friend. The id, secureToken of User and friend's are mandatory.

Parameters:

userId - The users id.

secureToken - The users secureToken.

friendId - The friends id to add.

Throws:

FriendFinderHTTPException

FriendFinderServerException

FriendFinderUnexpectedException

FriendFinderSourceException

acceptFriend

public String acceptFriend(String userId,
                           String secureToken,
                           String friendId)
                    throws FriendFinderHTTPException,
                           FriendFinderUnexpectedException,
                           FriendFinderServerException

Accept a friend invitation. The id, secureToken of User and friend's are mandatory.

Parameters:

userId - The users id.

secureToken - The users secureToken.

friendId - The friends id to add.

Throws:

FriendFinderHTTPException

FriendFinderUnexpectedException

FriendFinderServerException

deleteFriend

public boolean deleteFriend(String userId,
                            String secureToken,
                            String friendId)
                     throws FriendFinderHTTPException,
                            FriendFinderUnexpectedException,
                            FriendFinderServerException

Delete a friend. The id, secureToken of User and friend's are mandatory.

Parameters:

userId - The users id.

secureToken - The users secureToken.

friendId - The friend's id to delete.

Throws:

FriendFinderHTTPException

FriendFinderUnexpectedException

FriendFinderServerException

searchFriends

public String searchFriends(String userId,
                            String secureToken,
                            String nickname)
                     throws FriendFinderHTTPException,
                            FriendFinderServerException,
                            FriendFinderUnexpectedException

Search for users by nickname

Parameters:

userId - The users id.

secureToken - The users secureToken.

nickname - The friend's nickname to search.

Returns:

a JSON string

Throws:

FriendFinderHTTPException

FriendFinderServerException

FriendFinderUnexpectedException

updateUser

public void updateUser(String userId,
                       String secureToken,
                       double latitude,
                       double longitude)
                throws FriendFinderUnexpectedException,
                       FriendFinderServerException,
                       FriendFinderHTTPException

Update users current location

Parameters:

userId - The users id.

secureToken - The users secureToken.

latitude -

longitude -

Throws:

FriendFinderUnexpectedException

FriendFinderServerException

FriendFinderHTTPException

activateUser

public void activateUser(String userId,
                         String secureToken,
                         boolean active)
                  throws FriendFinderUnexpectedException,
                         FriendFinderServerException,
                         FriendFinderHTTPException

Activate or deactivate user

Parameters:

userId - The users id.

secureToken - The users secureToken.

active - active or deactive

Throws:

FriendFinderUnexpectedException

FriendFinderServerException

FriendFinderHTTPException

logoutUser

public void logoutUser(String userId,
                       String secureToken)
                throws FriendFinderUnexpectedException,
                       FriendFinderServerException,
                       FriendFinderHTTPException

User logout.

Parameters:

userId - The users id.

secureToken - The users secureToken.

Throws:

FriendFinderUnexpectedException

FriendFinderServerException

FriendFinderHTTPException

deleteUser

public void deleteUser(String userId,
                       String secureToken)
                throws FriendFinderUnexpectedException,
                       FriendFinderServerException,
                       FriendFinderHTTPException

Delete current user

Parameters:

userId - The users id.

secureToken - The users secureToken.

Throws:

FriendFinderUnexpectedException

FriendFinderServerException

FriendFinderHTTPException

sendMessage

public String sendMessage(String userId,
                          String secureToken,
                          String friendsId,
                          String msg)
                   throws FriendFinderServerException,
                          FriendFinderUnexpectedException,
                          FriendFinderHTTPException

Send a text message to friend

Parameters:

userId - The users id.

secureToken - The users secureToken.

friendsId - The friends id to send this message

msg - The text message

Returns:

The HashMap String with id and time

Throws:

FriendFinderServerException

FriendFinderUnexpectedException

FriendFinderHTTPException

getMessages

public String getMessages(String userId,
                          String secureToken)
                   throws FriendFinderServerException,
                          FriendFinderUnexpectedException,
                          FriendFinderHTTPException

Gets all unread Messages of the User.

Parameters:

userId - The users id.

secureToken - The users secureToken.

Returns:

The Json String with Messages info.

Throws:

FriendFinderServerException

FriendFinderUnexpectedException

FriendFinderHTTPException

deleteMessages

public void deleteMessages(String userId,
                           String secureToken)
                    throws FriendFinderServerException,
                           FriendFinderUnexpectedException,
                           FriendFinderHTTPException

Deletes all Messages from Server of the User as recipient in the DB.

Parameters:

userId - The users id.

secureToken - The users secureToken.

Throws:

FriendFinderServerException

FriendFinderUnexpectedException

FriendFinderHTTPException