lookupLikingUsers abstract method

Future<TwitterResponse<List<UserData>, UserMeta>> lookupLikingUsers({ required String tweetId, int? maxResults, String? paginationToken, List<UserExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, Paging<List<UserData>, UserMeta>? paging, })

Allows you to get information about a Tweet’s liking users.

The value returned when the paging callback is specified is the first object obtained that started the paging process. The value obtained in the paging process is passed to the paging callback function as a PagingEvent object.

Parameters

• tweetId: Tweet ID of the Tweet to request liking users of.

• maxResults: The maximum number of results to be returned per page. This can be a number between 1 and 100. By default, each page will return 100 results.

• paginationToken: Used to request the next page of results if all results weren't returned with the latest request, or to go back to the previous page of results. To return the next page, pass the next_token returned in your previous response. To go back one page, pass the previous_token returned in your previous response.

• expansions: Expansions enable you to request additional data objects that relate to the originally returned users. The ID that represents the expanded data object will be included directly in the user data object, but the expanded object metadata will be returned within the includes response object, and will also include the ID so that you can match this data object to the original Tweet object.

• tweetFields: This fields parameter enables you to select which specific Tweet fields will deliver in each returned Tweet object. You can also pass expansions to return the specified fields for both the original Tweet and any included referenced Tweets. The requested Tweet fields will display in both the original Tweet data object, as well as in the referenced Tweet expanded data object that will be located in the includes data object.

• userFields: This fields parameter enables you to select which specific user fields will deliver in each returned Tweet. While the user ID will be located in the original Tweet object, you will find this ID and all additional user fields in the includes data object.

• placeFields: This fields parameter enables you to select which specific place fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. The Tweet will only return place fields if the Tweet contains a place and if you’ve also included the expansions=geo.place_id query parameter in your request. While the place ID will be located in the Tweet object, you will find this ID and all additional place fields in the includes data object.

• pollFields: This fields parameter enables you to select which specific poll fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. The Tweet will only return poll fields if the Tweet contains a poll and if you've also included the expansions=attachments.poll_ids query parameter in your request. While the poll ID will be located in the Tweet object, you will find this ID and all additional poll fields in the includes data object.

• mediaFields: This fields parameter enables you to select which specific media fields will deliver in each returned Tweet. Specify the desired fields in a comma-separated list without spaces between commas and fields. The Tweet will only return media fields if the Tweet contains media and if you've also included the expansions=attachments.media_keys query parameter in your request. While the media ID will be located in the Tweet object, you will find this ID and all additional media fields in the includes data object.

• paging: If this callback function is specified, paging is performed continuously until certain conditions are met. This paging function is bi-directional, both forward and backward, and allows for safe paging. The response and other metadata obtained when paging is performed is passed to the callback function as PagingEvent object. So you can get the result of paging from PagingEvent object. Also, the direction and continuity of paging can be controlled by returning PaginationControl object in the paging callback function. Please use PaginationControl.forward() to continue paging and move forward, or use PaginationControl.backward() to move backward. And be sure to return PaginationControl.stop() to terminate paging on arbitrary conditions, otherwise paging continues until the next page runs out.

Endpoint Url

• https://api.twitter.com/2/tweets/:id/liking_users

Authentication Methods

• OAuth 2.0 Authorization Code with PKCE
• OAuth 2.0 App-only
• OAuth 1.0a

Required Scopes

• tweet.read
• users.read
• like.read

Rate Limits

• App rate limit (OAuth 2.0 App Access Token): 75 requests per 15-minute window shared among all users of your app

• User rate limit (OAuth 2.0 user Access Token): 75 requests per 15-minute window per each authenticated user

Reference

• https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users

Implementation

Future<TwitterResponse<List<UserData>, UserMeta>> lookupLikingUsers({
  required String tweetId,
  int? maxResults,
  String? paginationToken,
  List<UserExpansion>? expansions,
  List<TweetField>? tweetFields,
  List<UserField>? userFields,
  List<PlaceField>? placeFields,
  List<PollField>? pollFields,
  List<MediaField>? mediaFields,
  Paging<List<UserData>, UserMeta>? paging,
});