Class: XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb

Overview

Defined Under Namespace

Modules: Source

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(category: nil, count: nil, hours: nil, region: nil, source: nil, request_options: {}) ⇒ Object

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

Parameters:

  • category (String) (defaults to: nil)

    Filter by category (general, tech, dev, etc.)

  • count (Integer) (defaults to: nil)

    Number of items to return

  • hours (Integer) (defaults to: nil)

    Lookback window in hours

  • region (String) (defaults to: nil)

    Region filter (us, global, etc.)

  • source (Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Source) (defaults to: nil)

    Source filter. One of: github, google_trends, hacker_news, polymarket, reddit, t

  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb', line 41

Instance Attribute Details

#categoryString?

Filter by category (general, tech, dev, etc.)

Returns:

  • (String, nil)


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

optional :category, String

#countInteger?

Number of items to return

Returns:

  • (Integer, nil)


20
# File 'lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb', line 20

optional :count, Integer

#hoursInteger?

Lookback window in hours

Returns:

  • (Integer, nil)


26
# File 'lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb', line 26

optional :hours, Integer

#regionString?

Region filter (us, global, etc.)

Returns:

  • (String, nil)


32
# File 'lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb', line 32

optional :region, String

#sourceSymbol, ...

Source filter. One of: github, google_trends, hacker_news, polymarket, reddit, trustmrr, wikipedia



39
# File 'lib/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rb', line 39

optional :source, enum: -> { XTwitterScraper::RadarRetrieveTrendingTopicsParams::Source }