com.nulabinc.backlog4j.api

Interface SpaceMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface SpaceMethods

Executes Backlog Space APIs.

Method Summary

Modifier and Type	Method and Description
Space	getSpace() Returns the Space.
ResponseList<Activity>	getSpaceActivities() Returns the activities in the space.
ResponseList<Activity>	getSpaceActivities(ActivityQueryParams params) Returns the activities in the space.
DiskUsage	getSpaceDiskUsage() Returns the disk usage of the project.
Icon	getSpaceIcon() Returns the space icon.
SpaceNotification	getSpaceNotification() Returns the space information.
Attachment	postAttachment(AttachmentData attachmentData) Posts the attachment file for issue or wiki.
SpaceNotification	updateSpaceNotification(java.lang.String content) Updates the space information.

Method Detail

getSpace

Space getSpace()
        throws BacklogException

Returns the Space.

Returns:

the Space

Throws:

BacklogException

getSpaceActivities

ResponseList<Activity> getSpaceActivities()
                                   throws BacklogException

Returns the activities in the space.

Returns:

the activities in a list

Throws:

BacklogException

getSpaceActivities

ResponseList<Activity> getSpaceActivities(ActivityQueryParams params)
                                   throws BacklogException

Returns the activities in the space.

Parameters:

params - the query parameters

Returns:

the activities in a list

Throws:

BacklogException

getSpaceIcon

Icon getSpaceIcon()
           throws BacklogException

Returns the space icon.

Returns:

the Icon

Throws:

BacklogException

getSpaceNotification

SpaceNotification getSpaceNotification()
                                throws BacklogException

Returns the space information.

Returns:

the SpaceNotification

Throws:

BacklogException

updateSpaceNotification

SpaceNotification updateSpaceNotification(java.lang.String content)
                                   throws BacklogException

Updates the space information.

Parameters:

content - information

Returns:

the updated space information

Throws:

BacklogException

getSpaceDiskUsage

DiskUsage getSpaceDiskUsage()
                     throws BacklogException

Returns the disk usage of the project.

Returns:

the DiskUsage

Throws:

BacklogException

postAttachment

Attachment postAttachment(AttachmentData attachmentData)
                   throws BacklogException

Posts the attachment file for issue or wiki.

Parameters:

attachmentData - the attachment file data

Returns:

the posted attachment file

Throws:

BacklogException