list method

Future<ListChannelsResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists the channels for the specified site.

All sites have a default live channel.

Request parameters:

parent - Required. The site for which to list channels, in the format: sites/SITE_ID Value must have pattern ^sites/\[^/\]+$.

pageSize - The maximum number of channels to return. The service may return a lower number if fewer channels exist than this maximum number. If unspecified, defaults to 10. The maximum value is 100; values above 100 will be coerced to 100.

pageToken - A token from a previous call to ListChannels that tells the server where to resume listing.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListChannelsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListChannelsResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1beta1/' + core.Uri.encodeFull('$parent') + '/channels';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListChannelsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}