module FoursquareNext::Checkins

Public Instance Methods

add_checkin(options = {}) click to toggle source

Checkin on behalf of the user.

@param [Hash] options @option options String :venueId - Venue for the checkin. @option options String :venue - For venueless checkins (name or other identifier) @option options String :shout - Message to be included with the checkin. @option options String :broadcast - Required, one or more of private,public,facebook,twitter. Comma-separated. @option options String :ll - Latitude and longitude in format LAT,LON @option options Integer :llAcc - Accuracy of the lat/lon in meters. @option options Integer :alt - Altitude in meters @option options Integer :altAcc - Accuracy of the altitude in meters

# File lib/foursquare_next/checkins.rb, line 43
def add_checkin(options = {})
  response = connection.post do |req|
    req.url "checkins/add", options
  end
  return_error_or_body(response, response.body.response.checkin)
end
add_checkin_comment(checkin_id, options = {}) click to toggle source

Add a comment to a checkin.

@param [String] checkin_id the ID of the checkin. @param [Hash] options @option options String :text - Text of the comment to add, 200 character max.

# File lib/foursquare_next/checkins.rb, line 56
def add_checkin_comment(checkin_id, options = {})
  response = connection.post do |req|
    req.url "checkins/#{checkin_id}/addcomment", options
  end
  return_error_or_body(response, response.body.response)
end
add_checkin_post(checkin_id, options = {}) click to toggle source

Add a post to a checkin.

@param [String] checkin_id the ID of the checkin. @param [Hash] options @option options String :text - The text of the post, up to 200 characters. @option options String :url - Link for more details. This page will be opened in an embedded web view in the foursquare application, unless contentId is specified and a native link handler is registered and present. We support the following URL schemes: http, https, foursquare, mailto, tel, and sms. @option options String :contentId - Identifier for the post to be used in a native link, up to 50 characters. A url must also be specified in the request.

# File lib/foursquare_next/checkins.rb, line 84
def add_checkin_post(checkin_id, options = {})
  response = connection.post do |req|
    req.url "checkins/#{checkin_id}/addpost", options
  end
  return_error_or_body(response, response.body.response.post)
end
add_checkin_reply(checkin_id, options = {}) click to toggle source

Add a reply to a checkin.

@param [String] checkin_id the ID of the checkin. @param [Hash] options @option options String :text - The text of the post, up to 200 characters. @option options String :url - Link for more details. This page will be opened in an embedded web view in the foursquare application, unless contentId is specified and a native link handler is registered and present. We support the following URL schemes: http, https, foursquare, mailto, tel, and sms. @option options String :contentId - Identifier for the post to be used in a native link, up to 50 characters. A url must also be specified in the request.

# File lib/foursquare_next/checkins.rb, line 99
def add_checkin_reply(checkin_id, options = {})
  response = connection.post do |req|
    req.url "checkins/#{checkin_id}/reply", options
  end
  return_error_or_body(response, response.body.response.reply)
end
checkin(checkin_id, options = {}) click to toggle source

Retrieve information about a single checkin.

@param [String] checkin_id the ID of the checkin. @param [Hash] options @option options String :signature - Signature allowing users to bypass the friends-only access check on checkins

# File lib/foursquare_next/checkins.rb, line 10
def checkin(checkin_id, options = {})
  response = connection.get do |req|
    req.url "checkins/#{checkin_id}", options
  end
  return_error_or_body(response, response.body.response.checkin)
end
delete_checkin_comment(checkin_id, options = {}) click to toggle source

Delete a checkin's comment

@param [String] checkin_id - The ID of the checkin @param [Hash] options @option options String :commentId - ID of the comment to be deleted.

# File lib/foursquare_next/checkins.rb, line 69
def delete_checkin_comment(checkin_id, options = {})
  response = connection.post do |req|
    req.url "checkins/#{checkin_id}/deletecomment", options
  end
  return_error_or_body(response, response.body.response)
end
recent_checkins(options = {}) click to toggle source

Retrieve a list of recent checkins from friends.

@param [Hash] options @option options String :ll - Latitude and longitude in format LAT,LON @option options String :limit - Maximum results to return (max 100) @option options Integer :afterTimestamp - Seconds after which to look for checkins

# File lib/foursquare_next/checkins.rb, line 24
def recent_checkins(options = {})
  response = connection.get do |req|
    req.url "checkins/recent", options
  end
  return_error_or_body(response, response.body.response.recent)
end