flickrex v0.3.0 Flickr.Contacts

Summary

Functions

Get a list of contacts for the calling user

Return a list of contacts for a user who have recently uploaded photos along with the total count of photos uploaded.

Get the contact list for a user

Get suggestions for tagging people in photos based on the calling user’s contacts

Types

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

Functions

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

Get a list of contacts for the calling user.

This method requires authentication with “read” permission.

Arguments

  • filter - An optional filter of the results. The following values are valid:
     

    friends
    Only contacts who are friends (and not family)
    family
    Only contacts who are family (and not friends)
    both
    Only contacts who are both friends and family
    neither
    Only contacts who are neither friends nor family

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

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

  • sort - The order in which to sort the returned contacts. Defaults to name. The possible values are: name and time.

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

Return a list of contacts for a user who have recently uploaded photos along with the total count of photos uploaded.

This method is still considered experimental. We don’t plan for it to change or to go away but so long as this notice is present you should write your code accordingly.

This method requires authentication with “read” permission.

Arguments

  • date_lastupload - Limits the resultset to contacts that have uploaded photos since this date. The date should be in the form of a Unix timestamp. The default offset is (1) hour and the maximum (24) hours.

  • filter - Limit the result set to all contacts or only those who are friends or family. Valid options are:

    • ff friends and family
    • all all your contacts
    Default value is “all”.

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

Get the contact list for a user.

This method does not require authentication.

Arguments

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

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

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

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

Get suggestions for tagging people in photos based on the calling user’s contacts.

This method requires authentication with “read” permission.

Arguments

  • per_page - Number of contacts to return per page. If this argument is omitted, all contacts will be returned.

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