Module: GoogleMapsService::TimeZone

Included in:
Client
Defined in:
lib/google_maps_service/time_zone.rb

Overview

Performs requests to the Google Maps TimeZone API.“”“

Instance Method Summary collapse

Instance Method Details

#timezone(location: nil, timestamp: nil, language: nil) ⇒ Hash

Get time zone for a location on the earth, as well as that location’s time offset from UTC.

Parameters:

  • location (Hash, Array) (defaults to: nil) —

    The latitude/longitude value representing the location to look up.

  • timestamp (Integer, DateTime) (defaults to: nil) —

    Timestamp specifies the desired time as seconds since midnight, January 1, 1970 UTC. The Time Zone API uses the timestamp to determine whether or not Daylight Savings should be applied. Times before 1970 can be expressed as negative values. Optional. Defaults to “Time.now“.

  • language (String) (defaults to: nil) —

    The language in which to return results.

Returns:

  • (Hash) 


21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/google_maps_service/time_zone.rb', line 21

def timezone(location: nil,
             timestamp: nil, language: nil)
  location = GoogleMapsService::Convert.latlng(location)
  timestamp = GoogleMapsService::Convert.time(timestamp || Time.now)

  params = {
    location: location,
    timestamp: timestamp
  }

  params[:language] = language if language

  return get( "/maps/api/timezone/json", params)
end