flickrex v0.3.0 Flickr.Galleries

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

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

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

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

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

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.

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

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.

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

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.

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

This method does not require authentication.

Arguments

  • gallery_id - (required) The gallery ID you are requesting information for.
get_list(client, args \\ [])
get_list(client, args) :: response

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

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

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.

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

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

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