facebook4j.api
Interface GroupMethods

All Known Subinterfaces:
Facebook
All Known Implementing Classes:
FacebookImpl

public interface GroupMethods


Method Summary
 Group getGroup(java.lang.String groupId)
          Returns a single group.
 Group getGroup(java.lang.String groupId, Reading reading)
          Returns a single group.
 ResponseList<GroupDoc> getGroupDocs(java.lang.String groupId)
          Returns the docs in a group.
 ResponseList<GroupDoc> getGroupDocs(java.lang.String groupId, Reading reading)
          Returns the docs in a group.
 ResponseList<Post> getGroupFeed(java.lang.String groupId)
          Returns the group's wall.
 ResponseList<Post> getGroupFeed(java.lang.String groupId, Reading reading)
          Returns the group's wall.
 ResponseList<GroupMember> getGroupMembers(java.lang.String groupId)
          Returns all of the users who are members of a group.
 ResponseList<GroupMember> getGroupMembers(java.lang.String groupId, Reading reading)
          Returns all of the users who are members of a group.
 java.net.URL getGroupPictureURL(java.lang.String groupId)
          Returns url of a group's profile picture.
 ResponseList<Group> getGroups()
          Returns the Groups that the current user belongs to.
 ResponseList<Group> getGroups(Reading reading)
          Returns the Groups that the current user belongs to.
 ResponseList<Group> getGroups(java.lang.String userId)
          Returns the Groups that a user belongs to.
 ResponseList<Group> getGroups(java.lang.String userId, Reading reading)
          Returns the Groups that a user belongs to.
 java.lang.String postGroupFeed(java.lang.String groupId, PostUpdate postUpdate)
          Creates the post on a group's wall.
 java.lang.String postGroupLink(java.lang.String groupId, java.net.URL link)
          Posts the link on a group's wall.
 java.lang.String postGroupLink(java.lang.String groupId, java.net.URL link, java.lang.String message)
          Posts the link on a group's wall.
 java.lang.String postGroupStatusMessage(java.lang.String groupId, java.lang.String message)
          Posts the status message on a group's wall.
 

Method Detail

getGroups

ResponseList<Group> getGroups()
                              throws FacebookException
Returns the Groups that the current user belongs to.

Returns:
groups
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
User#groups - Facebook Developers

getGroups

ResponseList<Group> getGroups(Reading reading)
                              throws FacebookException
Returns the Groups that the current user belongs to.

Parameters:
reading - optional reading parameters. see Graph API#reading - Facebook Developers
Returns:
groups
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
User#groups - Facebook Developers

getGroups

ResponseList<Group> getGroups(java.lang.String userId)
                              throws FacebookException
Returns the Groups that a user belongs to.

Parameters:
userId - the ID of a user
Returns:
groups
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
User#groups - Facebook Developers

getGroups

ResponseList<Group> getGroups(java.lang.String userId,
                              Reading reading)
                              throws FacebookException
Returns the Groups that a user belongs to.

Parameters:
userId - the ID of a user
reading - optional reading parameters. see Graph API#reading - Facebook Developers
Returns:
groups
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
User#groups - Facebook Developers

getGroup

Group getGroup(java.lang.String groupId)
               throws FacebookException
Returns a single group.

Parameters:
groupId - the ID of the group
Returns:
group
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers

getGroup

Group getGroup(java.lang.String groupId,
               Reading reading)
               throws FacebookException
Returns a single group.

Parameters:
groupId - the ID of the group
reading - optional reading parameters. see Graph API#reading - Facebook Developers
Returns:
group
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers

getGroupFeed

ResponseList<Post> getGroupFeed(java.lang.String groupId)
                                throws FacebookException
Returns the group's wall.

Parameters:
groupId - the ID of the group
Returns:
group's feed
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group#feed - Facebook Developers

getGroupFeed

ResponseList<Post> getGroupFeed(java.lang.String groupId,
                                Reading reading)
                                throws FacebookException
Returns the group's wall.

Parameters:
groupId - the ID of the group
reading - optional reading parameters. see Graph API#reading - Facebook Developers
Returns:
group's feed
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group#feed - Facebook Developers

postGroupFeed

java.lang.String postGroupFeed(java.lang.String groupId,
                               PostUpdate postUpdate)
                               throws FacebookException
Creates the post on a group's wall.

Parameters:
groupId - the ID of a group
postUpdate - the post to be created
Returns:
The new post ID
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group#posts - Facebook Developers

postGroupLink

java.lang.String postGroupLink(java.lang.String groupId,
                               java.net.URL link)
                               throws FacebookException
Posts the link on a group's wall.

Parameters:
groupId - the ID of a group
link - link URL
Returns:
The new link ID
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group#links - Facebook Developers

postGroupLink

java.lang.String postGroupLink(java.lang.String groupId,
                               java.net.URL link,
                               java.lang.String message)
                               throws FacebookException
Posts the link on a group's wall.

Parameters:
groupId - the ID of a group
link - link URL
message - link message
Returns:
The new link ID
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group#links - Facebook Developers

postGroupStatusMessage

java.lang.String postGroupStatusMessage(java.lang.String groupId,
                                        java.lang.String message)
                                        throws FacebookException
Posts the status message on a group's wall.

Parameters:
groupId - the ID of a group
message - status message content
Returns:
The new status message ID
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group#statuses - Facebook Developers

getGroupMembers

ResponseList<GroupMember> getGroupMembers(java.lang.String groupId)
                                          throws FacebookException
Returns all of the users who are members of a group.

Parameters:
groupId - the ID of a group
Returns:
all of the users who are members of the group
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers - Connections - members

getGroupMembers

ResponseList<GroupMember> getGroupMembers(java.lang.String groupId,
                                          Reading reading)
                                          throws FacebookException
Returns all of the users who are members of a group.

Parameters:
groupId - the ID of a group
reading - optional reading parameters. see Graph API#reading - Facebook Developers
Returns:
all of the users who are members of the group
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers - Connections - members

getGroupPictureURL

java.net.URL getGroupPictureURL(java.lang.String groupId)
                                throws FacebookException
Returns url of a group's profile picture.

Parameters:
groupId - the ID of a group
Returns:
url
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers - Connections - picture

getGroupDocs

ResponseList<GroupDoc> getGroupDocs(java.lang.String groupId)
                                    throws FacebookException
Returns the docs in a group.

Parameters:
groupId - the ID of a group
Returns:
docs
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers - Connections - docs

getGroupDocs

ResponseList<GroupDoc> getGroupDocs(java.lang.String groupId,
                                    Reading reading)
                                    throws FacebookException
Returns the docs in a group.

Parameters:
groupId - the ID of a group
reading - optional reading parameters. see Graph API#reading - Facebook Developers
Returns:
docs
Throws:
FacebookException - when Facebook service or network is unavailable
See Also:
Group - Facebook Developers - Connections - docs