Class: XTwitterScraper::Models::X::CommunityRetrieveSearchParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb,
sig/x_twitter_scraper/models/x/community_retrieve_search_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::X::Communities#retrieve_search

Defined Under Namespace

Modules: QueryType

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

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(community_id:, q:, cursor: nil, page_size: nil, query_type: nil, request_options: {}) ⇒ Object

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

Parameters:

  • community_id (String) —

    Numeric ID of the community whose posts to search

  • q (String) —

    Search query

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

    Pagination cursor for community search

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

    Maximum items requested from this page (1-100, default 20). The response can con

  • query_type (Symbol, XTwitterScraper::Models::X::CommunityRetrieveSearchParams::QueryType) (defaults to: nil) —

    Sort order (Latest or Top)

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



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

Instance Attribute Details

#community_id ⇒ String

Numeric ID of the community whose posts to search

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb', line 15

required :community_id, String

#cursor ⇒ String?

Pagination cursor for community search

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb', line 27

optional :cursor, String

#page_size ⇒ Integer?

Maximum items requested from this page (1-100, default 20). The response can contain fewer items because the source returned fewer, filters removed items, or remaining credits cover fewer results. Keep requesting next_cursor while has_next_page is true, even when a page is empty. The deprecated limit and count aliases remain accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#q ⇒ String

Search query

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb', line 21

required :q, String

#query_type ⇒ Symbol, ...

Sort order (Latest or Top)

Returns:



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

optional :query_type, enum: -> { XTwitterScraper::X::CommunityRetrieveSearchParams::QueryType }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


45
 
# File 'sig/x_twitter_scraper/models/x/community_retrieve_search_params.rbs', line 45

def to_hash: -> {