Class: RubyPtvApi::Operation::XLocate::FindLocations

Inherits:
Base
  • Object
show all
Defined in:
lib/ruby_ptv_api/operation/x_locate/find_locations.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#result_field_array, #search_option_base_array, #sort_option_array

Attributes inherited from Base

#coord_format, #profile

Instance Method Summary collapse

Methods inherited from Base

#additional_fields, #additional_fields=, #call, #extra_params, #options, #options=, #ptv_path, #sorting, #sorting=

Methods inherited from Base

#connection, #default_params, #demodulize, #demodulized_name, #endpoint, #parent_module_name, #post, #ptv_path, #underscore, #uri

Constructor Details

#initialize(locations) ⇒ FindLocations

Returns a new instance of FindLocations.



7
8
9
10
 
# File 'lib/ruby_ptv_api/operation/x_locate/find_locations.rb', line 7

def initialize(locations)
  raise 'Use FindLocation for single address' unless locations.is_a? Array
  @locations = locations
end

Instance Attribute Details

#locations ⇒ Object (readonly)

Returns the value of attribute locations.



5
6
7
 
# File 'lib/ruby_ptv_api/operation/x_locate/find_locations.rb', line 5

def locations
  @locations
end

Instance Method Details

#params ⇒ Object 



16
17
18
19
20
21
22
23
 
# File 'lib/ruby_ptv_api/operation/x_locate/find_locations.rb', line 16

def params
  { 
    location: locations,
    options: options,
    sorting: sorting,
    additionalFields: additional_fields
  }
end

#ptv_function ⇒ Object 



12
13
14
 
# File 'lib/ruby_ptv_api/operation/x_locate/find_locations.rb', line 12

def ptv_function
  'findLocations'
end