PullRequestsService class

The PullRequestsService handles communication with pull request methods of the GitHub API.

API docs: https://developer.github.com/v3/pulls/

Inheritance

• Object
• Service
• PullRequestsService

Constructors

PullRequestsService(GitHub github)

Properties

github → GitHub

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

create(RepositorySlug slug, CreatePullRequest request) → Future<PullRequest>

Creates a Pull Request based on the given request.

createComment(RepositorySlug slug, int number, CreatePullRequestComment comment) → Future<PullRequestComment>

Creates a new pull request comment.

createReview(RepositorySlug slug, CreatePullRequestReview review) → Future<PullRequestReview>

Creates a new pull request comment.

edit(RepositorySlug slug, int number, {String? title, String? body, String? state, String? base}) → Future<PullRequest>

Edit a pull request.

get(RepositorySlug slug, int number) → Future<PullRequest>

Fetches a single pull request.

isMerged(RepositorySlug slug, int number) → Future<bool>

list(RepositorySlug slug, {int? pages, String? base, String direction = 'desc', String? head, String sort = 'created', String state = 'open'}) → Stream<PullRequest>

Fetches several pull requests.

listComments(RepositorySlug slug) → Stream<PullRequestComment>

Lists all comments on all pull requests for the repository.

listCommentsByPullRequest(RepositorySlug slug, int number) → Stream<PullRequestComment>

Lists all comments on the specified pull request.

listCommits(RepositorySlug slug, int number) → Stream<RepositoryCommit>

Lists the commits in a pull request.

listFiles(RepositorySlug slug, int number) → Stream<PullRequestFile>

Lists the files in a pull request.

listReviews(RepositorySlug slug, int number) → Stream<PullRequestReview>

Lists the reviews for a pull request.

merge(RepositorySlug slug, int number, {String? message, MergeMethod mergeMethod = MergeMethod.merge, String? requestSha}) → Future<PullRequestMerge>

Merge a pull request (Merge Button).

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited