com.flickr4java.flickr.groups

Class GroupsInterface

java.lang.Object

com.flickr4java.flickr.groups.GroupsInterface

public class GroupsInterface
extends java.lang.Object

Interface for working with Flickr Groups.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METHOD_BROWSE
static java.lang.String	METHOD_GET_ACTIVE_LIST
static java.lang.String	METHOD_GET_INFO
static java.lang.String	METHOD_JOIN
static java.lang.String	METHOD_JOIN_REQUEST
static java.lang.String	METHOD_LEAVE
static java.lang.String	METHOD_SEARCH

Constructor Summary

Constructors

Constructor and Description
GroupsInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI)

Method Summary

Methods

Modifier and Type	Method and Description
Category	browse(java.lang.String catId) Deprecated. Flickr returns just empty results
Group	getInfo(java.lang.String groupId) Get the info for a specified group.
void	join(java.lang.String groupId, java.lang.Boolean acceptRules) Join a group as a public member.
void	joinRequest(java.lang.String groupId, java.lang.String message, boolean acceptRules) Request to join a group.
void	leave(java.lang.String groupId, java.lang.Boolean deletePhotos) Leave a group.
java.util.Collection<Group>	search(java.lang.String text, int perPage, int page) Search for groups.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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

METHOD_JOIN

public static final java.lang.String METHOD_JOIN

See Also:

Constant Field Values

METHOD_JOIN_REQUEST

public static final java.lang.String METHOD_JOIN_REQUEST

See Also:

Constant Field Values

METHOD_LEAVE

public static final java.lang.String METHOD_LEAVE

See Also:

Constant Field Values

Constructor Detail

GroupsInterface

public GroupsInterface(java.lang.String apiKey,
               java.lang.String sharedSecret,
               Transport transportAPI)

Method Detail

browse

public Category browse(java.lang.String catId)
                throws FlickrException

Deprecated. Flickr returns just empty results

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:

FlickrException

getInfo

public Group getInfo(java.lang.String groupId)
              throws FlickrException

Get the info for a specified group. This method does not require authentication.

Parameters:

groupId - The group id

Returns:

The Group object

Throws:

FlickrException

search

public java.util.Collection<Group> search(java.lang.String text,
                                 int perPage,
                                 int page)
                                   throws FlickrException

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:

FlickrException

join

public void join(java.lang.String groupId,
        java.lang.Boolean acceptRules)
          throws FlickrException

Join a group as a public member. Note: if a group has rules - the client must display the rules to the user and the user must accept them prior to joining the group. The acceptRules parameter indicates that the user has accepted those rules.

Parameters:

groupId - - the id of the group to join

acceptRules - - if a group has rules, true indicates the user has accepted the rules

Throws:

FlickrException

See Also:

flickr.groups.join

joinRequest

public void joinRequest(java.lang.String groupId,
               java.lang.String message,
               boolean acceptRules)
                 throws FlickrException

Request to join a group. Note: if a group has rules, the client must display the rules to the user and the user must accept them (which is indicated by passing a true value to acceptRules) prior to making the join request.

Parameters:

groupId - - groupId parameter

message - - (required) message to group administrator

acceptRules - - (required) parameter indicating user has accepted groups rules

Throws:

FlickrException

leave

public void leave(java.lang.String groupId,
         java.lang.Boolean deletePhotos)
           throws FlickrException

Leave a group.

Parameters:

groupId - - the id of the group to leave

deletePhotos - - delete photos by this user from group

Throws:

FlickrException

See Also:

lickr.groups.leave for a description of the various behaviors possible when a user leaves a group.