ListsService class abstract

This class provides methods to easily access endpoints based on List.

Constructors

ListsService({required ClientContext context})
Returns the new instance of ListsService.
factory

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createFollow({required String userId, required String listId}) Future<TwitterResponse<FollowStateData, void>>
Enables the authenticated user to follow a List.
createMember({required String listId, required String userId}) Future<TwitterResponse<MemberStateData, void>>
Enables the authenticated user to add a member to a List they own.
createPinnedList({required String userId, required String listId}) Future<TwitterResponse<PinnedStateData, void>>
Enables the authenticated user to pin a List.
createPrivateList({required String name, String? description}) Future<TwitterResponse<ListData, void>>
Enables the authenticated user to create a private List.
createPublicList({required String name, String? description}) Future<TwitterResponse<ListData, void>>
Enables the authenticated user to create a public List.
destroyFollow({required String userId, required String listId}) Future<TwitterResponse<FollowStateData, void>>
Enables the authenticated user to unfollow a List.
destroyList({required String listId}) Future<TwitterResponse<DeleteStateData, void>>
Enables the authenticated user to delete a List that they own.
destroyMember({required String listId, required String userId}) Future<TwitterResponse<MemberStateData, void>>
Enables the authenticated user to remove a member from a List they own.
destroyPinnedList({required String userId, required String listId}) Future<TwitterResponse<PinnedStateData, void>>
Enables the authenticated user to unpin a List.
lookupById({required String listId, List<ListExpansion>? expansions, List<UserField>? userFields, List<ListField>? listFields}) Future<TwitterResponse<ListData, void>>
Returns the details of a specified List.
lookupFollowedLists({required String userId, int? maxResults, String? paginationToken, List<ListExpansion>? expansions, List<UserField>? userFields, List<ListField>? listFields, Paging<List<ListData>, ListMeta>? paging}) Future<TwitterResponse<List<ListData>, ListMeta>>
Returns all Lists a specified user follows.
lookupFollowers({required String listId, int? maxResults, String? paginationToken, List<UserExpansion>? expansions, List<UserField>? userFields, Paging<List<UserData>, UserMeta>? paging}) Future<TwitterResponse<List<UserData>, UserMeta>>
Returns a list of users who are followers of the specified List.
lookupMembers({required String listId, int? maxResults, String? paginationToken, List<UserExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, Paging<List<UserData>, UserMeta>? paging}) Future<TwitterResponse<List<UserData>, UserMeta>>
Returns a list of users who are members of the specified List.
lookupMemberships({required String userId, int? maxResults, String? paginationToken, List<ListExpansion>? expansions, List<UserField>? userFields, List<ListField>? listFields, Paging<List<ListData>, ListMeta>? paging}) Future<TwitterResponse<List<ListData>, ListMeta>>
Returns all Lists a specified user is a member of.
lookupOwnedBy({required String userId, int? maxResults, String? paginationToken, List<ListExpansion>? expansions, List<UserField>? userFields, List<ListField>? listFields, Paging<List<ListData>, ListMeta>? paging}) Future<TwitterResponse<List<ListData>, ListMeta>>
Returns all Lists owned by the specified user.
lookupPinnedLists({required String userId, List<ListExpansion>? expansions, List<UserField>? userFields, List<ListField>? listFields}) Future<TwitterResponse<List<ListData>, ListMeta>>
Returns the Lists pinned by a specified user.
lookupTweets({required String listId, int? maxResults, String? paginationToken, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, Paging<List<TweetData>, TweetMeta>? paging}) Future<TwitterResponse<List<TweetData>, TweetMeta>>
Returns a list of Tweets from the specified List.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited
updateListAsPrivate({required String listId, String? name, String? description}) Future<TwitterResponse<UpdateStateData, void>>
Enables the authenticated user to update the meta data of a specified List that they own as a private scope.
updateListAsPublic({required String listId, String? name, String? description}) Future<TwitterResponse<UpdateStateData, void>>
Enables the authenticated user to update the meta data of a specified List that they own as a public scope.

Operators

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