Class: XTwitterScraper::Models::X::UserRetrieveMentionsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::X::UserRetrieveMentionsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb,
sig/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbs

Overview

See Also:

• XTwitterScraper::Resources::X::Users#retrieve_mentions

Defined Under Namespace

Modules: MediaType, Quotes, Replies, Retweets

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary

• #any_words ⇒ String^?

  Words or quoted phrases where any one can match.

• #cashtags ⇒ String^?

  Cashtags separated by spaces, commas, or lines.

• #conversation_id ⇒ String^?

  Conversation ID filter.

• #cursor ⇒ String^?

  Pagination cursor for mentions.

• #exact_phrase ⇒ String^?

  Exact phrase to match.

• #exclude_words ⇒ String^?

  Words or quoted phrases to exclude.

• #from_user ⇒ String^?

  Filter by author username.

• #hashtags ⇒ String^?

  Hashtags separated by spaces, commas, or lines.

• #id ⇒ String
• #in_reply_to_tweet_id ⇒ String^?

  Only replies to this tweet ID.

• #language ⇒ String^?

  Language code filter, e.g.

• #media_type ⇒ Symbol, ...

  Filter by media type.

• #mentioning ⇒ String^?

  Filter tweets mentioning a username.

• #min_faves ⇒ Integer^?

  Minimum likes threshold.

• #min_quotes ⇒ Integer^?

  Minimum quote count threshold.

• #min_replies ⇒ Integer^?

  Minimum replies threshold.

• #min_retweets ⇒ Integer^?

  Minimum retweets threshold.

• #page_size ⇒ Integer^?

  Maximum items requested from this page (1-100, default 20).

• #quotes ⇒ Symbol, ...

  Quote mode.

• #quotes_of_tweet_id ⇒ String^?

  Only quotes of this tweet ID.

• #replies ⇒ Symbol, ...

  Reply mode.

• #retweets ⇒ Symbol, ...

  Retweet mode.

• #retweets_of_tweet_id ⇒ String^?

  Only retweets of this tweet ID.

• #since_date ⇒ Date^?

  Start date in YYYY-MM-DD format.

• #since_time ⇒ String^?

  Unix timestamp - return mentions after this time.

• #to_user ⇒ String^?

  Filter replies sent to a username.

• #until_date ⇒ Date^?

  End date in YYYY-MM-DD format.

• #until_time ⇒ String^?

  Unix timestamp - return mentions before this time.

• #url ⇒ String^?

  URL substring or domain filter.

• #verified_only ⇒ Boolean^?

  Only return tweets from verified authors.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, any_words: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, since_time: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see UserRetrieveMentionsParams 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(id:, any_words: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, since_time: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, request_options: {}) ⇒ Object

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

Parameters:

• id (String)
• any_words (String) (defaults to: nil) —

  Words or quoted phrases where any one can match. Separate with spaces, commas, o

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

  Cashtags separated by spaces, commas, or lines.

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

  Conversation ID filter.

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

  Pagination cursor for mentions

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

  Exact phrase to match.

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

  Words or quoted phrases to exclude. Separate with spaces, commas, or lines.

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

  Filter by author username.

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

  Hashtags separated by spaces, commas, or lines.

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

  Only replies to this tweet ID.

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

  Language code filter, e.g. en or tr.

• media_type (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::MediaType) (defaults to: nil) —

  Filter by media type.

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

  Filter tweets mentioning a username.

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

  Minimum likes threshold.

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

  Minimum quote count threshold.

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

  Minimum replies threshold.

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

  Minimum retweets threshold.

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

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

• quotes (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Quotes) (defaults to: nil) —

  Quote mode.

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

  Only quotes of this tweet ID.

• replies (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Replies) (defaults to: nil) —

  Reply mode.

• retweets (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Retweets) (defaults to: nil) —

  Retweet mode.

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

  Only retweets of this tweet ID.

• since_date (Date) (defaults to: nil) —

  Start date in YYYY-MM-DD format.

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

  Unix timestamp - return mentions after this time

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

  Filter replies sent to a username.

• until_date (Date) (defaults to: nil) —

  End date in YYYY-MM-DD format.

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

  Unix timestamp - return mentions before this time

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

  URL substring or domain filter.

• verified_only (Boolean) (defaults to: nil) —

  Only return tweets from verified authors.

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

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 195

Instance Attribute Details

#any_words ⇒ String^?

Words or quoted phrases where any one can match. Separate with spaces, commas, or lines.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :any_words, String

#cashtags ⇒ String^?

Cashtags separated by spaces, commas, or lines.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :cashtags, String

#conversation_id ⇒ String^?

Conversation ID filter.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :conversation_id, String

#cursor ⇒ String^?

Pagination cursor for mentions

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :cursor, String

#exact_phrase ⇒ String^?

Exact phrase to match.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :exact_phrase, String

#exclude_words ⇒ String^?

Words or quoted phrases to exclude. Separate with spaces, commas, or lines.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 51

optional :exclude_words, String

#from_user ⇒ String^?

Filter by author username.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 57

optional :from_user, String

#hashtags ⇒ String^?

Hashtags separated by spaces, commas, or lines.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 63

optional :hashtags, String

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#in_reply_to_tweet_id ⇒ String^?

Only replies to this tweet ID.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 69

optional :in_reply_to_tweet_id, String

#language ⇒ String^?

Language code filter, e.g. en or tr.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 75

optional :language, String

#media_type ⇒ Symbol, ...

Filter by media type.

Returns:

• (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::MediaType, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 81

optional :media_type, enum: -> { XTwitterScraper::X::UserRetrieveMentionsParams::MediaType }

#mentioning ⇒ String^?

Filter tweets mentioning a username.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 87

optional :mentioning, String

#min_faves ⇒ Integer^?

Minimum likes threshold.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :min_faves, Integer

#min_quotes ⇒ Integer^?

Minimum quote count threshold.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 99

optional :min_quotes, Integer

#min_replies ⇒ Integer^?

Minimum replies threshold.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 105

optional :min_replies, Integer

#min_retweets ⇒ Integer^?

Minimum retweets threshold.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 111

optional :min_retweets, Integer

#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)

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

optional :page_size, Integer

#quotes ⇒ Symbol, ...

Quote mode.

Returns:

• (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Quotes, nil)

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

optional :quotes, enum: -> { XTwitterScraper::X::UserRetrieveMentionsParams::Quotes }

#quotes_of_tweet_id ⇒ String^?

Only quotes of this tweet ID.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :quotes_of_tweet_id, String

#replies ⇒ Symbol, ...

Reply mode.

Returns:

• (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Replies, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 139

optional :replies, enum: -> { XTwitterScraper::X::UserRetrieveMentionsParams::Replies }

#retweets ⇒ Symbol, ...

Retweet mode.

Returns:

• (Symbol, XTwitterScraper::Models::X::UserRetrieveMentionsParams::Retweets, nil)

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

optional :retweets, enum: -> { XTwitterScraper::X::UserRetrieveMentionsParams::Retweets }

#retweets_of_tweet_id ⇒ String^?

Only retweets of this tweet ID.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 151

optional :retweets_of_tweet_id, String

#since_date ⇒ Date^?

Start date in YYYY-MM-DD format.

Parameters:

• (Date)

Returns:

• (Date, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 157

optional :since_date, Date

#since_time ⇒ String^?

Unix timestamp - return mentions after this time

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 163

optional :since_time, String

#to_user ⇒ String^?

Filter replies sent to a username.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 169

optional :to_user, String

#until_date ⇒ Date^?

End date in YYYY-MM-DD format.

Parameters:

• (Date)

Returns:

• (Date, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 175

optional :until_date, Date

#until_time ⇒ String^?

Unix timestamp - return mentions before this time

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 181

optional :until_time, String

#url ⇒ String^?

URL substring or domain filter.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 187

optional :url, String

#verified_only ⇒ Boolean^?

Only return tweets from verified authors.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 193

optional :verified_only, XTwitterScraper::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb', line 272

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbs', line 203

def to_hash: -> {