class FlickRaw::Flickr::Groups::Pools

Public Instance Methods

add(:photo_id => 'photo_id',:group_id => 'group_id') click to toggle source

Add a photo to a group's pool.

Arguments

photo_id (required): The id of the photo to add to the group pool. The photo must belong to the calling user.
group_id (required): The NSID of the group who's pool the photo is to be added to.

Error codes

1: Photo not found

The photo id passed was not the id of a photo owned by the caling user.
2: Group not found

The group id passed was not a valid id for a group the user is a member of.
3: Photo already in pool

The specified photo is already in the pool for the specified group.
4: Photo in maximum number of pools

The photo has already been added to the maximum allowed number of pools.
5: Photo limit reached

The user has already added the maximum amount of allowed photos to the pool.
6: Your Photo has been added to the Pending Queue for this Pool

The pool is moderated, and the photo has been added to the Pending Queue. If it is approved by a group administrator, it will be added to the pool.
7: Your Photo has already been added to the Pending Queue for this Pool

The pool is moderated, and the photo has already been added to the Pending Queue.
8: Content not allowed

The content has been disallowed from the pool by the group admin(s).
10: Maximum number of photos in Group Pool

A group pool 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 add(*args)
    @flickr.call 'flickr.groups.pools.add', *args
  end

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

flickr.groups.pools.getContext request.

Returns next and previous photos for a photo in a group pool.

Arguments

photo_id (required): The id of the photo to fetch the context for.
group_id (required): The nsid of the group who's pool to fetch the photo's context for.
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 pool

The specified photo is not in the specified group's pool.
3: Group not found

The specified group nsid was not a valid group or the caller does not have permission to view the group's pool.
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.groups.pools.getContext', *args
  end

getGroups(:page => 'page',:per_page => 'per_page',:extras => 'extras') click to toggle source

flickr.groups.pools.getGroups request.

Returns a list of groups to which you can add photos.

Arguments

page: The page of results to return. If this argument is omitted, it defaults to 1.
per_page: Number of groups to return per page. If this argument is omitted, it defaults to 400. The maximum allowed value is 400.
extras: can take the value icon_urls_deep and return the various buddy icon sizes for the group. It can only be done by blessed APIs

Error codes

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 getGroups(*args)
    @flickr.call 'flickr.groups.pools.getGroups', *args
  end

getPhotos(:group_id => 'group_id',:tags => 'tags',:user_id => 'user_id',:safe_search => 'safe_search',:jump_to => 'jump_to',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.groups.pools.getPhotos request.

Returns a list of pool photos for a given group, based on the permissions of the group and the user logged in (if any).

Arguments

group_id (required): The id of the group who's pool you which to get the photo list for.
tags: A tag to filter the pool with. At the moment only one tag at a time is supported.
user_id: The nsid of a user. Specifiying this parameter will retrieve for you only those photos that the user has contributed to the group pool.
safe_search: Safe search setting:

1 for safe. 2 for moderate. 3 for restricted.

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

Error codes

1: Group not found

The group id passed was not a valid group id.
2: You don't have permission to view this pool

The logged in user (if any) does not have permission to view the pool for this group.
3: Unknown user

The user specified by user_id does not exist.
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.groups.pools.getPhotos', *args
  end

remove(:photo_id => 'photo_id',:group_id => 'group_id') click to toggle source

flickr.groups.pools.remove request.

Remove a photo from a group pool.

Arguments

photo_id (required): The id of the photo to remove from the group pool. The photo must either be owned by the calling user of the calling user must be an administrator of the group.
group_id (required): The NSID of the group who's pool the photo is to removed from.

Error codes

1: Group not found

The group_id passed did not refer to a valid group.
2: Photo not in pool

The photo_id passed was not a valid id of a photo in the group pool.
3: Insufficient permission to remove photo

The calling user doesn't own the photo and is not an administrator of the group, so may not remove the photo from the pool.
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 remove(*args)
    @flickr.call 'flickr.groups.pools.remove', *args
  end