Class: Algolia::BaseIterator

Inherits:
Object
  • Object
show all
Includes:
Enumerable, Helpers
Defined in:
lib/algolia/iterators/base_iterator.rb

Direct Known Subclasses

ObjectIterator, PaginatorIterator

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#check_array, #check_object, #chunk, #deserialize_settings, #get_object_id, #get_option, #handle_params, #hash_includes_subset?, included, #json_to_hash, #path_encode, #symbolize_hash, #to_json, #to_query_string

Constructor Details

#initialize(transporter, index_name, opts) ⇒ BaseIterator

Returns a new instance of BaseIterator.

Parameters:

  • transporter (Transport::Transport) —

    transporter used for requests

  • index_name (String) —

    Name of the index

  • opts (Hash) —

    contains extra parameters to send with your query



12
13
14
15
16
17
 
# File 'lib/algolia/iterators/base_iterator.rb', line 12

def initialize(transporter, index_name, opts)
  @transporter = transporter
  @index_name  = index_name
  @opts        = opts
  @response    = nil
end

Instance Attribute Details

#index_name ⇒ Object (readonly)

Returns the value of attribute index_name.



6
7
8
 
# File 'lib/algolia/iterators/base_iterator.rb', line 6

def index_name
  @index_name
end

#opts ⇒ Object (readonly)

Returns the value of attribute opts.



6
7
8
 
# File 'lib/algolia/iterators/base_iterator.rb', line 6

def opts
  @opts
end

#transporter ⇒ Object (readonly)

Returns the value of attribute transporter.



6
7
8
 
# File 'lib/algolia/iterators/base_iterator.rb', line 6

def transporter
  @transporter
end