flickrex v0.6.0 Flickrex.Flickr.Galleries View Source

Link to this section Summary

Functions

Add a photo to a gallery

Create a new gallery for the calling user

Modify the meta-data for a gallery

Edit the comment for a gallery photo

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

Return the list of galleries created by a user. Sorted from newest to oldest

Return the list of galleries to which a photo has been added. Galleries are returned sorted by date which the photo was added to the gallery

Return the list of photos for a gallery

Remove a photo from a gallery

Link to this section Types

Link to this section Functions

Link to this function add_photo(args \\ []) View Source
add_photo(args()) :: operation()

Add a photo to a gallery.

This method requires authentication with “write” permission.

Arguments

  • gallery_id - (required) The ID of the gallery to add a photo to. Note: this is the compound ID returned in methods like flickr.galleries.getList, and flickr.galleries.getListForPhoto.

  • photo_id - (required) The photo ID to add to the gallery

  • comment - A short comment or story to accompany the photo.

  • full_response - If specified, return updated details of the gallery the photo was added to

Link to this function create(args \\ []) View Source
create(args()) :: operation()

Create a new gallery for the calling user.

This method requires authentication with “write” permission.

Arguments

  • title - (required) The name of the gallery

  • description - (required) A short description for the gallery

  • primary_photo_id - The first photo to add to your gallery

  • full_result - Get the result in the same format as galleries.getList

Link to this function edit_meta(args \\ []) View Source
edit_meta(args()) :: operation()

Modify the meta-data for a gallery.

This method requires authentication with “write” permission.

Arguments

  • gallery_id - (required) The gallery ID to update.

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

  • description - The new description for the gallery.

Link to this function edit_photo(args \\ []) View Source
edit_photo(args()) :: operation()

Edit the comment for a gallery photo.

This method requires authentication with “write” permission.

Arguments

  • gallery_id - (required) The ID of the gallery to add a photo to. Note: this is the compound ID returned in methods like flickr.galleries.getList, and flickr.galleries.getListForPhoto.

  • photo_id - (required) The photo ID to add to the gallery.

  • comment - (required) The updated comment the photo.

Link to this function edit_photos(args \\ []) View Source
edit_photos(args()) :: operation()

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

This method requires authentication with “write” permission.

Arguments

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

  • primary_photo_id - (required) The id of the photo to use as the ‘primary’ photo for the gallery. 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 gallery. They will appear in the set in the order sent. This list must contain the primary photo id. This list of photos replaces the existing list.

Link to this function get_info(args \\ []) View Source
get_info(args()) :: operation()

This method does not require authentication.

Arguments

  • gallery_id - (required) The gallery ID you are requesting information for.
Link to this function get_list(args \\ []) View Source
get_list(args()) :: operation()

Return the list of galleries created by a user. Sorted from newest to oldest.

This method does not require authentication.

Arguments

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

  • per_page - Number of galleries 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.

  • 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

Link to this function get_list_for_photo(args \\ []) View Source
get_list_for_photo(args()) :: operation()

Return the list of galleries to which a photo has been added. Galleries are returned sorted by date which the photo was added to the gallery.

This method does not require authentication.

Arguments

  • photo_id - (required) The ID of the photo to fetch a list of galleries for.

  • per_page - Number of galleries 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.

Link to this function get_photos(args \\ []) View Source
get_photos(args()) :: operation()

Return the list of photos for a gallery

This method does not require authentication.

Arguments

  • gallery_id - (required) The ID of the gallery of photos to return

  • continuation - Using this parameter indicates to the server that the client is using the new, continuation based pagination rather than the older page/per_page based pagination. The first request must pass the “continuation” parameter with the value of “0”. The server responds back with a response that includes the “continuation” field along with the “per_page” field in the response. For the subsequent requests, the client must relay the value of the “continuation” response field as the value of the “continuation” request parameter. On the last page of results, the server will respond with a continuation value of “-1”.

  • per_page - chunk size to fetch

  • get_user_info - set to 1 if user details should be returned

  • get_gallery_info - if set to 1, info about the gallery is also returned

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

Link to this function remove_photo(args \\ []) View Source
remove_photo(args()) :: operation()

Remove a photo from a gallery.

This method requires authentication with “write” permission.

Arguments

  • gallery_id - (required) The ID of the gallery to remove a photo from

  • photo_id - (required) The ID of the photo to remove from the gallery

  • full_response - (required) If specified, return updated details of the gallery the photo was removed from