list method

Future<SubscriptionListResponse> list(List<String> part, { String? channelId, String? forChannelId, List<String>? id, int? maxResults, bool? mine, bool? myRecentSubscribers, bool? mySubscribers, String? onBehalfOfContentOwner, String? onBehalfOfContentOwnerChannel, String? order, String? pageToken, String? $fields, })

Retrieves a list of resources, possibly filtered.

Request parameters:

part - The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties.

channelId - Return the subscriptions of the given channel owner.

forChannelId - Return the subscriptions to the subset of these channels that the authenticated user is subscribed to.

id - Return the subscriptions with the given IDs for Stubby or Apiary.

maxResults - The maxResults parameter specifies the maximum number of items that should be returned in the result set. Value must be between "0" and "50".

mine - Flag for returning the subscriptions of the authenticated user.

myRecentSubscribers - null

mySubscribers - Return the subscribers of the given channel owner.

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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

onBehalfOfContentOwnerChannel - This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

order - The order of the returned subscriptions Possible string values are:

• "subscriptionOrderUnspecified"
• "relevance" : Sort by relevance.
• "unread" : Sort by order of activity.
• "alphabetical" : Sort alphabetically.

pageToken - The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

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

Completes with a SubscriptionListResponse.

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<SubscriptionListResponse> list(
  core.List<core.String> part, {
  core.String? channelId,
  core.String? forChannelId,
  core.List<core.String>? id,
  core.int? maxResults,
  core.bool? mine,
  core.bool? myRecentSubscribers,
  core.bool? mySubscribers,
  core.String? onBehalfOfContentOwner,
  core.String? onBehalfOfContentOwnerChannel,
  core.String? order,
  core.String? pageToken,
  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,
    if (channelId != null) 'channelId': [channelId],
    if (forChannelId != null) 'forChannelId': [forChannelId],
    if (id != null) 'id': id,
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (mine != null) 'mine': ['${mine}'],
    if (myRecentSubscribers != null)
      'myRecentSubscribers': ['${myRecentSubscribers}'],
    if (mySubscribers != null) 'mySubscribers': ['${mySubscribers}'],
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if (onBehalfOfContentOwnerChannel != null)
      'onBehalfOfContentOwnerChannel': [onBehalfOfContentOwnerChannel],
    if (order != null) 'order': [order],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'youtube/v3/subscriptions';

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