com.atlassian.bitbucket.nav

Interface NavBuilder.PullRequest

All Superinterfaces:

NavBuilder.Builder<NavBuilder.PullRequest>

Enclosing interface:

NavBuilder

public static interface NavBuilder.PullRequest
extends NavBuilder.Builder<NavBuilder.PullRequest>

The builder for urls of the form /projects/PROJ/repos/REPO/pull-requests/ID/...

Method Summary

Modifier and Type	Method and Description
NavBuilder.PullRequestActivity	activity(long activityId) View the activities of the pull request.
NavBuilder.PullRequestBuilds	builds() View the builds for that pull request.
NavBuilder.PullRequestComment	comment(long commentId) View the comments added to the pull request.
NavBuilder.PullRequestCommit	commit(String commitId) View a specific commit within a pull request.
NavBuilder.PagedBuilder<?>	commits() View the commits to be merged by a pull request.
NavBuilder.Builder<?>	diff() View the pull request's diff.
NavBuilder.PullRequestOverview	overview() View the pull request's overview, which displays snippets for activities which have been performed on the pull request as well its description.
NavBuilder.Builder<?>	unreviewed() View the pull request diff, and the unreviewed changes for the current user, if they exist.
NavBuilder.PagedBuilder<?>	unwatch() Remove the current user as a watcher for the pull request.

Methods inherited from interface com.atlassian.bitbucket.nav.NavBuilder.Builder

buildAbsolute, buildConfigured, buildRelative, buildRelNoContext, withParam

Method Detail

activity

@Nonnull
NavBuilder.PullRequestActivity activity(long activityId)

View the activities of the pull request.

Parameters:

activityId - The unique identifier of the activity

Returns:

NavBuilder.PullRequestActivity a builder used to construct URLs for activities

builds

@Nonnull
NavBuilder.PullRequestBuilds builds()

View the builds for that pull request.

Returns:

a NavBuilder.PullRequestBuilds builder used to construct URLs for builds

comment

@Nonnull
NavBuilder.PullRequestComment comment(long commentId)

View the comments added to the pull request.

Parameters:

commentId - The unique identifier of the comment

Returns:

a NavBuilder.PullRequestComment builder used to construct URLs for comments

commit

@Nonnull
NavBuilder.PullRequestCommit commit(@Nonnull
                                             String commitId)

View a specific commit within a pull request.

Unlike repository commits, pull request commits must be specified by ID. Ref names like "master" do not make sense in this context.

Parameters:

commitId - the commit ID to build URLs for

Returns:

a builder which allows deep linking to a specific path within the commit

commits

NavBuilder.PagedBuilder<?> commits()

View the commits to be merged by a pull request.

Returns:

a builder which allows linking to a page of commits

diff

NavBuilder.Builder<?> diff()

View the pull request's diff.

Returns:

a builder which allows linking to the diff

overview

NavBuilder.PullRequestOverview overview()

View the pull request's overview, which displays snippets for activities which have been performed on the pull request as well its description.

Returns:

a builder which allows linking to the overview

unreviewed

NavBuilder.Builder<?> unreviewed()

View the pull request diff, and the unreviewed changes for the current user, if they exist.

Returns:

a builder which allows linking to the diff of the unreviewed changes

Since:

4.10

unwatch

NavBuilder.PagedBuilder<?> unwatch()

Remove the current user as a watcher for the pull request.

Returns:

a builder which allows building links to stop watching the pull request