flickrex v0.3.0 Flickr.Photos.Geo

Summary

Functions

Correct the places hierarchy for all the photos for a user at a given latitude, longitude and accuracy.

Get the geo data (latitude and longitude and the accuracy level) for a photo

Get permissions for who may view geo data for a photo

Return a list of photos for the calling user at a specific latitude, longitude and accuracy

Removes the geo data associated with a photo

Indicate the state of a photo’s geotagginess beyond latitude and longitude.

Note : photos passed to this method must already be geotagged (using the flickr.photos.geo.setLocation method)

Sets the geo data (latitude and longitude and, optionally, the accuracy level) for a photo

Set the permission for who may view the geo data associated with a photo

Types

args()
args() :: Keyword.t
client()
client() :: Flickrex.Client.t
response()
response() :: Flickrex.Parser.response

Functions

batch_correct_location(client, args \\ [])
batch_correct_location(client, args) :: response

Correct the places hierarchy for all the photos for a user at a given latitude, longitude and accuracy.

Batch corrections are processed in a delayed queue so it may take a few minutes before the changes are reflected in a user’s photos.

This method requires authentication with “write” permission.

Arguments

  • lat - (required) The latitude of the photos to be update whose valid range is -90 to 90. Anything more than 6 decimal places will be truncated.

  • lon - (required) The longitude of the photos to be updated whose valid range is -180 to 180. Anything more than 6 decimal places will be truncated.

  • accuracy - (required) Recorded accuracy level of the photos to be updated. World level is 1, Country is ~3, Region ~6, City ~11, Street ~16. Current range is 1-16. Defaults to 16 if not specified.

  • place_id - A Flickr Places ID. (While optional, you must pass either a valid Places ID or a WOE ID.)

  • woe_id - A Where On Earth (WOE) ID. (While optional, you must pass either a valid Places ID or a WOE ID.)

correct_location(client, args \\ [])
correct_location(client, args) :: response

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The ID of the photo whose WOE location is being corrected.

  • place_id - A Flickr Places ID. (While optional, you must pass either a valid Places ID or a WOE ID.)

  • woe_id - A Where On Earth (WOE) ID. (While optional, you must pass either a valid Places ID or a WOE ID.)

  • foursquare_id - (required) The venue ID for a Foursquare location. (If not passed in with correction, any existing foursquare venue will be removed).

get_location(client, args \\ [])
get_location(client, args) :: response

Get the geo data (latitude and longitude and the accuracy level) for a photo.

This method does not require authentication.

Arguments

  • photo_id - (required) The id of the photo you want to retrieve location data for.

  • extras - Extra flags.

get_perms(client, args \\ [])
get_perms(client, args) :: response

Get permissions for who may view geo data for a photo.

This method requires authentication with “read” permission.

Arguments

  • photo_id - (required) The id of the photo to get permissions for.
photos_for_location(client, args \\ [])
photos_for_location(client, args) :: response

Return a list of photos for the calling user at a specific latitude, longitude and accuracy

This method requires authentication with “read” permission.

Arguments

  • lat - (required) The latitude whose valid range is -90 to 90. Anything more than 6 decimal places will be truncated.

  • lon - (required) The longitude whose valid range is -180 to 180. Anything more than 6 decimal places will be truncated.

  • accuracy - 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.

  • extras - A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o

  • per_page - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

  • page - The page of results to return. If this argument is omitted, it defaults to 1.

remove_location(client, args \\ [])
remove_location(client, args) :: response

Removes the geo data associated with a photo.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo you want to remove location data from.
set_context(client, args \\ [])
set_context(client, args) :: response

Indicate the state of a photo’s geotagginess beyond latitude and longitude.

Note : photos passed to this method must already be geotagged (using the flickr.photos.geo.setLocation method).

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to set context data for.

  • context - (required) Context is a numeric value representing the photo’s geotagginess beyond latitude and longitude. For example, you may wish to indicate that a photo was taken “indoors” or “outdoors”.

    The current list of context IDs is :

    • 0, not defined.
    • 1, indoors.
    • 2, outdoors.

set_location(client, args \\ [])
set_location(client, args) :: response

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.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to set location data for.

  • lat - (required) The latitude whose valid range is -90 to 90. Anything more than 6 decimal places will be truncated.

  • lon - (required) The longitude whose valid range is -180 to 180. Anything more than 6 decimal places will be truncated.

  • accuracy - 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.

  • context - Context is a numeric value representing the photo’s geotagginess beyond latitude and longitude. For example, you may wish to indicate that a photo was taken “indoors” or “outdoors”.

    The current list of context IDs is :

    • 0, not defined.
    • 1, indoors.
    • 2, outdoors.

    The default context for geotagged photos is 0, or “not defined”

set_perms(client, args \\ [])
set_perms(client, args) :: response

Set the permission for who may view the geo data associated with a photo.

This method requires authentication with “write” permission.

Arguments

  • is_public - (required) 1 to set viewing permissions for the photo’s location data to public, 0 to set it to private.

  • is_contact - (required) 1 to set viewing permissions for the photo’s location data to contacts, 0 to set it to private.

  • is_friend - (required) 1 to set viewing permissions for the photo’s location data to friends, 0 to set it to private.

  • is_family - (required) 1 to set viewing permissions for the photo’s location data to family, 0 to set it to private.

  • photo_id - (required) The id of the photo to get permissions for.