Package dev.getelements.elements.sdk.service.friend

Interface FriendService

All Known Implementing Classes:

UserFriendService

public interface FriendService

Allows access to instances of Friend. This is responsible for determining the current User as well and ensuring that the associated Friend instances are properly filtered and represented.

Method Summary

Modifier and Type	Method	Description
void	deleteFriend(String friendId)	Deletes the supplied Friend, throwing an exception if the supplied id is not valid.
Friend	getFriend(String friendId)	Gets a single instance of Friend.
Pagination<Friend>	getFriends(int offset, int count)	Gets the listing of Friend with the supplied offset and count.
Pagination<Friend>	getFriends(int offset, int count, String search)	Gets the listing of Friend with the supplied offset, count, and search query.

Method Details

getFriends

Pagination<Friend> getFriends(int offset,
 int count)

Gets the listing of Friend with the supplied offset and count.

Parameters:

offset - the offset

count - the count

Returns:

the list of Friend instances

getFriends

Pagination<Friend> getFriends(int offset,
 int count,
 String search)

Gets the listing of Friend with the supplied offset, count, and search query.

Parameters:

offset - the offset

count - the count

search - the search query

Returns:

the list of Friend instances

getFriend

Friend getFriend(String friendId)

Gets a single instance of Friend. Throws an exception if the supplied Friend is not found.

Parameters:

friendId - the id, as obtained using Friend.getId().

Returns:

the Friend, never null

deleteFriend

void deleteFriend(String friendId)

Deletes the supplied Friend, throwing an exception if the supplied id is not valid.

Parameters:

friendId - the id, as obtained using Friend.getId().