class FlickRaw::Flickr::Groups - RDoc Documentation

browse(:cat_id => 'cat_id') click to toggle source

Browse the group category tree, finding groups and sub-categories.

Arguments

cat_id: The category id to fetch a list of groups and sub-categories for. If not specified, it defaults to zero, the root of the category tree.

Error codes

1: Category not found

The value passed for cat_id was not a valid category id.
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 browse(*args)
    @flickr.call 'flickr.groups.browse', *args
  end

discuss()

Returns a Discuss object.

getInfo(:group_id => 'group_id',:lang => 'lang',:secure_image_embeds => 'secure_image_embeds') click to toggle source

flickr.groups.getInfo request.

Get information about a group.

Arguments

group_id (required): The NSID of the group to fetch information for.
lang: The language of the group name and description to fetch. If the language is not found, the primary language of the group will be returned.

Valid values are the same as in feeds.

secure_image_embeds: This argument will secure the external image embeds in all the markup and return a secure back in addition to the

Error codes

1: Group not found

The group NSID passed did not refer to a group that the calling user can see - either an invalid group is or a group that can't be seen by the calling user.
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

GNEverybodyThe group for GNE players693

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

join(:group_id => 'group_id',:accept_rules => 'accept_rules') click to toggle source

flickr.groups.join request.

Join a public group as a member.

Arguments

group_id (required): The NSID of the Group in question
accept_rules: If the group has rules, they must be displayed to the user prior to joining. Passing a true value for this argument specifies that the application has displayed the group rules to the user, and that the user has agreed to them. (See flickr.groups.getInfo).

Error codes

1: Required arguments missing

The group_id doesn't exist
2: Group does not exist

The Group does not exist
3: Group not availabie to the account

The authed account does not have permission to view/join the group.
4: Account is already in that group

The authed account has previously joined this group
5: Membership in group is by invitation only.

Use flickr.groups.joinRequest to contact the administrations for an invitation.
6: User must accept the group rules before joining

The user must read and accept the rules before joining. Please see the accept_rules argument for this method.
10: Account in maximum number of groups

The account is a member of the maximum number of groups.
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 join(*args)
    @flickr.call 'flickr.groups.join', *args
  end

joinRequest(:group_id => 'group_id',:message => 'message',:accept_rules => 'accept_rules') click to toggle source

flickr.groups.joinRequest request.

Request to join a group that is invitation-only.

Arguments

group_id (required): The NSID of the group to request joining.
message (required): Message to the administrators.
accept_rules (required): If the group has rules, they must be displayed to the user prior to joining. Passing a true value for this argument specifies that the application has displayed the group rules to the user, and that the user has agreed to them. (See flickr.groups.getInfo).

Error codes

1: Required arguments missing

The group_id or message argument are missing.
2: Group does not exist

The Group does not exist
3: Group not available to the account

The authed account does not have permission to view/join the group.
4: Account is already in that group

The authed account has previously joined this group
5: Group is public and open

The group does not require an invitation to join, please use flickr.groups.join.
6: User must accept the group rules before joining

The user must read and accept the rules before joining. Please see the accept_rules argument for this method.
7: User has already requested to join that group

A request has already been sent and is pending approval.
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 joinRequest(*args)
    @flickr.call 'flickr.groups.joinRequest', *args
  end

leave(:group_id => 'group_id',:delete_photos => 'delete_photos') click to toggle source

flickr.groups.leave request.

Leave a group.

If the user is the only administrator left, and there are other members, the oldest member will be promoted to administrator.

If the user is the last person in the group, the group will be deleted.

Arguments

group_id (required): The NSID of the Group to leave
delete_photos: Delete all photos by this user from the group

Error codes

1: Required arguments missing

The group_id doesn't exist
2: Group does not exist

The group by that ID does not exist
3: Account is not in that group

The user is not a member of the group that was specified
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 leave(*args)
    @flickr.call 'flickr.groups.leave', *args
  end

members()

Returns a Members object.

pools()

Returns a Pools object.

search(:text => 'text',:per_page => 'per_page',:page => 'page',:user_id => 'user_id',:safe_search => 'safe_search') click to toggle source

flickr.groups.search request.

Search for groups. 18+ groups will only be returned for authenticated calls where the authenticated user is over 18.

Arguments

text (required): The text to search for.
per_page: Number of groups to return per page. If this argument is ommited, it defaults to 100. The maximum allowed value is 500.
page: The page of results to return. If this argument is ommited, it defaults to 1.
user_id: NSID of the user, if you want to restrict your search by the groups this user is a member of. NOTE : This is experimental, and only search within the currently signed in user's groups is supported.
safe_search: safe_search =1 means only safe groups

safe_search =2 means all groups safe_search =3 means only 18+ groups Default is 1.

Error codes

1: No text passed

The required text argument was ommited.
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 search(*args)
    @flickr.call 'flickr.groups.search', *args
  end