TweetsService class abstract

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

Available Extensions

• TweetServiceExtension

Constructors

TweetsService({required ClientContext context})

Returns the new instance of TweetsService.

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

connectFilteredStream({int? backfillMinutes, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields}) → Future<TwitterStreamResponse<FilteredStreamResponse>>

Streams Tweets in real-time that match the rules that you added to the stream using the POST /tweets/search/stream/rules endpoint. If you haven't added any rules to your stream, you will not receive any Tweets.

connectSample10Stream({required DecahosePartition partition, int? backfillMinutes, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields}) → Future<TwitterStreamResponse<TwitterResponse<TweetData, void>>>

Makes 1 of 2 connections to the 10% sample stream of all Tweets in real-time.

connectSampleStream({int? backfillMinutes, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields}) → Future<TwitterStreamResponse<TwitterResponse<TweetData, void>>>

Streams about 1% of all Tweets in real-time.

countAll({required String query, String? nextToken, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, TweetCountGranularity? granularity, ForwardPaging<List<TweetCountData>, TweetCountMeta>? paging}) → Future<TwitterResponse<List<TweetCountData>, TweetCountMeta>>

This endpoint is only available to those users who have been approved for Academic Research access.

countRecent({required String query, String? nextToken, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, TweetCountGranularity? granularity}) → Future<TwitterResponse<List<TweetCountData>, TweetCountMeta>>

The recent Tweet counts endpoint returns count of Tweets from the last seven days that match a query.

createBookmark({required String userId, required String tweetId}) → Future<TwitterResponse<BookmarkStateData, void>>

Causes the user ID of an authenticated user identified in the path parameter to Bookmark the target Tweet provided in the request body.

createFilteringRules({required List<FilteringRuleParam> rules, bool? dryRun}) → Future<TwitterResponse<List<FilteringRuleData>, FilteringRuleMeta>>

Add rules to your stream.

createHiddenReply({required String tweetId}) → Future<TwitterResponse<ReplyStateData, void>>

Hides a reply to a Tweet.

createLike({required String userId, required String tweetId}) → Future<TwitterResponse<LikeStateData, void>>

Causes the user ID identified in the path parameter to Like the target Tweet.

createRetweet({required String userId, required String tweetId}) → Future<TwitterResponse<RetweetStateData, void>>

Causes the user ID identified in the path parameter to Retweet the target Tweet.

createTweet({required String text, String? quoteTweetId, bool? forSuperFollowersOnly, ReplySetting? replySetting, String? directMessageDeepLink, TweetMediaParam? media, TweetGeoParam? geo, TweetPollParam? poll, TweetReplyParam? reply}) → Future<TwitterResponse<TweetData, void>>

Creates a Tweet on behalf of an authenticated user.

destroyBookmark({required String userId, required String tweetId}) → Future<TwitterResponse<BookmarkStateData, void>>

Allows a user or authenticated user ID to remove a Bookmark of a Tweet.

destroyFilteringRules({required List<String> ruleIds}) → Future<TwitterResponse<EmptyData, void>>

Delete rules from your stream.

destroyHiddenReply({required String tweetId}) → Future<TwitterResponse<ReplyStateData, void>>

Unhides a reply to a Tweet.

destroyLike({required String userId, required String tweetId}) → Future<TwitterResponse<LikeStateData, void>>

Allows a user or authenticated user ID to unlike a Tweet.

destroyRetweet({required String userId, required String tweetId}) → Future<TwitterResponse<RetweetStateData, void>>

Allows a user or authenticated user ID to remove the Retweet of a Tweet.

destroyTweet({required String tweetId}) → Future<TwitterResponse<DeleteStateData, void>>

Allows a user or authenticated user ID to delete a Tweet.

lookupBookmarks({required String userId, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

Allows you to get information about a authenticated user’s 800 most recent bookmarked Tweets.

lookupById({required String tweetId, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields}) → Future<TwitterResponse<TweetData, void>>

Returns a variety of information about a single Tweet specified by the requested ID.

lookupByIds({required List<String> tweetIds, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields}) → Future<TwitterResponse<List<TweetData>, void>>

Returns a variety of information about the Tweet specified by the requested ID or list of IDs.

lookupFilteringRules({List<String>? ruleIds}) → Future<TwitterResponse<List<FilteringRuleData>, FilteringRuleMeta>>

Returns either a single rule, or a list of rules that have been added to the stream.

lookupHomeTimeline({required String userId, int? maxResults, String? paginationToken, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, List<ExcludeTweetType>? excludes, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, Paging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

Allows you to retrieve a collection of the most recent Tweets and Retweets posted by you and users you follow. This endpoint returns up to the last 3200 Tweets.

lookupLikedTweets({required String userId, int? maxResults, String? paginationToken, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, Paging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

Allows you to get information about a user’s liked Tweets.

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}) → Future<TwitterResponse<List<UserData>, UserMeta>>

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

lookupMentions({required String userId, int? maxResults, String? paginationToken, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, Paging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

Returns Tweets mentioning a single user specified by the requested user ID.

lookupQuoteTweets({required String tweetId, ExcludeTweetType? exclude, int? maxResults, String? paginationToken, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, Paging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

Returns Quote Tweets for a Tweet specified by the requested Tweet ID.

lookupRetweetedUsers({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}) → Future<TwitterResponse<List<UserData>, UserMeta>>

Allows you to get information about who has Retweeted a Tweet.

lookupTweets({required String userId, int? maxResults, String? paginationToken, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, List<ExcludeTweetType>? excludes, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, Paging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

Returns Tweets composed by a single user, specified by the requested user ID.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchAll({required String query, int? maxResults, String? nextToken, SortOrder? sortOrder, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, ForwardPaging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

This endpoint is only available to those users who have been approved for Academic Research access.

searchRecent({required String query, int? maxResults, String? nextToken, SortOrder? sortOrder, DateTime? startTime, DateTime? endTime, String? sinceTweetId, String? untilTweetId, List<TweetExpansion>? expansions, List<TweetField>? tweetFields, List<UserField>? userFields, List<PlaceField>? placeFields, List<PollField>? pollFields, List<MediaField>? mediaFields, ForwardPaging<List<TweetData>, TweetMeta>? paging}) → Future<TwitterResponse<List<TweetData>, TweetMeta>>

The recent search endpoint returns Tweets from the last seven days that match a search query.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited