Documentation home page

CFlickr.photos.geo
Component GeoInterface

AbstractInterface
  |
  +--photos.geo.GeoInterface

Method Summary
public Location getLocation(string photo_id)
Get the geo data (latitude and longitude and the accuracy level) for a photo.
public Permission getPerms(string photo_id)
Get permissions for who may view geo data for a photo.
public void removeLocation(string photo_id)
Removes the geo data associated with a photo.
public void setLocation(string photo_id, numeric lat, numeric lon, [numeric accuracy])
Sets the geo data (latitude and longitude and, optionally, the accuracy level) for a photo. Before users may assign location data to a photo they must define who, by default, may view that information. Users can edit this preference at http://www.flickr.com/account/geo/privacy/. If a user has not set this preference, the API method will return an error.
public void setPerms(string photo_id, boolean is_public, boolean is_contact, boolean is_friend, boolean is_family)
Set the permission for who may view the geo data associated with a photo.

Methods inherited from AbstractInterface
init
 

Method Detail

getLocation

public CFlickr.photos.geo.Location getLocation(string photo_id)
Get the geo data (latitude and longitude and the accuracy level) for a photo.

Parameters:
string photo_id (Required) - The id of the photo you want to retrieve location data for.

getPerms

public CFlickr.photos.Permission getPerms(string photo_id)
Get permissions for who may view geo data for a photo.

Parameters:
string photo_id (Required) - The id of the photo to get permissions for.

removeLocation

public void removeLocation(string photo_id)
Removes the geo data associated with a photo.

Parameters:
string photo_id (Required) - The id of the photo you want to remove location data from.

setLocation

public void setLocation(string photo_id, numeric lat, numeric lon, [numeric accuracy])
Sets the geo data (latitude and longitude and, optionally, the accuracy level) for a photo. Before users may assign location data to a photo they must define who, by default, may view that information. Users can edit this preference at http://www.flickr.com/account/geo/privacy/. If a user has not set this preference, the API method will return an error.

Parameters:
string photo_id (Required) - The id of the photo to set location data for.
numeric lat (Required) - The latitude whose valid range is -90 to 90. Anything more than 6 decimal places will be truncated.
numeric lon (Required) - The longitude whose valid range is -180 to 180. Anything more than 6 decimal places will be truncated.
numeric accuracy (Optional) - Recorded accuracy level of the location information. World level is 1, Country is ~3, Region ~6, City ~11, Street ~16. Current range is 1-16. Defaults to 16 if not specified.

setPerms

public void setPerms(string photo_id, boolean is_public, boolean is_contact, boolean is_friend, boolean is_family)
Set the permission for who may view the geo data associated with a photo.

Parameters:
string photo_id (Required) - The id of the photo to get permissions for.
boolean is_public (Required) - true to set viewing permissions for the photo's location data to public, false to set it to private.
boolean is_contact (Required) - true to set viewing permissions for the photo's location data to contacts, false to set it to private.
boolean is_friend (Required) - true to set viewing permissions for the photo's location data to friends, false to set it to private.
boolean is_family (Required) - true to set viewing permissions for the photo's location data to family, false to set it to private.