public interface

DashboardService

com.atlassian.bitbucket.dashboard.DashboardService

Class Overview

Provides services for the Personal Dashboards.

Summary

Public Methods
Page<PullRequestSuggestion> suggestPullRequests(SuggestPullRequestsRequest request)
Retrieves a single page of suggestions for pull requests that a user may wish to raise.

Public Methods

public Page<PullRequestSuggestion> suggestPullRequests (SuggestPullRequestsRequest request)

Retrieves a single page of suggestions for pull requests that a user may wish to raise. Such suggestions are based on criteria specified in the request object and for example may be restricted to be based on pushes by a specific user.

Such suggestions are based on ref changes occurring and so contain the ref change that prompted the suggestion plus the time the change event occurred. Changes will be returned in descending order based on the time the change that prompted the suggestion occurred.

Throws
ArgumentValidationException if "limit" contained within the request is less than one or exceeds the maximum the service permits