Class: Twitter::SearchResults

Inherits:

Object

• Object
• Twitter::SearchResults

Includes:

Enumerable, Utils

Defined in:

lib/twitter/search_results.rb

Overview

Represents search results from Twitter

Instance Attribute Summary

• #attrs ⇒ Twitter::RateLimit (also: #to_h) readonly

  The rate limit information from the response.

• #rate_limit ⇒ Twitter::RateLimit readonly

  The rate limit information from the response.

Instance Method Summary

• #initialize(request) ⇒ Twitter::SearchResults constructor

  Initializes a new SearchResults object.

Methods included from Utils

flat_pmap, pmap

Methods included from Enumerable

#each

Constructor Details

#initialize(request) ⇒ Twitter::SearchResults

Initializes a new SearchResults object

Examples:

Twitter::SearchResults.new(request)

Parameters:

• request (Twitter::REST::Request) —

  The request object

# File 'lib/twitter/search_results.rb', line 51

def initialize(request)
  @client = request.client
  @request_method = request.verb
  @path = request.path
  @options = request.options
  @collection = []
  self.attrs = request.perform
end

Instance Attribute Details

#attrs ⇒ Twitter::RateLimit Also known as: to_h

The rate limit information from the response

Examples:

results.rate_limit

Returns:

• (Twitter::RateLimit)

# File 'lib/twitter/search_results.rb', line 26

def attrs
  @attrs
end

#rate_limit ⇒ Twitter::RateLimit (readonly)

The rate limit information from the response

Examples:

results.rate_limit

Returns:

• (Twitter::RateLimit)

# File 'lib/twitter/search_results.rb', line 26

def rate_limit
  @rate_limit
end