class FlickRaw::Flickr::Photosets

addPhoto(:photoset_id => 'photoset_id',:photo_id => 'photo_id') click to toggle source

Add a photo to the end of an existing photoset.

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.

Error codes

1: Photoset not found

The photoset id passed was not the id of avalid photoset owned by the calling user.
2: Photo not found

The photo id passed was not the id of a valid photo owned by the calling user.
3: Photo already in set

The photo is already a member of the photoset.
10: Maximum number of photos in set

A set has reached the upper limit for the number of photos allowed.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def addPhoto(*args)
    @flickr.call 'flickr.photosets.addPhoto', *args
  end

comments()

Returns a Comments object.

create(:title => 'title',:description => 'description',:primary_photo_id => 'primary_photo_id',:full_result => 'full_result') click to toggle source

flickr.photosets.create request.

Create a new photoset for the calling user.

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.
full_result: If this is set, we get the same result as a getList API would give, along with extras: url_sq,url_t,url_s,url_m

Error codes

1: No title specified

No title parameter was passed in the request.
2: Photo not found

The primary photo id passed was not a valid photo id or does not belong to the calling user.
3: Can't create any more sets

The user has reached their maximum number of photosets limit.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def create(*args)
    @flickr.call 'flickr.photosets.create', *args
  end

delete(:photoset_id => 'photoset_id') click to toggle source

flickr.photosets.delete request.

Delete a photoset.

Arguments

photoset_id (required): The id of the photoset to delete. It must be owned by the calling user.

Error codes

1: Photoset not found

The photoset id passed was not a valid photoset id or did not belong to the calling user.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def delete(*args)
    @flickr.call 'flickr.photosets.delete', *args
  end

editMeta(:photoset_id => 'photoset_id',:title => 'title',:description => 'description') click to toggle source

flickr.photosets.editMeta request.

Modify the meta-data for a photoset.

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.

Error codes

1: Photoset not found

The photoset id passed was not a valid photoset id or did not belong to the calling user.
2: No title specified

No title parameter was passed in the request.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def editMeta(*args)
    @flickr.call 'flickr.photosets.editMeta', *args
  end

editPhotos(:photoset_id => 'photoset_id',:primary_photo_id => 'primary_photo_id',:photo_ids => 'photo_ids') click to toggle source

flickr.photosets.editPhotos request.

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

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.

Error codes

1: Photoset not found

The photoset id passed was not a valid photoset id or did not belong to the calling user.
2: Photo not found

One or more of the photo ids passed was not a valid photo id or does not belong to the calling user.
3: Primary photo not found

The primary photo id passed was not a valid photo id or does not belong to the calling user.
4: Primary photo not in list

The primary photo id passed did not appear in the photo id list.
5: Empty photos list

No photo ids were passed.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def editPhotos(*args)
    @flickr.call 'flickr.photosets.editPhotos', *args
  end

getContext(:photo_id => 'photo_id',:photoset_id => 'photoset_id',:num_prev => 'num_prev',:num_next => 'num_next',:extras => 'extras') click to toggle source

flickr.photosets.getContext request.

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

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.
num_prev
num_next
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_m, url_z, url_l, url_o

Error codes

1: Photo not found

The photo id passed was not a valid photo id, or was the id of a photo that the calling user does not have permission to view.
2: Photo not in set

The specified photo is not in the specified set.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def getContext(*args)
    @flickr.call 'flickr.photosets.getContext', *args
  end

getInfo(:photoset_id => 'photoset_id') click to toggle source

flickr.photosets.getInfo request.

Gets information about a photoset.

Arguments

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

Error codes

1: Photoset not found

The photoset id was not valid.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

Mah KittehsSixty and Niner. Born on the 3rd of May, 2010, or thereabouts. Came to my place on Thursday, July 29, 2010.

# Generated automatically from flickr api
  def getInfo(*args)
    @flickr.call 'flickr.photosets.getInfo', *args
  end

getList(:user_id => 'user_id',:page => 'page',:per_page => 'per_page',:primary_photo_extras => 'primary_photo_extras') click to toggle source

flickr.photosets.getList request.

Returns the photosets belonging to the specified user.

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

Error codes

1: User not found

The user NSID passed was not a valid user NSID and the calling user was not logged in.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

Avis BlancheMy Grandma's Recipe File.Mah KittehsSixty and Niner. Born on the 3rd of May, 2010, or thereabouts. Came to my place on Thursday, July 29, 2010.

# Generated automatically from flickr api
  def getList(*args)
    @flickr.call 'flickr.photosets.getList', *args
  end

getPhotos(:photoset_id => 'photoset_id',:extras => 'extras',:privacy_filter => 'privacy_filter',:per_page => 'per_page',:page => 'page',:media => 'media') click to toggle source

flickr.photosets.getPhotos request.

Get the list of photos in a set.

Arguments

photoset_id (required): The id of the photoset to return the photos for.
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
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

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.
media: Filter results by media type. Possible values are all (default), photos or videos

Error codes

1: Photoset not found

The photoset id passed was not a valid photoset id.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def getPhotos(*args)
    @flickr.call 'flickr.photosets.getPhotos', *args
  end

orderSets(:photoset_ids => 'photoset_ids') click to toggle source

flickr.photosets.orderSets request.

Set the order of photosets for the calling user.

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.

Error codes

1: Set not found

One of the photoset ids passed was not the id of a valid photoset belonging to the calling user.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def orderSets(*args)
    @flickr.call 'flickr.photosets.orderSets', *args
  end

removePhoto(:photoset_id => 'photoset_id',:photo_id => 'photo_id') click to toggle source

flickr.photosets.removePhoto request.

Remove a photo from a photoset.

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.

Error codes

1: Photoset not found

The photoset id passed was not the id of avalid photoset owned by the calling user.
2: Photo not found

The photo id passed was not the id of a valid photo belonging to the calling user.
3: Photo not in set

The photo is not a member of the photoset.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def removePhoto(*args)
    @flickr.call 'flickr.photosets.removePhoto', *args
  end

removePhotos(:photoset_id => 'photoset_id',:photo_ids => 'photo_ids') click to toggle source

flickr.photosets.removePhotos request.

Remove multiple photos from a photoset.

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.

Error codes

1: Photoset not found

The photoset id passed was not the id of available photosets owned by the calling user.
2: Photo not found

The photo id passed was not the id of a valid photo belonging to the calling user.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def removePhotos(*args)
    @flickr.call 'flickr.photosets.removePhotos', *args
  end

reorderPhotos(:photoset_id => 'photoset_id',:photo_ids => 'photo_ids') click to toggle source

flickr.photosets.reorderPhotos request.

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

Error codes

1: Photoset not found

The photoset id passed was not a valid photoset id or did not belong to the calling user.
2: Photo not found

One or more of the photo ids passed was not a valid photo id or does not belong to the calling user.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def reorderPhotos(*args)
    @flickr.call 'flickr.photosets.reorderPhotos', *args
  end

setPrimaryPhoto(:photoset_id => 'photoset_id',:photo_id => 'photo_id') click to toggle source

flickr.photosets.setPrimaryPhoto request.

Set photoset primary photo

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.

Error codes

1: Photoset not found

The photoset id passed was not the id of avalid photoset owned by the calling user.
2: Photo not found

The photo id passed was not the id of a valid photo owned by the calling user.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def setPrimaryPhoto(*args)
    @flickr.call 'flickr.photosets.setPrimaryPhoto', *args
  end