listCheckRunsInSuite method
Stream<CheckRun>
listCheckRunsInSuite(
- RepositorySlug slug, {
- required int checkSuiteId,
- String? checkName,
- CheckRunStatus? status,
- CheckRunFilter? filter,
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.
checkName
: returns check runs with the specified name.status
: returns check runs with the specified status.filter
: filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all. Default: latest.
API docs: https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite
Implementation
Stream<CheckRun> listCheckRunsInSuite(
RepositorySlug slug, {
required int checkSuiteId,
String? checkName,
CheckRunStatus? status,
CheckRunFilter? filter,
}) {
ArgumentError.checkNotNull(checkSuiteId);
return PaginationHelper(github).objects<Map<String, dynamic>, CheckRun>(
'GET',
'repos/$slug/check-suites/$checkSuiteId/check-runs',
CheckRun.fromJson,
statusCode: StatusCodes.OK,
preview: _previewHeader,
params: createNonNullMap({
'check_name': checkName,
'status': status,
'filter': filter,
}),
arrayKey: 'check_runs',
);
}