Class: BingSearch::CompositeSearchResult

Inherits:
Result
  • Object
show all
Defined in:
lib/bing-search/models.rb

Instance Attributes for Results collapse

Instance Attribute Summary collapse

Attributes inherited from Result

#id

Method Summary

Methods inherited from Model

#initialize, #set

Constructor Details

This class inherits a constructor from BingSearch::Model

Instance Attribute Details

#alteration_override_queryString

Query text that forces the original query, preventing any alterations in #altered_query

Returns:

  • (String)


230
231
232
# File 'lib/bing-search/models.rb', line 230

def alteration_override_query
  @alteration_override_query
end

#altered_queryString

The query text after spelling errors have been corrected

Returns:

  • (String)


226
227
228
# File 'lib/bing-search/models.rb', line 226

def altered_query
  @altered_query
end

#imageArray<ImageResult>

Returns:



172
173
174
# File 'lib/bing-search/models.rb', line 172

def image
  @image
end

#image_offsetInteger?

The ordinal of the first image result

Returns:

  • (Integer, nil)


202
203
204
# File 'lib/bing-search/models.rb', line 202

def image_offset
  @image_offset
end

#image_totalInteger?

The number of image results in the Bing index

Returns:

  • (Integer, nil)


198
199
200
# File 'lib/bing-search/models.rb', line 198

def image_total
  @image_total
end

#newsArray<NewsResult>

Returns:



178
179
180
# File 'lib/bing-search/models.rb', line 178

def news
  @news
end

#news_offsetInteger?

The ordinal of the first news result

Returns:

  • (Integer, nil)


218
219
220
# File 'lib/bing-search/models.rb', line 218

def news_offset
  @news_offset
end

#news_totalInteger?

The number of news results in the Bing index

Returns:

  • (Integer, nil)


214
215
216
# File 'lib/bing-search/models.rb', line 214

def news_total
  @news_total
end

Returns:



181
182
183
# File 'lib/bing-search/models.rb', line 181

def related_search
  @related_search
end

#spelling_suggestionsArray<SpellingSuggestionsResult>

Returns:



184
185
186
# File 'lib/bing-search/models.rb', line 184

def spelling_suggestions
  @spelling_suggestions
end

#spelling_suggestions_totalInteger?

The number of spelling suggestions in the Bing index

Returns:

  • (Integer, nil)


222
223
224
# File 'lib/bing-search/models.rb', line 222

def spelling_suggestions_total
  @spelling_suggestions_total
end

#videoArray<VideoResult>

Returns:



175
176
177
# File 'lib/bing-search/models.rb', line 175

def video
  @video
end

#video_offsetInteger?

The ordinal of the first video result

Returns:

  • (Integer, nil)


210
211
212
# File 'lib/bing-search/models.rb', line 210

def video_offset
  @video_offset
end

#video_totalInteger?

The number of video results in the Bing index

Returns:

  • (Integer, nil)


206
207
208
# File 'lib/bing-search/models.rb', line 206

def video_total
  @video_total
end

#webArray<WebResult>

Returns:



169
170
171
# File 'lib/bing-search/models.rb', line 169

def web
  @web
end

#web_offsetInteger?

The ordinal of the first web result

Returns:

  • (Integer, nil)


194
195
196
# File 'lib/bing-search/models.rb', line 194

def web_offset
  @web_offset
end

#web_totalInteger?

The number of web results in the Bing index

Returns:

  • (Integer, nil)


190
191
192
# File 'lib/bing-search/models.rb', line 190

def web_total
  @web_total
end