flickrex v0.3.0 Flickr.Favorites

Summary

Functions

Adds a photo to a user’s favorites list

Returns next and previous favorites for a photo in a user’s favorites

Returns a list of the user’s favorite photos. Only photos which the calling user has permission to see are returned

Returns a list of favorite public photos for the given user

Removes a photo from a user’s favorites list

Types

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

Functions

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

Adds a photo to a user’s favorites list.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to add to the user’s favorites.
get_context(client, args \\ [])
get_context(client, args) :: response

Returns next and previous favorites for a photo in a user’s favorites.

This method does not require authentication.

Arguments

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

  • user_id - (required) The user who counts the photo as a favorite.

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

Returns a list of the user’s favorite photos. Only photos which the calling user has permission to see are returned.

This method does not require authentication.

Arguments

  • user_id - The NSID of the user to fetch the favorites list for. If this argument is omitted, the favorites list for the calling user is returned.

  • min_fave_date - Minimum date that a photo was favorited on. The date should be in the form of a unix timestamp.

  • max_fave_date - Maximum date that a photo was favorited on. The date should be in the form of a unix timestamp.

  • 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_public_list(client, args \\ [])
get_public_list(client, args) :: response

Returns a list of favorite public photos for the given user.

This method does not require authentication.

Arguments

  • user_id - (required) The user to fetch the favorites list for.

  • min_fave_date - Minimum date that a photo was favorited on. The date should be in the form of a unix timestamp.

  • max_fave_date - Maximum date that a photo was favorited on. The date should be in the form of a unix timestamp.

  • 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(client, args \\ [])
remove(client, args) :: response

Removes a photo from a user’s favorites list.

This method requires authentication with “write” permission.

Arguments

  • photo_id - (required) The id of the photo to remove from the user’s favorites.