Class: XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• XTwitterScraper::Resources::Radar#retrieve_trending_topics

Defined Under Namespace

Modules: Category, Source

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary

• #after ⇒ String^?

  Cursor for pagination (from prior response nextCursor).

• #category ⇒ Symbol, ...

  Filter by category.

• #hours ⇒ Integer^?

  Lookback window in hours (1-72, default 6).

• #limit ⇒ Integer^?

  Number of items to return (1-100, default 50).

• #region ⇒ String^?

  Region filter.

• #source ⇒ Symbol, ...

  Source filter.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(after: nil, category: nil, hours: nil, limit: nil, region: nil, source: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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

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

Parameters:

• after (String) (defaults to: nil) —

  Cursor for pagination (from prior response nextCursor).

• category (Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Category) (defaults to: nil) —

  Filter by category.

• hours (Integer) (defaults to: nil) —

  Lookback window in hours (1-72, default 6).

• limit (Integer) (defaults to: nil) —

  Number of items to return (1-100, default 50).

• region (String) (defaults to: nil) —

  Region filter. Use global or a region code such as US, GB, TR, or ES.

• 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 47

Instance Attribute Details

#after ⇒ String^?

Cursor for pagination (from prior response nextCursor).

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :after, String

#category ⇒ Symbol, ...

Filter by category.

Returns:

• (Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Category, nil)

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

optional :category, enum: -> { XTwitterScraper::RadarRetrieveTrendingTopicsParams::Category }

#hours ⇒ Integer^?

Lookback window in hours (1-72, default 6).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :hours, Integer

#limit ⇒ Integer^?

Number of items to return (1-100, default 50).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :limit, Integer

#region ⇒ String^?

Region filter. Use global or a region code such as US, GB, TR, or ES.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :region, String

#source ⇒ Symbol, ...

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

Returns:

• (Symbol, XTwitterScraper::Models::RadarRetrieveTrendingTopicsParams::Source, nil)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/radar_retrieve_trending_topics_params.rbs', line 56

def to_hash: -> {