Class: QueryBuilder

Inherits:

Struct

• Object
• Struct
• QueryBuilder

Defined in:

lib/search_tools.rb

Overview

A struct which represents a query to a search engine.

See Also:

• SearchEngines::ISO3166

Author:

• Shreyan Jain

Instance Attribute Summary

• #count ⇒ Integer

  The number of results to return.

• #market ⇒ String

  The market to search in, as defined by ISO 3166.

• #offset ⇒ Integer

  The offset of the search results, you might think of this as the page number.

• #query ⇒ String

  The string being searched for.

• #safesearch ⇒ Boolean

  Whether to use safe search or not.

Instance Attribute Details

#count ⇒ Integer

Returns the number of results to return. Usually Ten Blue Ones ;).

Returns:

• (Integer) —

  the number of results to return. Usually Ten Blue Ones ;)

# File 'lib/search_tools.rb', line 22

QueryBuilder = Struct.new(:query, :market, :safesearch, :offset, :count)

#market ⇒ String

Returns the market to search in, as defined by ISO 3166. See SearchEngines::ISO3166.

Returns:

• (String) —

  the market to search in, as defined by ISO 3166. See SearchEngines::ISO3166

# File 'lib/search_tools.rb', line 22

QueryBuilder = Struct.new(:query, :market, :safesearch, :offset, :count)

#offset ⇒ Integer

Returns the offset of the search results, you might think of this as the page number. Used for pagination.

Returns:

• (Integer) —

  the offset of the search results, you might think of this as the page number. Used for pagination.

# File 'lib/search_tools.rb', line 22

QueryBuilder = Struct.new(:query, :market, :safesearch, :offset, :count)

#query ⇒ String

Returns the string being searched for.

Returns:

• (String) —

  the string being searched for.

# File 'lib/search_tools.rb', line 22

QueryBuilder = Struct.new(:query, :market, :safesearch, :offset, :count)

#safesearch ⇒ Boolean

Returns whether to use safe search or not.

Returns:

• (Boolean) —

  whether to use safe search or not.

# File 'lib/search_tools.rb', line 22

QueryBuilder = Struct.new(:query, :market, :safesearch, :offset, :count)