list method

Future<CaptionListResponse> list(
  1. List<String> part,
  2. String videoId, {
  3. List<String>? id,
  4. String? onBehalfOf,
  5. String? onBehalfOfContentOwner,
  6. String? $fields,
})

Retrieves a list of resources, possibly filtered.

Request parameters:

part - The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

videoId - Returns the captions for the specified video.

id - Returns the captions with the given IDs for Stubby or Apiary.

onBehalfOf - ID of the Google+ Page for the channel that the request is on behalf of.

onBehalfOfContentOwner - Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

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

Completes with a CaptionListResponse.

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<CaptionListResponse> list(
  core.List<core.String> part,
  core.String videoId, {
  core.List<core.String>? id,
  core.String? onBehalfOf,
  core.String? onBehalfOfContentOwner,
  core.String? $fields,
}) async {
  if (part.isEmpty) {
    throw core.ArgumentError('Parameter part cannot be empty.');
  }
  final queryParams_ = <core.String, core.List<core.String>>{
    'part': part,
    'videoId': [videoId],
    if (id != null) 'id': id,
    if (onBehalfOf != null) 'onBehalfOf': [onBehalfOf],
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'youtube/v3/captions';

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