com.nulabinc.backlog4j.api

Interface UserMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface UserMethods

Executes Backlog User APIs.

Method Summary

Modifier and Type	Method and Description
User	createUser(CreateUserParams params) Creates a user in the space.
User	deleteUser(java.lang.Object numericUserId) Deletes the user in space.
User	getMyself() Returns the own information.
ResponseList<ViewedIssue>	getRecentlyViewedIssues() Returns the recently viewed issues
ResponseList<ViewedIssue>	getRecentlyViewedIssues(OffsetParams params) Returns the recently viewed issues
ResponseList<ViewedProject>	getRecentlyViewedProjects() Returns the recently viewed projects
ResponseList<ViewedProject>	getRecentlyViewedProjects(OffsetParams params) Returns the recently viewed projects
ResponseList<ViewedWiki>	getRecentlyViewedWikis() Returns the recently viewed wikis
ResponseList<ViewedWiki>	getRecentlyViewedWikis(OffsetParams params) Returns the recently viewed wikis
User	getUser(java.lang.Object numericUserId) Returns the user in the space.
ResponseList<Activity>	getUserActivities(java.lang.Object numericUserId) Returns the user recently updates
ResponseList<Activity>	getUserActivities(java.lang.Object numericUserId, ActivityQueryParams queryParams) Returns the user recently updates
Icon	getUserIcon(java.lang.Object numericUserId) Returns the user icon.
ResponseList<User>	getUsers() Returns all the users in the space.
int	getUserStarCount(java.lang.Object numericUserId, GetStarsParams params) Returns the received star count
ResponseList<Star>	getUserStars(java.lang.Object numericUserId) Returns the received stars
ResponseList<Star>	getUserStars(java.lang.Object numericUserId, QueryParams queryParams) Returns the received stars
int	getUserWatchCount(java.lang.Object numericUserId, GetWatchesParams params) Returns the received watch count
ResponseList<Watch>	getUserWatches(java.lang.Object numericUserId) Returns the received watchings

Method Detail

getUsers

ResponseList<User> getUsers()
                     throws BacklogException

Returns all the users in the space.

Returns:

the users in a list

Throws:

BacklogException

getUser

User getUser(java.lang.Object numericUserId)
      throws BacklogException

Returns the user in the space.

Parameters:

numericUserId - the user identifier

Returns:

the User

Throws:

BacklogException

createUser

User createUser(CreateUserParams params)
         throws BacklogException

Creates a user in the space.

Parameters:

params - the creating user parameter

Returns:

the created user

Throws:

BacklogException

deleteUser

User deleteUser(java.lang.Object numericUserId)
         throws BacklogException

Deletes the user in space.

Parameters:

numericUserId - the user identifier

Returns:

the deleted user

Throws:

BacklogException

getMyself

User getMyself()
        throws BacklogException

Returns the own information.

Returns:

the User

Throws:

BacklogException

getUserIcon

Icon getUserIcon(java.lang.Object numericUserId)
          throws BacklogException

Returns the user icon.

Parameters:

numericUserId - the user identifier

Returns:

the Icon

Throws:

BacklogException

getUserActivities

ResponseList<Activity> getUserActivities(java.lang.Object numericUserId)
                                  throws BacklogException

Returns the user recently updates

Parameters:

numericUserId - the user identifier

Returns:

the updates in a list

Throws:

BacklogException

getUserActivities

ResponseList<Activity> getUserActivities(java.lang.Object numericUserId,
                                         ActivityQueryParams queryParams)
                                  throws BacklogException

Returns the user recently updates

Parameters:

numericUserId - the user identifier

queryParams - the query parameters

Returns:

the updates in a list

Throws:

BacklogException

getUserStars

ResponseList<Star> getUserStars(java.lang.Object numericUserId)
                         throws BacklogException

Returns the received stars

Parameters:

numericUserId - the user identifier

Returns:

the stars in a list

Throws:

BacklogException

getUserStars

ResponseList<Star> getUserStars(java.lang.Object numericUserId,
                                QueryParams queryParams)
                         throws BacklogException

Returns the received stars

Parameters:

numericUserId - the user identifier

queryParams - the query parameters

Returns:

the stars in a list

Throws:

BacklogException

getUserStarCount

int getUserStarCount(java.lang.Object numericUserId,
                     GetStarsParams params)
              throws BacklogException

Returns the received star count

Parameters:

numericUserId - the user identifier

params - star count parameters

Returns:

the count of received star

Throws:

BacklogException

getRecentlyViewedIssues

ResponseList<ViewedIssue> getRecentlyViewedIssues()
                                           throws BacklogException

Returns the recently viewed issues

Returns:

the issues in a list

Throws:

BacklogException

getRecentlyViewedIssues

ResponseList<ViewedIssue> getRecentlyViewedIssues(OffsetParams params)
                                           throws BacklogException

Returns the recently viewed issues

Parameters:

params - the offset parameters

Returns:

the issues in a list

Throws:

BacklogException

getRecentlyViewedProjects

ResponseList<ViewedProject> getRecentlyViewedProjects()
                                               throws BacklogException

Returns the recently viewed projects

Returns:

the projects in a list

Throws:

BacklogException

getRecentlyViewedProjects

ResponseList<ViewedProject> getRecentlyViewedProjects(OffsetParams params)
                                               throws BacklogException

Returns the recently viewed projects

Parameters:

params - the offset parameters

Returns:

the projects in a list

Throws:

BacklogException

getRecentlyViewedWikis

ResponseList<ViewedWiki> getRecentlyViewedWikis()
                                         throws BacklogException

Returns the recently viewed wikis

Returns:

the wikis in a list

Throws:

BacklogException

getRecentlyViewedWikis

ResponseList<ViewedWiki> getRecentlyViewedWikis(OffsetParams params)
                                         throws BacklogException

Returns the recently viewed wikis

Parameters:

params - the offset parameters

Returns:

the wikis in a list

Throws:

BacklogException

getUserWatchCount

int getUserWatchCount(java.lang.Object numericUserId,
                      GetWatchesParams params)
               throws BacklogException

Returns the received watch count

Parameters:

numericUserId - the user identifier

params - watch count parameters

Returns:

the count of received watch

Throws:

BacklogException

getUserWatches

ResponseList<Watch> getUserWatches(java.lang.Object numericUserId)
                            throws BacklogException

Returns the received watchings

Parameters:

numericUserId - the user identifier

Returns:

the watchings in a list

Throws:

BacklogException