Class: RestBuilder

bitbucket/util/navbuilder. RestBuilder

new RestBuilder()

REST URL bitbucket/util/navbuilder.Builder.

NOTE: The constructor is not exposed. A new instance can be created through the Builder API.

Source:

util/navbuilder.js, line 752

Methods

admin() → {bitbucket/util/navbuilder.RestAdminBuilder}

Source:

util/navbuilder.js, line 921

Returns:

Type: bitbucket/util/navbuilder.RestAdminBuilder

allRepos() → {bitbucket/util/navbuilder.Builder}

Source:

util/navbuilder.js, line 917

Returns:

Type: bitbucket/util/navbuilder.Builder

currentProject() → {bitbucket/util/navbuilder.RestProjectBuilder}

Source:

util/navbuilder.js, line 792

Returns:

Type: bitbucket/util/navbuilder.RestProjectBuilder

currentPullRequest() → {bitbucket/util/navbuilder.RestPullRequestBuilder}

Source:

util/navbuilder.js, line 802

Returns:

Type: bitbucket/util/navbuilder.RestPullRequestBuilder

currentRepo() → {bitbucket/util/navbuilder.RestRepositoryBuilder}

Source:

util/navbuilder.js, line 797

Returns:

Type: bitbucket/util/navbuilder.RestRepositoryBuilder

groups() → {bitbucket/util/navbuilder.Builder}

Source:

util/navbuilder.js, line 905

Returns:

Type: bitbucket/util/navbuilder.Builder

hooks() → {bitbucket/util/navbuilder.RestHookPluginsBuilder}

Source:

util/navbuilder.js, line 912

Returns:

Type: bitbucket/util/navbuilder.RestHookPluginsBuilder

markup() → {bitbucket/util/navbuilder.RestMarkupBuilder}

Source:

util/navbuilder.js, line 806

Returns:

Type: bitbucket/util/navbuilder.RestMarkupBuilder

profile() → {bitbucket/util/navbuilder.RestProfileBuilder}

Source:

util/navbuilder.js, line 831

Returns:

Type: bitbucket/util/navbuilder.RestProfileBuilder

project(key) → {bitbucket/util/navbuilder.RestProjectBuilder}

Parameters:

Name	Type	Description
`key`	string	The key of the project to form URLs for.

Source:

util/navbuilder.js, line 787

Returns:

Type: bitbucket/util/navbuilder.RestProjectBuilder

users(userSlug) → {bitbucket/util/navbuilder.Builder|bitbucket/util/navbuilder.RestUserBuilder}

Parameters:

Name	Type	Argument	Description
`userSlug`	string	<optional>	If provided, a RestUserBuilder will be returned. Otherwise, a regular builder is returned.

Source:

util/navbuilder.js, line 876

Returns:

Type: bitbucket/util/navbuilder.Builder | bitbucket/util/navbuilder.RestUserBuilder