Class: XTwitterScraper::Models::EmbeddedTweet

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::EmbeddedTweet

Defined in:

lib/x_twitter_scraper/models/embedded_tweet.rb,
sig/x_twitter_scraper/models/embedded_tweet.rbs

Constant Summary

XTwitterScraper =

Returns:

• (:UserProfile)

Instance Attribute Summary

• #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^?
• #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
• #reply_count ⇒ Integer
• #retweet_count ⇒ Integer
• #source ⇒ String^?
• #text ⇒ String
• #type ⇒ String^?
• #url ⇒ String^?
• #view_count ⇒ Integer

Instance Method Summary

• #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, source: nil, type: nil, url: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see EmbeddedTweet for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

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, source: nil, type: nil, url: nil) ⇒ Object

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

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.

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)
• created_at (String) (defaults to: nil)
• display_text_range (Array<Integer>) (defaults to: nil)
• entities (Hash{Symbol=>Object}) (defaults to: nil)
• in_reply_to_id (String) (defaults to: nil)
• in_reply_to_user_id (String) (defaults to: nil)
• in_reply_to_username (String) (defaults to: nil)
• is_limited_reply (Boolean) (defaults to: nil)
• is_note_tweet (Boolean) (defaults to: nil)
• is_quote_status (Boolean) (defaults to: nil)
• is_reply (Boolean) (defaults to: nil)
• lang (String) (defaults to: nil)
• media (Array<XTwitterScraper::Models::TweetMedia>) (defaults to: nil)
• source (String) (defaults to: nil)
• type (String) (defaults to: nil)
• url (String) (defaults to: nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 145

Instance Attribute Details

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

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

Returns:

• (XTwitterScraper::Models::UserProfile, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 54

optional :author, -> { XTwitterScraper::UserProfile }

#bookmark_count ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/x_twitter_scraper/models/embedded_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)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 61

optional :content_disclosure, -> { XTwitterScraper::ContentDisclosure }, api_name: :contentDisclosure

#conversation_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 66

optional :conversation_id, String, api_name: :conversationId

#created_at ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 71

optional :created_at, String, api_name: :createdAt

#display_text_range ⇒ Array<Integer>^?

Parameters:

• (::Array[Integer])

Returns:

• (Array<Integer>, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 76

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

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

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 83

optional :entities, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 13

required :id, String

#in_reply_to_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 88

optional :in_reply_to_id, String, api_name: :inReplyToId

#in_reply_to_user_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 93

optional :in_reply_to_user_id, String, api_name: :inReplyToUserId

#in_reply_to_username ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 98

optional :in_reply_to_username, String, api_name: :inReplyToUsername

#is_limited_reply ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 103

optional :is_limited_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isLimitedReply

#is_note_tweet ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 108

optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean, api_name: :isNoteTweet

#is_quote_status ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 113

optional :is_quote_status, XTwitterScraper::Internal::Type::Boolean, api_name: :isQuoteStatus

#is_reply ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 118

optional :is_reply, XTwitterScraper::Internal::Type::Boolean, api_name: :isReply

#lang ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 123

optional :lang, String

#like_count ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 23

required :like_count, Integer, api_name: :likeCount

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

Returns:

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

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 128

optional :media, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia] }

#quote_count ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 28

required :quote_count, Integer, api_name: :quoteCount

#reply_count ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 33

required :reply_count, Integer, api_name: :replyCount

#retweet_count ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 38

required :retweet_count, Integer, api_name: :retweetCount

#source ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 133

optional :source, String

#text ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 43

required :text, String

#type ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 138

optional :type, String

#url ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 143

optional :url, String

#view_count ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/x_twitter_scraper/models/embedded_tweet.rb', line 48

required :view_count, Integer, api_name: :viewCount

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/embedded_tweet.rbs', line 161

def to_hash: -> {