CheckRunsService class

Inheritance

• Object
• Service
• CheckRunsService

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

createCheckRun(RepositorySlug slug, {required String name, required String headSha, String? detailsUrl, String? externalId, CheckRunStatus status = CheckRunStatus.queued, DateTime? startedAt, CheckRunConclusion? conclusion, DateTime? completedAt, CheckRunOutput? output, List<CheckRunAction>? actions}) → Future<CheckRun>

Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

getCheckRun(RepositorySlug slug, {required int checkRunId}) → Future<CheckRun>

Gets a single check run using its checkRunId. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

listAnnotationsInCheckRun(RepositorySlug slug, {required CheckRun checkRun}) → Stream<CheckRunAnnotation>

Lists annotations for a check run. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

listCheckRunsForRef(RepositorySlug slug, {required String ref, String? checkName, CheckRunStatus? status, CheckRunFilter? filter}) → Stream<CheckRun>

Lists check runs for a commit ref. The [ref] can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

listCheckRunsInSuite(RepositorySlug slug, {required int checkSuiteId, String? checkName, CheckRunStatus? status, CheckRunFilter? filter}) → Stream<CheckRun>

Lists check runs for a check suite using its checkSuiteId. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateCheckRun(RepositorySlug slug, CheckRun checkRunToUpdate, {String? name, String? detailsUrl, String? externalId, DateTime? startedAt, CheckRunStatus status = CheckRunStatus.queued, CheckRunConclusion? conclusion, DateTime? completedAt, CheckRunOutput? output, List<CheckRunAction>? actions}) → Future<CheckRun>

Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.

Operators

operator ==(Object other) → bool

The equality operator.

inherited