public static interface

NavBuilder.PullRequest

implements NavBuilder.Builder<B extends Builder>
com.atlassian.stash.nav.NavBuilder.PullRequest

Class Overview

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

Summary

Public Methods
@Nonnull NavBuilder.PullRequestActivity activity(long activityId)
View the activities of the pull request.
@Deprecated @Nonnull NavBuilder.Changeset changeset(String id)
This method is deprecated. in 3.8 for removal in 5.0. All things "changeset" are being renamed to "commit", the more common term for the data they represent. Due to the significant number of touchpoints, the deprecated classes and interfaces will be left in for an entire major release cycle, rather than being removed in 4.0. Use commit(String) instead.
@Nonnull NavBuilder.PullRequestComment comment(long commentId)
View the comments added to the pull request.
@Nonnull NavBuilder.PullRequestCommit commit(String commitId)
View a specific commit within a pull request.
PagedBuilder<?> commits()
View the commits to be merged by a pull request.
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.
PagedBuilder<?> unwatch()
Remove the current user as a watcher for the pull request.
[Expand]
Inherited Methods
From interface com.atlassian.stash.nav.NavBuilder.Builder

Public Methods

@Nonnull public NavBuilder.PullRequestActivity activity (long activityId)

View the activities of the pull request.

Parameters
activityId The unique identifier of the activity
Returns

@Deprecated @Nonnull public NavBuilder.Changeset changeset (String id)

This method is deprecated.
in 3.8 for removal in 5.0. All things "changeset" are being renamed to "commit", the more common term for the data they represent. Due to the significant number of touchpoints, the deprecated classes and interfaces will be left in for an entire major release cycle, rather than being removed in 4.0. Use commit(String) instead.

View a specific commit within a pull request.

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

Parameters
id the changeset ID
Returns
  • a builder which allows deep linking to a specific path within the changeset

@Nonnull public NavBuilder.PullRequestComment comment (long commentId)

View the comments added to the pull request.

Parameters
commentId The unique identifier of the comment
Returns

@Nonnull public NavBuilder.PullRequestCommit commit (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

public PagedBuilder<?> commits ()

View the commits to be merged by a pull request.

Returns
  • a builder which allows linking to a page of commits

public Builder<?> diff ()

View the pull request's diff.

Returns
  • a builder which allows linking to the diff

public 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

public 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