com.nulabinc.backlog4j.api

Interface PullRequestMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface PullRequestMethods

Executes Backlog Pull Request APIs.

Method Summary

Modifier and Type	Method and Description
PullRequest	addPullRequest(AddPullRequestParams params) Add a pull request.
PullRequestComment	addPullRequestComment(AddPullRequestCommentParams params) Add a comment on the pull request.
Attachment	deletePullRequestAttachment(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, java.lang.Object number, java.lang.Object attachmentId) Deletes the attachment file on the pull request.
AttachmentData	downloadPullRequestAttachment(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, java.lang.Object number, java.lang.Object attachmentId) Returns the attachment file data on the pull request.
PullRequest	getPullRequest(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, java.lang.Object number) Returns the pull request.
ResponseList<Attachment>	getPullRequestAttachments(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, java.lang.Object number) Returns the pull request attachment list.
int	getPullRequestCommentCount(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, java.lang.Object number) Returns the pull request comment count.
ResponseList<PullRequestComment>	getPullRequestComments(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, java.lang.Object number, QueryParams params) Returns the comments of pull requests.
int	getPullRequestCount(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName) Returns the count of the pull requests.
int	getPullRequestCount(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, PullRequestQueryParams params) Returns the count of the pull requests.
ResponseList<PullRequest>	getPullRequests(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName) Returns the pull requests of the repository.
ResponseList<PullRequest>	getPullRequests(java.lang.Object projectIdOrKey, java.lang.Object repoIdOrName, PullRequestQueryParams params) Returns the pull requests of the repository.
PullRequest	updatePullRequest(UpdatePullRequestParams params) Update a pull request.
PullRequestComment	updatePullRequestComment(UpdatePullRequestCommentParams params) Updates the pull request comment.

Method Detail

getPullRequests

ResponseList<PullRequest> getPullRequests(java.lang.Object projectIdOrKey,
                                          java.lang.Object repoIdOrName)
                                   throws BacklogException

Returns the pull requests of the repository.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

Returns:

the git pull requests in a list.

Throws:

BacklogException

getPullRequests

ResponseList<PullRequest> getPullRequests(java.lang.Object projectIdOrKey,
                                          java.lang.Object repoIdOrName,
                                          PullRequestQueryParams params)
                                   throws BacklogException

Returns the pull requests of the repository.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

params - the finding pull request parameters.

Returns:

the git pull requests in a list.

Throws:

BacklogException

getPullRequestCount

int getPullRequestCount(java.lang.Object projectIdOrKey,
                        java.lang.Object repoIdOrName)
                 throws BacklogException

Returns the count of the pull requests.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

Returns:

the git pull request.

Throws:

BacklogException

getPullRequestCount

int getPullRequestCount(java.lang.Object projectIdOrKey,
                        java.lang.Object repoIdOrName,
                        PullRequestQueryParams params)
                 throws BacklogException

Returns the count of the pull requests.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

params - the finding pull request parameters.

Returns:

the git pull request.

Throws:

BacklogException

addPullRequest

PullRequest addPullRequest(AddPullRequestParams params)
                    throws BacklogException

Add a pull request.

Parameters:

params - the pull request adding parameters

Returns:

the git pull request.

Throws:

BacklogException

updatePullRequest

PullRequest updatePullRequest(UpdatePullRequestParams params)
                       throws BacklogException

Update a pull request.

Parameters:

params - the pull request updating parameters

Returns:

the git pull request.

Throws:

BacklogException

getPullRequest

PullRequest getPullRequest(java.lang.Object projectIdOrKey,
                           java.lang.Object repoIdOrName,
                           java.lang.Object number)
                    throws BacklogException

Returns the pull request.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

number - the pull request identifier

Returns:

the git pull requests in a list.

Throws:

BacklogException

getPullRequestComments

ResponseList<PullRequestComment> getPullRequestComments(java.lang.Object projectIdOrKey,
                                                        java.lang.Object repoIdOrName,
                                                        java.lang.Object number,
                                                        QueryParams params)
                                                 throws BacklogException

Returns the comments of pull requests.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

number - the pull request identifier

params - the finding pull request comments parameters.

Returns:

the git pull requests in a list.

Throws:

BacklogException

addPullRequestComment

PullRequestComment addPullRequestComment(AddPullRequestCommentParams params)
                                  throws BacklogException

Add a comment on the pull request.

Parameters:

params - the adding pull request comment parameters.

Returns:

the added pull request comment.

Throws:

BacklogException

getPullRequestCommentCount

int getPullRequestCommentCount(java.lang.Object projectIdOrKey,
                               java.lang.Object repoIdOrName,
                               java.lang.Object number)
                        throws BacklogException

Returns the pull request comment count.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

number - the pull request identifier

Returns:

the pull request comment count

Throws:

BacklogException

updatePullRequestComment

PullRequestComment updatePullRequestComment(UpdatePullRequestCommentParams params)
                                     throws BacklogException

Updates the pull request comment.

Parameters:

params - the pull request comment updating parameters

Returns:

the pull request comment.

Throws:

BacklogException

getPullRequestAttachments

ResponseList<Attachment> getPullRequestAttachments(java.lang.Object projectIdOrKey,
                                                   java.lang.Object repoIdOrName,
                                                   java.lang.Object number)
                                            throws BacklogException

Returns the pull request attachment list.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

number - the pull request identifier

Returns:

the pull request attachment list

Throws:

BacklogException

downloadPullRequestAttachment

AttachmentData downloadPullRequestAttachment(java.lang.Object projectIdOrKey,
                                             java.lang.Object repoIdOrName,
                                             java.lang.Object number,
                                             java.lang.Object attachmentId)
                                      throws BacklogException

Returns the attachment file data on the pull request.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

number - the pull request identifier

attachmentId - the pull request attachment identifier

Returns:

the attachment file data

Throws:

BacklogException

deletePullRequestAttachment

Attachment deletePullRequestAttachment(java.lang.Object projectIdOrKey,
                                       java.lang.Object repoIdOrName,
                                       java.lang.Object number,
                                       java.lang.Object attachmentId)
                                throws BacklogException

Deletes the attachment file on the pull request.

Parameters:

projectIdOrKey - the project identifier

repoIdOrName - the repository name

number - the pull request identifier

attachmentId - the pull request attachment identifier

Returns:

the Attachment

Throws:

BacklogException