com.atlassian.confluence.follow
Interface FollowManager

All Known Subinterfaces:
FollowManagerInternal
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
 List<String> getFollowers(com.atlassian.user.User user)
          Deprecated. since 5.6. Use the new paged alternatives in FollowManagerInternal, or consider using the new NetworkService.
 Set<ConfluenceUser> getFollowing(ConfluenceUser user)
          Deprecated. since 5.6. Use the new paged alternatives in FollowManagerInternal, or consider using the new NetworkService.
 List<String> getFollowing(com.atlassian.user.User user)
          Deprecated. since 5.2. Use the new paged alternatives in FollowManagerInternal, or consider using the new NetworkService.
 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

@Deprecated
List<String> getFollowers(com.atlassian.user.User user)
Deprecated. since 5.6. Use the new paged alternatives in FollowManagerInternal, or consider using the new NetworkService.

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
See Also:
com.atlassian.confluence.internal.follow.FollowManagerInternal#getFollowers(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.api.impl.pagination.PaginationQuery)}, com.atlassian.confluence.api.service.network.NetworkService}

getFollowing

@Deprecated
Set<ConfluenceUser> getFollowing(ConfluenceUser user)
Deprecated. since 5.6. Use the new paged alternatives in FollowManagerInternal, or consider using the new NetworkService.

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
See Also:
com.atlassian.confluence.internal.follow.FollowManagerInternal#getFollowing(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.api.impl.pagination.PaginationQuery)}, com.atlassian.confluence.api.service.network.NetworkService}

getFollowing

@Deprecated
List<String> getFollowing(com.atlassian.user.User user)
Deprecated. since 5.2. Use the new paged alternatives in FollowManagerInternal, or consider using the new NetworkService.

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

Parameters:
user - the username
Returns:
a list of usernames
See Also:
com.atlassian.confluence.internal.follow.FollowManagerInternal#getFollowing(com.atlassian.confluence.user.ConfluenceUser, com.atlassian.confluence.api.impl.pagination.PaginationQuery)}, com.atlassian.confluence.api.service.network.NetworkService}

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


Copyright © 2003–2015 Atlassian. All rights reserved.