Class: YahooVideo::SearchResponse

Inherits:
Record
  • Object
show all
Defined in:
lib/yahoo-video.rb

Overview

Describes a response to a Yahoo! Video search executed via Client#search. Parameters are passed to the constructor as hash key/value pairs.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Record

#initialize

Constructor Details

This class inherits a constructor from YahooVideo::Record

Instance Attribute Details

#first_result_position ⇒ Object (readonly)

the position of the first result in the overall search.



183
184
185
 
# File 'lib/yahoo-video.rb', line 183

def first_result_position
  @first_result_position
end

#results ⇒ Object (readonly)

the list of zero or more SearchResult records comprising the results of the executed search query.



187
188
189
 
# File 'lib/yahoo-video.rb', line 187

def results
  @results
end

#total_results_available ⇒ Object (readonly)

the number of query matches in the database.



190
191
192
 
# File 'lib/yahoo-video.rb', line 190

def total_results_available
  @total_results_available
end

#total_results_returned ⇒ Object (readonly)

the number of query matches returned. this may be lower than the number of results requested if there were fewer total results available.



194
195
196
 
# File 'lib/yahoo-video.rb', line 194

def total_results_returned
  @total_results_returned
end