Class: XTwitterScraper::Models::TweetMedia

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: Type Classes: FaceRect, FocusRect, Size, VideoVariant

Instance Attribute Summary

• #allow_download ⇒ Boolean^?

  Whether X permits direct media download.

• #alt_text ⇒ String^?

  Accessibility text supplied for the media.

• #aspect_ratio ⇒ Array<Integer>^?

  Video aspect ratio as width and height.

• #availability_status ⇒ String^?

  Media availability state reported by X.

• #display_url ⇒ String^?

  Display-friendly media URL reported by X.

• #duration_millis ⇒ Integer^?

  Video duration in milliseconds.

• #expanded_url ⇒ String^?

  Expanded X media URL.

• #face_rects ⇒ Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}^?

  Face-aware crop rectangles grouped by media size.

• #focus_rects ⇒ Array<XTwitterScraper::Models::TweetMedia::FocusRect>^?

  Suggested image crops reported by X.

• #height ⇒ Integer^?

  Original media height.

• #id ⇒ String^?

  X media entity ID.

• #indices ⇒ Array<Integer>^?

  Media entity offsets in the tweet text.

• #media_key ⇒ String^?

  Stable X media key.

• #media_url ⇒ String

  Media preview URL.

• #monetizable ⇒ Boolean^?

  Whether X reports the media as monetizable.

• #sizes ⇒ Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}^?

  Named media renditions and resize modes.

• #type ⇒ Symbol, XTwitterScraper::Models::TweetMedia::Type
• #url ⇒ String

  X media link from the tweet.

• #video_variants ⇒ Array<XTwitterScraper::Models::TweetMedia::VideoVariant>^?

  Available video encodings, ordered as returned.

• #width ⇒ Integer^?

  Original media width.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(h:, resize:, w:) ⇒ Object constructor
• #to_hash ⇒ ::Hash[Symbol, top]

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(h:, resize:, w:) ⇒ Object

Parameters:

• h (Integer)
• resize (String)
• w (Integer)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 137

Instance Attribute Details

#allow_download ⇒ Boolean^?

Whether X permits direct media download.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 37

optional :allow_download, XTwitterScraper::Internal::Type::Boolean, api_name: :allowDownload

#alt_text ⇒ String^?

Accessibility text supplied for the media.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :alt_text, String, api_name: :altText

#aspect_ratio ⇒ Array<Integer>^?

Video aspect ratio as width and height.

Parameters:

• (::Array[Integer])

Returns:

• (Array<Integer>, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 49

optional :aspect_ratio, XTwitterScraper::Internal::Type::ArrayOf[Integer], api_name: :aspectRatio

#availability_status ⇒ String^?

Media availability state reported by X.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 55

optional :availability_status, String, api_name: :availabilityStatus

#display_url ⇒ String^?

Display-friendly media URL reported by X.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :display_url, String, api_name: :displayUrl

#duration_millis ⇒ Integer^?

Video duration in milliseconds.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 67

optional :duration_millis, Integer, api_name: :durationMillis

#expanded_url ⇒ String^?

Expanded X media URL.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 73

optional :expanded_url, String, api_name: :expandedUrl

#face_rects ⇒ Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}^?

Face-aware crop rectangles grouped by media size.

Returns:

• (Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 79

optional :face_rects,
-> {
  XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::FaceRect]]
},
api_name: :faceRects

#focus_rects ⇒ Array<XTwitterScraper::Models::TweetMedia::FocusRect>^?

Suggested image crops reported by X.

Returns:

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

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 89

optional :focus_rects,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::FocusRect] },
api_name: :focusRects

#height ⇒ Integer^?

Original media height.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 97

optional :height, Integer

#id ⇒ String^?

X media entity ID.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 31

optional :id, String

#indices ⇒ Array<Integer>^?

Media entity offsets in the tweet text.

Parameters:

• (::Array[Integer])

Returns:

• (Array<Integer>, nil)

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

optional :indices, XTwitterScraper::Internal::Type::ArrayOf[Integer]

#media_key ⇒ String^?

Stable X media key.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 109

optional :media_key, String, api_name: :mediaKey

#media_url ⇒ String

Media preview URL

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 14

required :media_url, String, api_name: :mediaUrl

#monetizable ⇒ Boolean^?

Whether X reports the media as monetizable.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 115

optional :monetizable, XTwitterScraper::Internal::Type::Boolean

#sizes ⇒ Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}^?

Named media renditions and resize modes.

Returns:

• (Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 121

optional :sizes, -> { XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::TweetMedia::Size] }

#type ⇒ Symbol, XTwitterScraper::Models::TweetMedia::Type

Parameters:

• value (XTwitterScraper::Models::TweetMedia::type_)

Returns:

• (Symbol, XTwitterScraper::Models::TweetMedia::Type)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 19

required :type, enum: -> { XTwitterScraper::TweetMedia::Type }

#url ⇒ String

X media link from the tweet

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 25

required :url, String

#video_variants ⇒ Array<XTwitterScraper::Models::TweetMedia::VideoVariant>^?

Available video encodings, ordered as returned

Returns:

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

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 127

optional :video_variants,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::VideoVariant] },
api_name: :videoVariants

#width ⇒ Integer^?

Original media width.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 135

optional :width, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/x_twitter_scraper/models/tweet_media.rb', line 188

Instance Method Details

#to_hash ⇒ ::Hash[Symbol, top]

Returns:

• (::Hash[Symbol, top])

# File 'sig/x_twitter_scraper/models/tweet_media.rbs', line 115

def to_hash: -> ::Hash[Symbol, top]