flickrex v0.3.0 Flickr.Photos.People

Summary

Functions

Add a person to a photo. Coordinates and sizes of boxes are optional; they are measured in pixels, based on the 500px image size shown on individual photo pages

Remove a person from a photo

Remove the bounding box from a person in a photo

Edit the bounding box of an existing person on a photo

Get a list of people in a given photo

Types

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

Functions

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

Add a person to a photo. Coordinates and sizes of boxes are optional; they are measured in pixels, based on the 500px image size shown on individual photo pages.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to add a person to.

  • user_id - (required) The NSID of the user to add to the photo.

  • person_x - The left-most pixel co-ordinate of the box around the person.

  • person_y - The top-most pixel co-ordinate of the box around the person.

  • person_w - The width (in pixels) of the box around the person.

  • person_h - The height (in pixels) of the box around the person.

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

Remove a person from a photo.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to remove a person from.

  • user_id - (required) The NSID of the person to remove from the photo.

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

Remove the bounding box from a person in a photo

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to edit a person in.

  • user_id - (required) The NSID of the person whose bounding box you want to remove.

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

Edit the bounding box of an existing person on a photo.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to edit a person in.

  • user_id - (required) The NSID of the person to edit in a photo.

  • person_x - (required) The left-most pixel co-ordinate of the box around the person.

  • person_y - (required) The top-most pixel co-ordinate of the box around the person.

  • person_w - (required) The width (in pixels) of the box around the person.

  • person_h - (required) The height (in pixels) of the box around the person.

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

Get a list of people in a given photo.

This method does not require authentication.

Arguments

  • photo_id - (required) The id of the photo to get a list of people for.