Class: XTwitterScraper::Resources::X::Followers

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/x/followers.rb,
sig/x_twitter_scraper/resources/x/followers.rbs

Overview

Look up, search, and explore user profiles and relationships

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Followers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Followers.

Parameters:



40
41
42
 
# File 'lib/x_twitter_scraper/resources/x/followers.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#check(source:, target:, request_options: {}) ⇒ XTwitterScraper::Models::X::FollowerCheckResponse

Check if one user follows another

Parameters:

  • source (String) —

    Source username, @username, or X or Twitter profile URL

  • target (String) —

    Target username, @username, or X or Twitter profile URL

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

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/x_twitter_scraper/resources/x/followers.rb', line 25

def check(params)
  parsed, options = XTwitterScraper::X::FollowerCheckParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "x/followers/check",
    query: query,
    model: XTwitterScraper::Models::X::FollowerCheckResponse,
    options: options
  )
end