CheckSuitesService class

Methods

createCheckSuite(RepositorySlug slug, {required String headSha}) → Future<CheckSuite>

By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Set preferences for check suites on a repository". Your GitHub App must have the checks:write permission to create check suites.

getCheckSuite(RepositorySlug slug, {required int checkSuiteId}) → Future<CheckSuite>

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

listCheckSuitesForRef(RepositorySlug slug, {required String ref, int? appId, String? checkName}) → Stream<CheckSuite>

Lists check suites 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 list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reRequestCheckSuite(RepositorySlug slug, {required int checkSuiteId}) → Future<void>

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared. To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

toString() → String

A string representation of this object.

inherited

updatePreferencesForCheckSuites(RepositorySlug slug, {required List<AutoTriggerChecks> autoTriggerChecks}) → Future<List<AutoTriggerChecks>>

Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.