YoutubeListVideosCommand constructor

YoutubeListVideosCommand()

Implementation

YoutubeListVideosCommand() {
  argParser
    ..addOption('part',
        valueHelp: 'list of parts',
        mandatory: true,
        help:
            '''The part parameter specifies a comma-separated list of one or more video 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 video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

The following list contains the part names that you can include in the parameter value:
contentDetails, fileDetails, id, liveStreamingDetails, localizations, player, processingDetails, recordingDetails, snippet, statistics, status, suggestions, topicDetails''')
    ..addOption('chart',
        allowed: ['mostPopular'],
        help:
            'The chart parameter identifies the chart that you want to retrieve.',
        allowedHelp: {
          'mostPopular':
              'Return the most popular videos for the specified content region and video category.'
        })
    ..addOption('id',
        valueHelp: 'id',
        help:
            'The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video\'s ID.')
    ..addOption('my-rating',
        allowed: ['dislike', 'like'],
        help:
            'This parameter can only be used in a properly authorized request. Set this parameter\'s value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.',
        allowedHelp: {
          'dislike':
              'Returns only videos disliked by the authenticated user.',
          'like': 'Returns only video liked by the authenticated user.'
        })
    ..addOption('hl',
        help:
            '''The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.''')
    ..addOption('max-height',
        valueHelp: 'number',
        help:
            'The maxHeight parameter specifies the maximum height of the embedded player returned in the player.embedHtml property. You can use this parameter to specify that instead of the default dimensions, the embed code should use a height appropriate for your application layout. If the maxWidth parameter is also provided, the player may be shorter than the maxHeight in order to not violate the maximum width. Acceptable values are 72 to 8192, inclusive.')
    ..addOption('max-results',
        defaultsTo: '5',
        valueHelp: 'number',
        help:
            '''The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter. Acceptable values are 1 to 50, inclusive. The default value is 5.''')
    ..addOption('max-width',
        valueHelp: 'number',
        help:
            'The maxWidth parameter specifies the maximum width of the embedded player returned in the player.embedHtml property. You can use this parameter to specify that instead of the default dimensions, the embed code should use a width appropriate for your application layout.  If the maxHeight parameter is also provided, the player may be narrower than maxWidth in order to not violate the maximum height. Acceptable values are 72 to 8192, inclusive.')
    ..addOption('page-token',
        valueHelp: 'token',
        help:
            '''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.

Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter.''')
    ..addOption('region-code',
        valueHelp: 'code',
        help:
            'The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.')
    ..addOption('video-category-id',
        defaultsTo: '0',
        help:
            'The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.');
}