ListData class

The list object contains Twitter Lists metadata describing the referenced List.

The List object is the primary object returned in the List lookup endpoint. When requesting additional List fields on this endpoint, simply use the fields parameter list.fields.

At the moment, the List object cannot be found as a child object from any other data object. However, user objects can be found and expanded in the user resource. These objects are available for expansion by adding ownerId to the expansions query parameter.

Use the expansion with the field parameter: list.fields when requesting additional fields to complete the primary List object and user.fields to complete the expansion object.

Annotations
  • @freezed

Constructors

ListData({required String id, required String name, String? description, String? ownerId, int? followerCount, int? memberCount, @JsonKey(name: 'private') bool? isPrivate, DateTime? createdAt})
const
factory
ListData.fromJson(Map<String, Object?> json)
factory

Properties

copyWith → $ListDataCopyWith<ListData>
no setterinherited
createdAt DateTime?
The UTC date time that the List was created on Twitter.
no setterinherited
description String?
A brief description to let users know about the List.
no setterinherited
followerCount int?
Shows how many users follow this List.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
id String
The unique identifier of this List.
no setterinherited
isPrivate bool?
Indicates if the List is private.
no setterinherited
memberCount int?
Shows how many members are part of this List.
no setterinherited
name String
The name of the List, as defined when creating the List.
no setterinherited
ownerId String?
Unique identifier of this List's owner.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited