subscribersShow method

Future<User> subscribersShow({ String? listId, String? slug, String? ownerScreenName, String? ownerId, String? userId, String? screenName, bool? includeEntities, bool? skipStatus, String tweetMode = 'extended', TransformResponse<User> transform = defaultUserTransform, })

Check if the specified user is a subscriber of the specified list. Returns the user if they are a subscriber.

listId The numerical id of the list.

slug You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the ownerId or ownerScreenName parameters.

ownerScreenName The screen name of the user who owns the list being requested by a slug.

ownerId The user ID of the user who owns the list being requested by a slug.

userId The ID of the user for whom to return results.

screenName The screen name of the user for whom to return results.

includeEntities The entities node will not be included when set to false.

skipStatus When set to true statuses will not be included in the returned user objects.

tweetMode When set to extended, uses the extended Tweets. See https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/intro-to-tweet-json#extendedtweet.

transform Can be used to parse the request. By default, the response is parsed in an isolate.

See https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show.

Implementation

Future<User> subscribersShow({
  String? listId,
  String? slug,
  String? ownerScreenName,
  String? ownerId,
  String? userId,
  String? screenName,
  bool? includeEntities,
  bool? skipStatus,
  String tweetMode = 'extended',
  TransformResponse<User> transform = defaultUserTransform,
}) async {
  final params = <String, String>{}
    ..addParameter('list_id', listId)
    ..addParameter('slug', slug)
    ..addParameter('owner_screen_name', ownerScreenName)
    ..addParameter('owner_id', ownerId)
    ..addParameter('user_id', userId)
    ..addParameter('screen_name', screenName)
    ..addParameter('include_entities', includeEntities)
    ..addParameter('skip_status', skipStatus)
    ..addParameter('tweet_mode', tweetMode);

  return client
      .get(
        Uri.https(
          'api.twitter.com',
          '1.1/lists/subscribers/show.json',
          params,
        ),
      )
      .then(transform);
}