com.atlassian.confluence.follow
Interface FollowManager

All Known Implementing Classes:

DefaultFollowManager

public interface FollowManager

Manages the followers and followees of a user

Method Summary

void	followUser(ConfluenceUser follower, ConfluenceUser followee) Sets the follower to follow the specified user.
void	followUser(com.atlassian.user.User follower, com.atlassian.user.User followee) Deprecated. since 5.2
java.util.List<java.lang.String>	getFollowers(com.atlassian.user.User user) Returns a list of users that are followers of the specified user
java.util.Set<ConfluenceUser>	getFollowing(ConfluenceUser user) Returns a list of usernames for the users that the specified user is following
java.util.List<java.lang.String>	getFollowing(com.atlassian.user.User user) Deprecated. since 5.2. User getFollowing(com.atlassian.confluence.user.ConfluenceUser) instead.
boolean	isUserFollowing(com.atlassian.user.User follower, com.atlassian.user.User followee) True if the follower is following the followee
void	removeAllConnectionsFor(com.atlassian.user.User user) Removes all connections for this user (as a follower and as a followee).
void	unfollowUser(com.atlassian.user.User follower, com.atlassian.user.User followee) Unsets the follower from following the specified user.

Method Detail

getFollowers

java.util.List<java.lang.String> getFollowers(com.atlassian.user.User user)

Returns a list of users that are followers of the specified user

Parameters:

user - the user to check for followers

Returns:

a list of usernames

getFollowing

java.util.Set<ConfluenceUser> getFollowing(ConfluenceUser user)

Returns a list of usernames for the users that the specified user is following

Parameters:

user - the username

Returns:

a list of usernames

Since:

5.2

getFollowing

@Deprecated
java.util.List<java.lang.String> getFollowing(com.atlassian.user.User user)

Deprecated. since 5.2. User getFollowing(com.atlassian.confluence.user.ConfluenceUser) instead.

Returns a list of usernames for the users that the specified user is following

Parameters:

user - the username

Returns:

a list of usernames

isUserFollowing

boolean isUserFollowing(com.atlassian.user.User follower,
                        com.atlassian.user.User followee)

True if the follower is following the followee

Parameters:

follower - the proposed follower

followee - the proposed followee

Returns:

true if the follower is following the followee

followUser

void followUser(ConfluenceUser follower,
                ConfluenceUser followee)

Sets the follower to follow the specified user. If the follow is alreading following the followee then this method does nothing.

Parameters:

follower - the follower

followee - the new followee

Since:

5.2

followUser

@Deprecated
void followUser(com.atlassian.user.User follower,
                           com.atlassian.user.User followee)

Deprecated. since 5.2

unfollowUser

void unfollowUser(com.atlassian.user.User follower,
                  com.atlassian.user.User followee)

Unsets the follower from following the specified user. If the follow is not following the followee then this method does nothing.

Parameters:

follower - the follower

followee - the new followee

removeAllConnectionsFor

void removeAllConnectionsFor(com.atlassian.user.User user)

Removes all connections for this user (as a follower and as a followee).

Parameters:

user - the user