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:

Methods

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

Source:
Returns:
Type
bitbucket/util/navbuilder.RestAdminBuilder

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

Source:
Returns:
Type
bitbucket/util/navbuilder.Builder

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

Source:
Returns:
Type
bitbucket/util/navbuilder.Builder

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

Source:
Returns:
Type
bitbucket/util/navbuilder.RestHookPluginsBuilder

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

Source:
Returns:
Type
bitbucket/util/navbuilder.RestMarkupBuilder

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

Source:
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:
Returns:
Type
bitbucket/util/navbuilder.RestProjectBuilder

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

Source:
Returns:
Type
bitbucket/util/navbuilder.Builder

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

Shorthand for .project(pullRequest.toRef.repository.project).repository(pullRequest.toRef.repository).pullRequest(pullRequest)

Parameters:
Name Type Description
pullRequest Object

The full pull request object

Source:
Returns:
Type
bitbucket/util/navbuilder.RestRepositoryBuilder

raw() → {bitbucket/util/navbuilder.RestRawContentBuilder}

Source:
Returns:
Type
bitbucket/util/navbuilder.RestRawContentBuilder

Add related to url.

Source:
Returns:
Type
bitbucket/util/navbuilder.RestRepositoryBuilder

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

Shorthand for .project(repository.project).repository(repository)

Parameters:
Name Type Description
repository Object

The full repository object

Source:
Returns:
Type
bitbucket/util/navbuilder.RestRepositoryBuilder

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:
Returns:
Type
bitbucket/util/navbuilder.Builder | bitbucket/util/navbuilder.RestUserBuilder