flickrex v0.3.0 Flickr.People

Summary

Functions

Return a user’s NSID, given their email address

Return a user’s NSID, given their username

Returns the list of groups a user is a member of

Get information about a user

Returns the photo and video limits that apply to the calling user account

Return photos from the given user’s photostream. Only photos visible to the calling user will be returned. This method must be authenticated; to return public photos for a user, use flickr.people.getPublicPhotos

Returns a list of photos containing a particular Flickr member

Returns the list of public groups a user is a member of

Get a list of public photos for the given user

Returns information for the calling user related to photo uploads

Types

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

Functions

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

Return a user’s NSID, given their email address

This method does not require authentication.

Arguments

  • find_email - (required) The email address of the user to find (may be primary or secondary).
find_by_username(client, args \\ [])
find_by_username(client, args) :: response

Return a user’s NSID, given their username.

This method does not require authentication.

Arguments

  • username - (required) The username of the user to lookup.
get_groups(client, args \\ [])
get_groups(client, args) :: response

Returns the list of groups a user is a member of.

This method requires authentication with “read” permission.

Arguments

  • user_id - (required) The NSID of the user to fetch groups for.

  • extras - A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: privacy, throttle, restrictions

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

Get information about a user.

This method does not require authentication.

Arguments

  • user_id - (required) The NSID of the user to fetch information about.
get_limits(client, args \\ [])
get_limits(client, args) :: response

Returns the photo and video limits that apply to the calling user account.

This method requires authentication with “read” permission.

Arguments

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

Return photos from the given user’s photostream. Only photos visible to the calling user will be returned. This method must be authenticated; to return public photos for a user, use flickr.people.getPublicPhotos.

This method does not require authentication.

Arguments

  • user_id - (required) The NSID of the user who’s photos to return. A value of “me” will return the calling user’s photos.

  • safe_search - Safe search setting:

    • 1 for safe.
    • 2 for moderate.
    • 3 for restricted.
    (Please note: Un-authed calls can only see Safe content.)

  • min_upload_date - Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.

  • max_upload_date - Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.

  • min_taken_date - Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.

  • max_taken_date - Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.

  • content_type - Content Type setting:

    • 1 for photos only.
    • 2 for screenshots only.
    • 3 for ‘other’ only.
    • 4 for photos and screenshots.
    • 5 for screenshots and ‘other’.
    • 6 for photos and ‘other’.
    • 7 for photos, screenshots, and ‘other’ (all).

  • privacy_filter - Return photos only matching a certain privacy level. This only applies when making an authenticated call to view photos you own. Valid values are:

    • 1 public photos
    • 2 private photos visible to friends
    • 3 private photos visible to family
    • 4 private photos visible to friends & family
    • 5 completely private photos

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

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

Returns a list of photos containing a particular Flickr member.

This method does not require authentication.

Arguments

  • user_id - (required) The NSID of the user you want to find photos of. A value of “me” will search against photos of the calling user, for authenticated calls.

  • owner_id - An NSID of a Flickr member. This will restrict the list of photos to those taken by that member.

  • extras - A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, date_person_added, 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.

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

Returns the list of public groups a user is a member of.

This method does not require authentication.

Arguments

  • user_id - (required) The NSID of the user to fetch groups for.

  • invitation_only - Include public groups that require an invitation or administrator approval to join.

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

Get a list of public photos for the given user.

This method does not require authentication.

Arguments

  • user_id - (required) The NSID of the user who’s photos to return.

  • safe_search - Safe search setting:

    • 1 for safe.
    • 2 for moderate.
    • 3 for restricted.
    (Please note: Un-authed calls can only see Safe content.)

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

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

Returns information for the calling user related to photo uploads.

This method requires authentication with “read” permission.

Arguments