PullRequestService

Adds a general comment to the pull request.

Adds a line comment to a diff in a pull request.

Adds a file-level comment to the pull request.

Adds a reply to a comment

Allows a user to give their approval to a pull request. If they aren't already a participant of the pull request they are made one first. If the user has already already provided their approval this operation has no effect. A user may only approve a pull request which is in open.

Assigns a participant to an explicit role in pull request. Currently only reviewers may be assigned. If the user is not yet a participant in the pull request, they are made one and assigned the supplied role. If the user is already a participant in the pull request, their previous role is replaced with the supplied role unless they are already assigned the AUTHOR role which cannot be changed and will result in an UnmodifiablePullRequestRoleException being thrown.

Retrieves a flag indicating whether the specified pull request can be merged by the system or must be manually merged by a user.

Even if this method returns true, there are still a variety of reasons for which merging may fail, including but not limited to:

• The version supplied when merging is out of date
• Additional changes have been pushed to the pull request's target branch and the pull request has not yet been updated accordingly

Note: If the specified pull request is declined or MERGED, this method will always return false.

Counts the number of pull requests which match the specified search criteria.

Counts the number of commits a pull request has.

Counts the number of commits a pull request has.

Counts the number of pull requests where the specified user is a participant. The search criteria can optionally be narrowed by specifying the state the pull request should be in.

Counts the number of pull request to or from a given repository depending on the direction passed in. The search criteria can optionally be narrowed by specifying the state the pull request should be in.

An explanation of the directions:

• INCOMING counts pull requests to the specified repository
• OUTGOING counts pull requests from the specified repository

Counts the number of tasks in a pull request.

Creates a pull request from the supplied repository and branch to the supplied repository and branch with the given title and description.

At present Stash only supports pull requests between branches of the same repository. Supplying two different repositories will result in an exception being thrown.

Events raised:

• PullRequestOpenRequestedEvent
• PullRequestOpenedEvent

Declines a pull request. The pull request must be open or an exception is thrown. The expected version of the pull request must be supplied to ensure the client is not operating on stale information.

Declines a pull request. The pull request must be open or an exception is thrown. The expected version of the pull request must be supplied to ensure the client is not operating on stale information.

Deletes a pull request comment

Finds a single page of pull request in the specified state where the specified user is a participant.

Get diff anchors for a given pull request and a path affected by that pull request.

Retrieves a page of the activities for a given pull request.

Retrieves the specified activities of the given pull request.

Retrieves the page of activities that start with an entity (given its type and id) for the given pull request.

Entity types currently accepted:

• ACTIVITY to search for the page of activities starting with the supplied activity
• COMMENT to search for the page of activities starting with the activity of the supplied comment. If the comment is not a root comment, the comment's root's activity is used.

Retrieves a pull request by its ID, within the specified repository.

Retrieves a page of the changesets for a given pull request.

Retrieves a comment for the given comment id and pull request id.

Retrieves a page of the commits for a given pull request.

Retrieves a page of the participants for a given pull request.

Merges a pull request. The pull request must be open or an exception is thrown. The expected version of the pull request must be supplied to ensure the client is not operating on stale information.

Merges a pull request. The pull request must be open or an exception is thrown. The expected version of the pull request must be supplied to ensure the client is not operating on stale information.

Reopens a pull request. The pull request must be declined or an exception is thrown. The expected version of the pull request must be supplied to ensure the client is not operating on stale information.

Finds a single page of pull requests depending on the request passed in.

Finds a single page of pull request activities depending on the request passed in.

Finds a single page of @{link Task tasks} belonging to this pull request depending on the request passed in.

Streams changes for the specified PullRequest to the provided ChangeCallback.

Note: Internal hard limits are applied to the number of changes which will be returned. When changes are truncated for exceeding those limits, it will be signalled to the callback.

Streams commits for the specified pull request.

Streams commits for the specified pull request.

Streams the Diff for the specified file path within the PullRequest to the provided DiffContentCallback. Comment anchors will be offered to the callback prior to streaming the diff, allowing them to be merged into the diff output as desired.

If the Change indicated the path being diffed was moved/renamed or copied, the srcPath should also be provided. Failure to provide both paths may result in an incorrect diff in some SCMs.

Note: Internal hard limits are applied to the diff being streamed, limiting the number of lines that can be returned. When a diff is truncated for exceeding those limits, it will be signalled to the callback.

Unassigns a participant from any explicit role they may have been given in a pull request. An explicit role is one other than PARTICIPANT. Currently the only explicit role that may be unassigned is the REVIEWER role as the AUTHOR role is fixed. An attempt to unassign a participant from this role will result in an UnmodifiablePullRequestRoleException being thrown. If the participant has no explicit role this method has no effect. Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered.

Removes the current user as a watcher of the given pull request.

Updates a pull request's title and description.

This method will fire:

• PullRequestUpdatedEvent to inform listeners that the title or description have changed
• PullRequestRolesUpdatedEvent to inform listeners of any reviewers assigned or unassigned from this role
• PullRequestParticipantsAddedEvent to inform listeners of any users who have participated in the pull request for the first time
• PullRequestRescopedEvent to inform listeners the the destination branch has been updated and rescope has occurred

Updates the pull request comment's text

Adds the current user as a watcher of the given pull request.

Allows the current user to withdraw their approval of a pull request. The user must already be a participant of the pull request else an exception is thrown. If the user has already withdrawn their approval this operation has no effect. A participant may only withdraw approval for a pull request if it open.