Class: XTwitterScraper::Models::SearchTweet

Inherits:

Internal::Type::BaseModel

Object
Internal::Type::BaseModel
XTwitterScraper::Models::SearchTweet

show all

Defined in:: lib/x_twitter_scraper/models/search_tweet.rb,
sig/x_twitter_scraper/models/search_tweet.rbs

Constant Summary collapse

XTwitterScraper = Returns: (:UserProfile)

Instance Attribute Summary collapse

#author ⇒ XTwitterScraper::Models::UserProfile^?
X user profile with bio, follower counts, and verification status.
#bookmark_count ⇒ Integer
#content_disclosure ⇒ XTwitterScraper::Models::ContentDisclosure^?
Content disclosure metadata shown by X when a tweet is labeled as paid partnership content or AI-generated media.
#conversation_id ⇒ String^?
Root tweet ID for the search result conversation.
#created_at ⇒ String^?
#display_text_range ⇒ Array<Integer>^?
Rendered text's start and end offsets.
#entities ⇒ Hash{Symbol=>Object}^?
Parsed search-result entities including URLs, mentions, hashtags, and media markers.
#id ⇒ String
#in_reply_to_id ⇒ String^?
ID of the tweet this result replies to.
#in_reply_to_user_id ⇒ String^?
ID of the user this result replies to.
#in_reply_to_username ⇒ String^?
Username this result replies to.
#is_limited_reply ⇒ Boolean^?
Whether the tweet has limited reply permissions.
#is_note_tweet ⇒ Boolean^?
True for Note Tweets (long-form content, up to 25,000 characters).
#is_quote_status ⇒ Boolean^?
True when this search result quotes another tweet.
#is_reply ⇒ Boolean^?
True when this search result is a reply.
#lang ⇒ String^?
Search result language code.
#like_count ⇒ Integer
#media ⇒ Array<XTwitterScraper::Models::TweetMedia>^?
Search-result media attachments, omitted when no media is present.
#quote_count ⇒ Integer
#quoted_tweet ⇒ XTwitterScraper::Models::EmbeddedTweet^?
Quoted or retweeted tweet context.
#reply_count ⇒ Integer
#retweet_count ⇒ Integer
#retweeted_tweet ⇒ XTwitterScraper::Models::EmbeddedTweet^?
Quoted or retweeted tweet context.
#source ⇒ String^?
Client application used to post the tweet.
#text ⇒ String
#type ⇒ String^?
#url ⇒ String^?
Search result permalink.
#view_count ⇒ Integer

Instance Method Summary collapse

#initialize(id:, bookmark_count:, like_count:, quote_count:, reply_count:, retweet_count:, text:, view_count:, author: nil, content_disclosure: nil, conversation_id: nil, created_at: nil, display_text_range: nil, entities: nil, in_reply_to_id: nil, in_reply_to_user_id: nil, in_reply_to_username: nil, is_limited_reply: nil, is_note_tweet: nil, is_quote_status: nil, is_reply: nil, lang: nil, media: nil, quoted_tweet: nil, retweeted_tweet: nil, source: nil, type: nil, url: nil) ⇒ Object constructor
Some parameter documentations has been truncated, see SearchTweet for more details.
#to_hash ⇒ {

Constructor Details

#initialize(id:, bookmark_count:, like_count:, quote_count:, reply_count:, retweet_count:, text:, view_count:, author: nil, content_disclosure: nil, conversation_id: nil, created_at: nil, display_text_range: nil, entities: nil, in_reply_to_id: nil, in_reply_to_user_id: nil, in_reply_to_username: nil, is_limited_reply: nil, is_note_tweet: nil, is_quote_status: nil, is_reply: nil, lang: nil, media: nil, quoted_tweet: nil, retweeted_tweet: nil, source: nil, type: nil, url: nil) ⇒ `Object`

Some parameter documentations has been truncated, see XTwitterScraper::Models::SearchTweet for more details.

Tweet returned from search results with inline author info. A zero metric can mean X did not report the count.

Parameters:

id (String)
bookmark_count (Integer)
like_count (Integer)
quote_count (Integer)
reply_count (Integer)
retweet_count (Integer)
text (String)
view_count (Integer)
author (XTwitterScraper::Models::UserProfile) (defaults to: nil) —
X user profile with bio, follower counts, and verification status.
content_disclosure (XTwitterScraper::Models::ContentDisclosure) (defaults to: nil) —
Content disclosure metadata shown by X when a tweet is labeled as paid partnersh
conversation_id (String) (defaults to: nil) —
Root tweet ID for the search result conversation
created_at (String) (defaults to: nil)
display_text_range (Array<Integer>) (defaults to: nil) —
Rendered text's start and end offsets.
entities (Hash{Symbol=>Object}) (defaults to: nil) —
Parsed search-result entities including URLs, mentions, hashtags, and media mark
in_reply_to_id (String) (defaults to: nil) —
ID of the tweet this result replies to.
in_reply_to_user_id (String) (defaults to: nil) —
ID of the user this result replies to.
in_reply_to_username (String) (defaults to: nil) —
Username this result replies to.
is_limited_reply (Boolean) (defaults to: nil) —
Whether the tweet has limited reply permissions
is_note_tweet (Boolean) (defaults to: nil) —
True for Note Tweets (long-form content, up to 25,000 characters)
is_quote_status (Boolean) (defaults to: nil) —
True when this search result quotes another tweet
is_reply (Boolean) (defaults to: nil) —
True when this search result is a reply
lang (String) (defaults to: nil) —
Search result language code.
media (Array<XTwitterScraper::Models::TweetMedia>) (defaults to: nil) —
Search-result media attachments, omitted when no media is present
quoted_tweet (XTwitterScraper::Models::EmbeddedTweet) (defaults to: nil) —
Quoted or retweeted tweet context. Every object includes id, text, and engagemen
retweeted_tweet (XTwitterScraper::Models::EmbeddedTweet) (defaults to: nil) —
Quoted or retweeted tweet context. Every object includes id, text, and engagemen
source (String) (defaults to: nil) —
Client application used to post the tweet
type (String) (defaults to: nil)
url (String) (defaults to: nil) —
Search result permalink.

# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 176

Instance Attribute Details

#author ⇒ `XTwitterScraper::Models::UserProfile`^?

X user profile with bio, follower counts, and verification status.

Returns:

(XTwitterScraper::Models::UserProfile, nil)

54	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 54 optional :author, -> { XTwitterScraper::UserProfile }

#bookmark_count ⇒ `Integer`

Parameters:

value (Integer)

Returns:

(Integer)

18	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 18 required :bookmark_count, Integer, api_name: :bookmarkCount

#content_disclosure ⇒ `XTwitterScraper::Models::ContentDisclosure`^?

Content disclosure metadata shown by X when a tweet is labeled as paid partnership content or AI-generated media.

Returns:

(XTwitterScraper::Models::ContentDisclosure, nil)

61	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 61 optional :content_disclosure, -> { XTwitterScraper::ContentDisclosure }, api_name: :contentDisclosure

#conversation_id ⇒ `String`^?

Root tweet ID for the search result conversation

Parameters:

(String)

Returns:

(String, nil)

67	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 67 optional :conversation_id, String, api_name: :conversationId

#created_at ⇒ `String`^?

Parameters:

(String)

Returns:

(String, nil)

72	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 72 optional :created_at, String, api_name: :createdAt

#display_text_range ⇒ `Array<Integer>`^?

Rendered text's start and end offsets.

Parameters:

(::Array[Integer])

Returns:

(Array<Integer>, nil)



78
79
80

# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 78

optional :display_text_range,
XTwitterScraper::Internal::Type::ArrayOf[Integer],
api_name: :displayTextRange

#entities ⇒ `Hash{Symbol=>Object}`^?

Parsed search-result entities including URLs, mentions, hashtags, and media markers

Parameters:

(::Hash[Symbol, top])

Returns:

(Hash{Symbol=>Object}, nil)

87	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 87 optional :entities, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#id ⇒ `String`

Parameters:

value (String)

Returns:

(String)

13	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 13 required :id, String

#in_reply_to_id ⇒ `String`^?

ID of the tweet this result replies to.

Parameters:

(String)

Returns:

(String, nil)

93	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 93 optional :in_reply_to_id, String, api_name: :inReplyToId

#in_reply_to_user_id ⇒ `String`^?

ID of the user this result replies to.

Parameters:

(String)

Returns:

(String, nil)

99	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 99 optional :in_reply_to_user_id, String, api_name: :inReplyToUserId

#in_reply_to_username ⇒ `String`^?

Username this result replies to.

Parameters:

(String)

Returns:

(String, nil)

105	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 105 optional :in_reply_to_username, String, api_name: :inReplyToUsername

#is_limited_reply ⇒ `Boolean`^?

Whether the tweet has limited reply permissions

Parameters:

(Boolean)

Returns:

(Boolean, nil)

111	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 111 optional :is_limited_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isLimitedReply

#is_note_tweet ⇒ `Boolean`^?

True for Note Tweets (long-form content, up to 25,000 characters)

Parameters:

(Boolean)

Returns:

(Boolean, nil)

117	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 117 optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean, api_name: :isNoteTweet

#is_quote_status ⇒ `Boolean`^?

True when this search result quotes another tweet

Parameters:

(Boolean)

Returns:

(Boolean, nil)

123	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 123 optional :is_quote_status, XTwitterScraper::Internal::Type::Boolean, api_name: :isQuoteStatus

#is_reply ⇒ `Boolean`^?

True when this search result is a reply

Parameters:

(Boolean)

Returns:

(Boolean, nil)

129	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 129 optional :is_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isReply

#lang ⇒ `String`^?

Search result language code.

Parameters:

(String)

Returns:

(String, nil)

135	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 135 optional :lang, String

#like_count ⇒ `Integer`

Parameters:

value (Integer)

Returns:

(Integer)

23	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 23 required :like_count, Integer, api_name: :likeCount

#media ⇒ `Array<XTwitterScraper::Models::TweetMedia>`^?

Search-result media attachments, omitted when no media is present

Returns:

(Array<XTwitterScraper::Models::TweetMedia>, nil)

141	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 141 optional :media, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia] }

#quote_count ⇒ `Integer`

Parameters:

value (Integer)

Returns:

(Integer)

28	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 28 required :quote_count, Integer, api_name: :quoteCount

#quoted_tweet ⇒ `XTwitterScraper::Models::EmbeddedTweet`^?

Quoted or retweeted tweet context. Every object includes id, text, and engagement metrics. A zero metric can mean X did not report the count. Author, media, and conversation fields appear when available.

Returns:

(XTwitterScraper::Models::EmbeddedTweet, nil)

149	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 149 optional :quoted_tweet, -> { XTwitterScraper::EmbeddedTweet }

#reply_count ⇒ `Integer`

Parameters:

value (Integer)

Returns:

(Integer)

33	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 33 required :reply_count, Integer, api_name: :replyCount

#retweet_count ⇒ `Integer`

Parameters:

value (Integer)

Returns:

(Integer)

38	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 38 required :retweet_count, Integer, api_name: :retweetCount

#retweeted_tweet ⇒ `XTwitterScraper::Models::EmbeddedTweet`^?

Returns:

(XTwitterScraper::Models::EmbeddedTweet, nil)

157	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 157 optional :retweeted_tweet, -> { XTwitterScraper::EmbeddedTweet }

#source ⇒ `String`^?

Client application used to post the tweet

Parameters:

(String)

Returns:

(String, nil)

163	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 163 optional :source, String

#text ⇒ `String`

Parameters:

value (String)

Returns:

(String)

43	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 43 required :text, String

#type ⇒ `String`^?

Parameters:

(String)

Returns:

(String, nil)

168	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 168 optional :type, String

#url ⇒ `String`^?

Search result permalink.

Parameters:

(String)

Returns:

(String, nil)

174	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 174 optional :url, String

#view_count ⇒ `Integer`

Parameters:

value (Integer)

Returns:

(Integer)

48	# File 'lib/x_twitter_scraper/models/search_tweet.rb', line 48 required :view_count, Integer, api_name: :viewCount

Instance Method Details

#to_hash ⇒ `{`

Returns:

({)

177	# File 'sig/x_twitter_scraper/models/search_tweet.rbs', line 177 def to_hash: -> {

Class: XTwitterScraper::Models::SearchTweet

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

Methods included from Internal::Type::Converter

Methods included from Internal::Util::SorbetRuntimeSupport

Constructor Details

Instance Attribute Details

#author ⇒ XTwitterScraper::Models::UserProfile?

#bookmark_count ⇒ Integer

#content_disclosure ⇒ XTwitterScraper::Models::ContentDisclosure?

#conversation_id ⇒ String?

#created_at ⇒ String?

#display_text_range ⇒ Array<Integer>?

#entities ⇒ Hash{Symbol=>Object}?

#id ⇒ String

#in_reply_to_id ⇒ String?

#in_reply_to_user_id ⇒ String?

#in_reply_to_username ⇒ String?

#is_limited_reply ⇒ Boolean?

#is_note_tweet ⇒ Boolean?

#is_quote_status ⇒ Boolean?

#is_reply ⇒ Boolean?

#lang ⇒ String?

#like_count ⇒ Integer

#media ⇒ Array<XTwitterScraper::Models::TweetMedia>?

#quote_count ⇒ Integer

#quoted_tweet ⇒ XTwitterScraper::Models::EmbeddedTweet?

#reply_count ⇒ Integer

#retweet_count ⇒ Integer

#retweeted_tweet ⇒ XTwitterScraper::Models::EmbeddedTweet?

#source ⇒ String?

#text ⇒ String

#type ⇒ String?

#url ⇒ String?

#view_count ⇒ Integer

Instance Method Details

#to_hash ⇒ {

#author ⇒ `XTwitterScraper::Models::UserProfile`^?

#bookmark_count ⇒ `Integer`

#content_disclosure ⇒ `XTwitterScraper::Models::ContentDisclosure`^?

#conversation_id ⇒ `String`^?

#created_at ⇒ `String`^?

#display_text_range ⇒ `Array<Integer>`^?

#entities ⇒ `Hash{Symbol=>Object}`^?

#id ⇒ `String`

#in_reply_to_id ⇒ `String`^?

#in_reply_to_user_id ⇒ `String`^?

#in_reply_to_username ⇒ `String`^?

#is_limited_reply ⇒ `Boolean`^?

#is_note_tweet ⇒ `Boolean`^?

#is_quote_status ⇒ `Boolean`^?

#is_reply ⇒ `Boolean`^?

#lang ⇒ `String`^?

#like_count ⇒ `Integer`

#media ⇒ `Array<XTwitterScraper::Models::TweetMedia>`^?

#quote_count ⇒ `Integer`

#quoted_tweet ⇒ `XTwitterScraper::Models::EmbeddedTweet`^?

#reply_count ⇒ `Integer`

#retweet_count ⇒ `Integer`

#retweeted_tweet ⇒ `XTwitterScraper::Models::EmbeddedTweet`^?

#source ⇒ `String`^?

#text ⇒ `String`

#type ⇒ `String`^?

#url ⇒ `String`^?

#view_count ⇒ `Integer`

#to_hash ⇒ `{`