YoutubeListSubscriptionsCommand constructor

YoutubeListSubscriptionsCommand()

Implementation

YoutubeListSubscriptionsCommand() {
  argParser
    ..addOption('part',
        defaultsTo: 'id,snippet,contentDetails,subscriberSnippet',
        help:
            '''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.

The following list contains the part names that you can include in the parameter value:
- contentDetails
- id
- snippet
- subscriberSnippet''')
    ..addOption('channel-id',
        help:
            'The channelId parameter specifies a YouTube channel ID. The API will only return that channel\'s subscriptions.',
        valueHelp: 'YouTube username')
    ..addOption('id',
        valueHelp: 'id',
        help:
            'The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.')
    ..addFlag('mine',
        defaultsTo: null,
        help:
            'This parameter can only be used in a properly authorized request. Set this parameter\'s value to true to retrieve a feed of the authenticated user\'s subscriptions.')
    ..addFlag('my-recent-subscribers',
        defaultsTo: null,
        help:
            '''This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in reverse chronological order (newest first).

Note that the maximum number of subscribers returned through this API might be limited.''')
    ..addFlag('my-subscribers',
        defaultsTo: null,
        help:
            '''This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in no particular order. Note that the maximum number of subscribers returned through this API might be limited.''')
    ..addOption('for-channel-id',
        help:
            'The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.')
    ..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. Acceptable values are 0 to 50, inclusive. The default value is 5.')
    ..addOption('order',
        defaultsTo: 'relevance',
        allowed: ['alphabetical', 'relevance', 'unread'],
        help:
            'The order parameter specifies the method that will be used to sort resources in the API response. The default value is SUBSCRIPTION_ORDER_RELEVANCE.',
        allowedHelp: {
          'alphabetical': 'Sort alphabetically.',
          'relevance': 'Sort by relevance.',
          'unread': 'Sort by order of activity.'
        });
}