module Instagram::Client::Locations
Defines methods related to media items
Public Instance Methods
location(id, *args)
click to toggle source
Returns extended information of a given Instagram
location
@overload location(id)
@param location [Integer] An Instagram location ID @return [Hashie::Mash] The requested location. @example Return extended information for the Instagram office Instagram.location(514276)
@format :json @authenticated false @rate_limited true @see instagram.com/developer/endpoints/locations/#get_locations
# File lib/instagram/client/locations.rb, line 16 def location(id, *args) response = get("locations/#{id}") response end
location_recent_media(id, *args)
click to toggle source
Returns a list of recent media items for a given Instagram
location
@overload location_recent_media
(id, options={})
@param user [Integer] An Instagram location ID. @param options [Hash] A customizable set of options. @option options [Integer] :max_timestamp (nil) Return media before this UNIX timestamp @option options [Integer] :max_id (nil) Returns results with an ID less than (that is, older than) or equal to the specified ID. @option options [Integer] :count (nil) Limits the number of results returned per page. @return [Hashie::Mash] @example Return a list of the most recent media items taken at the Instagram office Instagram.location_recent_media(514276)
@see instagram.com/developer/endpoints/locations/#get_locations_media_recent @format :json @authenticated false @rate_limited true
# File lib/instagram/client/locations.rb, line 36 def location_recent_media(id, *args) options = args.last.is_a?(Hash) ? args.pop : {} response = get("locations/#{id}/media/recent", options) response end
location_search(*args)
click to toggle source
Returns Instagram
locations within proximity of given lat,lng or Facebook Places ID
@overload location_search
(options={})
@param facebook_places_id [String] A valid Facebook Places ID @param lat [String] A given latitude in decimal format @param lng [String] A given longitude in decimal format @option options [Integer] :count The number of media items to retrieve. @return [Hashie::Mash] location resultm object, #data is an Array. @example 1: Return a location with the Facebook Places ID = () Instagram.location_search("3fd66200f964a520c5f11ee3") (Schiller's Liquor Bar, 131 Rivington St., NY, NY 10002) @example 2: Return locations around 37.7808851, -122.3948632 (164 S Park, SF, CA USA) Instagram.location_search("37.7808851", "-122.3948632")
@see instagram.com/developer/endpoints/locations/#get_locations_search @format :json @authenticated false @rate_limited true
# File lib/instagram/client/locations.rb, line 58 def location_search(*args) options = args.last.is_a?(Hash) ? args.pop : {} case args.size when 1 facebook_places_id = args.first response = get('locations/search', options.merge(:facebook_places_id => facebook_places_id)) when 2 lat, lng = args response = get('locations/search', options.merge(:lat => lat, :lng => lng)) when 3 lat, lng, distance = args response = get('locations/search', options.merge(:lat => lat, :lng => lng, :distance => distance)) end response end