com.atlassian.confluence.api.service.network
Interface NetworkService

All Known Implementing Classes:
NetworkServiceImpl

@ExperimentalApi
public interface NetworkService

Provides methods for reading Confluence network graph.

Since:
5.6

Method Summary
 PageResponse<User> getFollowers(com.atlassian.sal.api.user.UserKey userKey, PageRequest request)
          Gets the users who are following the given user.
 PageResponse<User> getFollowing(com.atlassian.sal.api.user.UserKey userKey, PageRequest request)
          Gets the users that the given user is following.
 

Method Detail

getFollowers

PageResponse<User> getFollowers(com.atlassian.sal.api.user.UserKey userKey,
                                PageRequest request)
                                throws NotFoundException
Gets the users who are following the given user.

Parameters:
userKey - - the key of the user being followed
Returns:
a page containing users who are following the given user.
Throws:
NotFoundException - if the given user does not exist
Since:
5.6

getFollowing

PageResponse<User> getFollowing(com.atlassian.sal.api.user.UserKey userKey,
                                PageRequest request)
                                throws NotFoundException
Gets the users that the given user is following.

Parameters:
userKey - - the key of the user following other users.
Returns:
a page containing users followed by the given user.
Throws:
NotFoundException - if the given user does not exist


Copyright © 2003–2015 Atlassian. All rights reserved.