flickrex v0.3.0 Flickr.Photosets

Summary

Functions

Add a photo to the end of an existing photoset

Create a new photoset for the calling user

Delete a photoset

Modify the meta-data for a photoset

Modify the photos in a photoset. Use this method to add, remove and re-order photos

Returns next and previous photos for a photo in a set

Gets information about a photoset

Returns the photosets belonging to the specified user

Get the list of photos in a set

Set the order of photosets for the calling user

Remove a photo from a photoset

Remove multiple photos from a photoset

Set photoset primary photo

Types

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

Functions

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

Add a photo to the end of an existing photoset.

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to add a photo to.

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

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

Create a new photoset for the calling user.

This method requires authentication with “write” permission.

Arguments

  • title - (required) A title for the photoset.

  • description - A description of the photoset. May contain limited html.

  • primary_photo_id - (required) The id of the photo to represent this set. The photo must belong to the calling user.

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

Delete a photoset.

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to delete. It must be owned by the calling user.
edit_meta(client, args \\ [])
edit_meta(client, args) :: response

Modify the meta-data for a photoset.

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to modify.

  • title - (required) The new title for the photoset.

  • description - A description of the photoset. May contain limited html.

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

Modify the photos in a photoset. Use this method to add, remove and re-order photos.

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to modify. The photoset must belong to the calling user.

  • primary_photo_id - (required) The id of the photo to use as the ‘primary’ photo for the set. This id must also be passed along in photo_ids list argument.

  • photo_ids - (required) A comma-delimited list of photo ids to include in the set. They will appear in the set in the order sent. This list must contain the primary photo id. All photos must belong to the owner of the set. This list of photos replaces the existing list. Call flickr.photosets.addPhoto to append a photo to a set.

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

Returns next and previous photos for a photo in a set.

This method does not require authentication.

Arguments

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

  • photoset_id - (required) The id of the photoset for which to fetch the photo’s context.

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

Gets information about a photoset.

This method does not require authentication.

Arguments

  • photoset_id - (required) The ID of the photoset to fetch information for.

  • user_id - (required) The user_id here is the owner of the set passed in photoset_id. This is optional, but passing this gives better performance.

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

Returns the photosets belonging to the specified user.

This method does not require authentication.

Arguments

  • user_id - The NSID of the user to get a photoset list for. If none is specified, the calling user is assumed.

  • page - The page of results to get. Currently, if this is not provided, all sets are returned, but this behaviour may change in future.

  • per_page - The number of sets to get per page. If paging is enabled, the maximum number of sets per page is 500.

  • primary_photo_extras - A comma-delimited list of extra information to fetch for the primary photo. Currently supported fields are: 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_m, url_o

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

Get the list of photos in a set.

This method does not require authentication.

Arguments

  • photoset_id - (required) The id of the photoset to return the photos for.

  • user_id - (required) The user_id here is the owner of the set passed in photoset_id. This is optional, but passing this gives better performance.

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

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

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

  • privacy_filter - Return photos only matching a certain privacy level. This only applies when making an authenticated call to view a photoset 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

  • media - Filter results by media type. Possible values are all (default), photos or videos

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

Set the order of photosets for the calling user.

This method requires authentication with “write” permission.

Arguments

  • photoset_ids - (required) A comma delimited list of photoset IDs, ordered with the set to show first, first in the list. Any set IDs not given in the list will be set to appear at the end of the list, ordered by their IDs.
remove_photo(client, args \\ [])
remove_photo(client, args) :: response

Remove a photo from a photoset.

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to remove a photo from.

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

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

Remove multiple photos from a photoset.

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to remove photos from.

  • photo_ids - (required) Comma-delimited list of photo ids to remove from the photoset.

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

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to reorder. The photoset must belong to the calling user.

  • photo_ids - (required) Ordered, comma-delimited list of photo ids. Photos that are not in the list will keep their original order

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

Set photoset primary photo

This method requires authentication with “write” permission.

Arguments

  • photoset_id - (required) The id of the photoset to set primary photo to.

  • photo_id - (required) The id of the photo to set as primary.