Flickrex.Flickr.Photos.People (flickrex v0.8.1) View Source

Link to this section Summary

Types

arg()

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.

delete(photo_id, user_id, opts \\ [])

Remove a person from a photo.

delete_coords(photo_id, user_id, opts \\ [])

Remove the bounding box from a person in a photo

edit_coords(photo_id, user_id, person_x, person_y, person_w, person_h, opts \\ [])

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

get_list(photo_id, opts \\ [])

Get a list of people in a given photo.

Link to this section Types

arg()

Specs

arg() :: String.Chars.t()

operation()

Specs

operation() :: Flickrex.Operation.Rest.t()

opts()

Specs

opts() :: Flickrex.Rest.args()

Link to this section Functions

add(photo_id, user_id, opts \\ [])

Specs

add(arg(), arg(), opts()) :: operation()

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 - The id of the photo to add a person to.
user_id - The NSID of the user to add to the photo.

Options

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(photo_id, user_id, opts \\ [])

Specs

delete(arg(), arg(), opts()) :: operation()

Remove a person from a photo.

This method requires authentication with "write" permission.

Arguments

photo_id - The id of the photo to remove a person from.
user_id - The NSID of the person to remove from the photo.

delete_coords(photo_id, user_id, opts \\ [])

Specs

delete_coords(arg(), arg(), opts()) :: operation()

Remove the bounding box from a person in a photo

This method requires authentication with "write" permission.

Arguments

photo_id - The id of the photo to edit a person in.
user_id - The NSID of the person whose bounding box you want to remove.

edit_coords(photo_id, user_id, person_x, person_y, person_w, person_h, opts \\ [])

Specs

edit_coords(arg(), arg(), arg(), arg(), arg(), arg(), opts()) :: operation()

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

This method requires authentication with "write" permission.

Arguments

photo_id - The id of the photo to edit a person in.
user_id - The NSID of the person to edit in a 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.

get_list(photo_id, opts \\ [])

Specs

get_list(arg(), opts()) :: operation()

Get a list of people in a given photo.

This method does not require authentication.

Arguments

photo_id - The id of the photo to get a list of people for.

Example response

%{
  "people" => %{
    "person" => %{
      "added_by" => "12037949754@N01",
      "h" => "100",
      "iconfarm" => "1",
      "iconserver" => "1",
      "nsid" => "87944415@N00",
      "realname" => "Simon Batistoni",
      "username" => "hitherto",
      "w" => "100",
      "x" => "50",
      "y" => "50"
    },
    "total" => "1"
  },
  "stat" => "ok"
}