IssuesService class

The IssuesService handles communication with issues related methods of the GitHub API.

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

Inheritance

• Object
• Service
• IssuesService

Constructors

IssuesService(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

addLabelsToIssue(RepositorySlug slug, int issueNumber, List<String> labels) → Future<List<IssueLabel>>

Adds labels to an issue.

create(RepositorySlug slug, IssueRequest issue) → Future<Issue>

Create an issue.

createComment(RepositorySlug slug, int issueNumber, String body) → Future<IssueComment>

Creates a new comment on the specified issue

createLabel(RepositorySlug slug, String name, String color) → Future<IssueLabel>

Creates a new label on the specified repository.

createMilestone(RepositorySlug slug, CreateMilestone request) → Future<Milestone>

Creates a new milestone on the specified repository.

deleteComment(RepositorySlug slug, int id) → Future<bool>

Deletes an issue comment.

deleteLabel(RepositorySlug slug, String name) → Future<bool>

Deletes a label.

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

Deletes a milestone.

edit(RepositorySlug slug, int issueNumber, IssueRequest issue) → Future<Issue>

Edit an issue.

editLabel(RepositorySlug slug, String name, String color) → Future<IssueLabel>

Edits a label.

get(RepositorySlug slug, int issueNumber) → Future<Issue>

Get an issue.

getComment(RepositorySlug slug, int id) → Future<IssueComment>

Fetches the specified issue comment.

getLabel(RepositorySlug slug, String name) → Future<IssueLabel>

Fetches a single label.

isAssignee(RepositorySlug slug, String repoName) → Future<bool>

Checks if a user is an assignee for the specified repository.

listAll({int? milestoneNumber, String? state, String? direction, String? sort, DateTime? since, int? perPage, List<String>? labels}) → Stream<Issue>

List all issues across all the authenticated user’s visible repositories including owned repositories, member repositories, and organization repositories

listAssignees(RepositorySlug slug) → Stream<User>

Lists all available assignees (owners and collaborators) to which issues may be assigned.

listByOrg(String org, {int? milestoneNumber, String? state, String? direction, String? sort, DateTime? since, int? perPage, List<String>? labels}) → Stream<Issue>

List all issues for a given organization for the authenticated user.

listByRepo(RepositorySlug slug, {int? milestoneNumber, String? state, String? direction, String? sort, DateTime? since, int? perPage, List<String>? labels}) → Stream<Issue>

Lists the issues for the specified repository.

listByUser({int? milestoneNumber, String? state, String? direction, String? sort, DateTime? since, int? perPage, List<String>? labels}) → Stream<Issue>

List all issues across owned and member repositories for the authenticated user.

listCommentsByIssue(RepositorySlug slug, int issueNumber) → Stream<IssueComment>

Lists comments on the specified issue.

listCommentsByRepo(RepositorySlug slug) → Stream<IssueComment>

Lists all comments in a repository.

listLabels(RepositorySlug slug) → Stream<IssueLabel>

Lists all labels for a repository.

listLabelsByIssue(RepositorySlug slug, int issueNumber) → Stream<IssueLabel>

Lists all labels for an issue.

listMilestones(RepositorySlug slug) → Stream<Milestone>

Lists all milestones for a repository.

listReactions(RepositorySlug slug, int issueNumber, {ReactionType? content}) → Stream<Reaction>

Gets a stream of Reactions for an issue. The optional content param let's you filter the request for only reactions of that type. WARNING: ReactionType.plusOne and ReactionType.minusOne currently do not work and will throw an exception is used. All others without + or - signs work fine to filter.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeAllLabelsForIssue(RepositorySlug slug, int issueNumber) → Future<bool>

Removes all labels for an issue.

removeLabelForIssue(RepositorySlug slug, int issueNumber, String label) → Future<bool>

Removes a label for an issue.

replaceLabelsForIssue(RepositorySlug slug, int issueNumber, List<String> labels) → Future<List<IssueLabel>>

Replaces all labels for an issue.

toString() → String

A string representation of this object.

inherited

updateComment(RepositorySlug slug, int id, String body) → Future<IssueComment>

Update an issue comment.

Operators

operator ==(Object other) → bool

The equality operator.

inherited