com.aetrion.flickr.groups
Class GroupsInterface
java.lang.Object
com.aetrion.flickr.groups.GroupsInterface
public class GroupsInterface
- extends java.lang.Object
Interface for working with Flickr Groups.
- Version:
- $Id: GroupsInterface.java,v 1.14 2007/11/08 21:23:50 x-mago Exp $
- Author:
- Anthony Eden
Method Summary |
Category |
browse(java.lang.String catId)
Browse groups for the given category ID. |
Group |
getInfo(java.lang.String groupId)
Get the info for a specified group. |
java.util.Collection |
search(java.lang.String text,
int perPage,
int page)
Search for groups. 18+ groups will only be returned for authenticated calls where the authenticated user is over 18. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
METHOD_BROWSE
public static final java.lang.String METHOD_BROWSE
- See Also:
- Constant Field Values
METHOD_GET_ACTIVE_LIST
public static final java.lang.String METHOD_GET_ACTIVE_LIST
- See Also:
- Constant Field Values
METHOD_GET_INFO
public static final java.lang.String METHOD_GET_INFO
- See Also:
- Constant Field Values
METHOD_SEARCH
public static final java.lang.String METHOD_SEARCH
- See Also:
- Constant Field Values
GroupsInterface
public GroupsInterface(java.lang.String apiKey,
Transport transportAPI)
browse
public Category browse(java.lang.String catId)
throws java.io.IOException,
org.xml.sax.SAXException,
FlickrException
- Browse groups for the given category ID. If a null value is passed for the category then the root category is
used.
- Parameters:
catId
- The optional category id. Null value will be ignored.
- Returns:
- The Collection of Photo objects
- Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException
getInfo
public Group getInfo(java.lang.String groupId)
throws java.io.IOException,
org.xml.sax.SAXException,
FlickrException
- Get the info for a specified group.
- Parameters:
groupId
- The group id
- Returns:
- The Group object
- Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException
search
public java.util.Collection search(java.lang.String text,
int perPage,
int page)
throws FlickrException,
java.io.IOException,
org.xml.sax.SAXException
- Search for groups. 18+ groups will only be returned for authenticated calls where the authenticated user is over 18.
This method does not require authentication.
- Parameters:
text
- The text to search for.perPage
- Number of groups to return per page. If this argument is 0, it defaults to 100. The maximum allowed value is 500.page
- The page of results to return. If this argument is 0, it defaults to 1.
- Returns:
- A GroupList Object. Only the fields id, name and eighteenplus in the Groups will be set.
- Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException
Copyright (C) 2005-2007 Aetrion LLC. All Rights Reserved.