facebook4j.api
Interface AlbumMethods

All Known Subinterfaces:

Facebook

public interface AlbumMethods

Author:

Ryuji Yamashita - roundrop at gmail.com

Method Summary

String	addAlbumPhoto(String albumId, Media source) Adds a photo to the album.
String	addAlbumPhoto(String albumId, Media source, String message) Adds a photo to the album.
String	commentAlbum(String albumId, CommentUpdate commentUpdate) Comments on the album.
String	commentAlbum(String albumId, String message) Comments on the album.
String	createAlbum(AlbumUpdate albumUpdate) Creates the current user's photo album.
String	createAlbum(String userId, AlbumUpdate albumUpdate) Creates the user's photo album.
Album	getAlbum(String albumId) Returns a single photo album.
Album	getAlbum(String albumId, Reading reading) Returns a single photo album.
ResponseList<Comment>	getAlbumComments(String albumId) Returns the comments made on the album.
ResponseList<Comment>	getAlbumComments(String albumId, Reading reading) Returns the comments made on the album.
URL	getAlbumCoverPhoto(String albumId) Returns url of the album's cover photo.
ResponseList<Like>	getAlbumLikes(String albumId) Returns likes made on the album.
ResponseList<Like>	getAlbumLikes(String albumId, Reading reading) Returns likes made on the album.
ResponseList<Photo>	getAlbumPhotos(String albumId) Returns the photos contained in the album.
ResponseList<Photo>	getAlbumPhotos(String albumId, Reading reading) Returns the photos contained in the album.
ResponseList<Reaction>	getAlbumReactions(String albumId) Returns the reactions on the album.
ResponseList<Reaction>	getAlbumReactions(String albumId, Reading reading) Returns the reactions on the album.
ResponseList<Album>	getAlbums() Returns the photo albums the current user/page has created.
ResponseList<Album>	getAlbums(Reading reading) Returns the photo albums the current user/page has created.
ResponseList<Album>	getAlbums(String id) Returns the photo albums a user/page has created.
ResponseList<Album>	getAlbums(String id, Reading reading) Returns the photo albums a user/page has created.
boolean	likeAlbum(String albumId) Likes the album.
boolean	unlikeAlbum(String albumId) Unlikes the album.

Method Detail

getAlbums

ResponseList<Album> getAlbums()
                              throws FacebookException

Returns the photo albums the current user/page has created.

Returns:

albums

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User - Facebook Developers - Connections - albums

getAlbums

ResponseList<Album> getAlbums(Reading reading)
                              throws FacebookException

Returns the photo albums the current user/page has created.

Parameters:

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

albums

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#albums - Facebook Developers

getAlbums

ResponseList<Album> getAlbums(String id)
                              throws FacebookException

Returns the photo albums a user/page has created.

Parameters:

id - the ID of a user/page

Returns:

albums

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#albums - Facebook Developers

getAlbums

ResponseList<Album> getAlbums(String id,
                              Reading reading)
                              throws FacebookException

Returns the photo albums a user/page has created.

Parameters:

id - the ID of a user/page

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

albums

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#albums - Facebook Developers

createAlbum

String createAlbum(AlbumUpdate albumUpdate)
                   throws FacebookException

Creates the current user's photo album.

Parameters:

albumUpdate - the album to be created

Returns:

The new album ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#albums - Facebook Developers

createAlbum

String createAlbum(String userId,
                   AlbumUpdate albumUpdate)
                   throws FacebookException

Creates the user's photo album.

Parameters:

userId - the ID of a user

albumUpdate - the album to be created

Returns:

The new album ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#albums - Facebook Developers

getAlbum

Album getAlbum(String albumId)
               throws FacebookException

Returns a single photo album.

Parameters:

albumId - the ID of a album

Returns:

album

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album - Facebook Developers

getAlbum

Album getAlbum(String albumId,
               Reading reading)
               throws FacebookException

Returns a single photo album.

Parameters:

albumId - the ID of a album

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

album

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album - Facebook Developers

getAlbumPhotos

ResponseList<Photo> getAlbumPhotos(String albumId)
                                   throws FacebookException

Returns the photos contained in the album.

Parameters:

albumId - the ID of a album

Returns:

photos

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#photos - Facebook Developers

getAlbumPhotos

ResponseList<Photo> getAlbumPhotos(String albumId,
                                   Reading reading)
                                   throws FacebookException

Returns the photos contained in the album.

Parameters:

albumId - the ID of a album

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

photos

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#photos - Facebook Developers

addAlbumPhoto

String addAlbumPhoto(String albumId,
                     Media source)
                     throws FacebookException

Adds a photo to the album.

Parameters:

albumId - the ID of a album

source - photo content

Returns:

The new photo ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#photos - Facebook Developers

addAlbumPhoto

String addAlbumPhoto(String albumId,
                     Media source,
                     String message)
                     throws FacebookException

Adds a photo to the album.

Parameters:

albumId - the ID of a album

source - photo content

message - photo description

Returns:

The new photo ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#photos - Facebook Developers

getAlbumComments

ResponseList<Comment> getAlbumComments(String albumId)
                                       throws FacebookException

Returns the comments made on the album.

Parameters:

albumId - the ID of a album

Returns:

comments

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#comments - Facebook Developers

getAlbumComments

ResponseList<Comment> getAlbumComments(String albumId,
                                       Reading reading)
                                       throws FacebookException

Returns the comments made on the album.

Parameters:

albumId - the ID of a album

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

comments

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#comments - Facebook Developers

commentAlbum

String commentAlbum(String albumId,
                    String message)
                    throws FacebookException

Comments on the album.

Parameters:

albumId - the ID of a album

message - comment text

Returns:

The new comment ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#comments - Facebook Developers

commentAlbum

String commentAlbum(String albumId,
                    CommentUpdate commentUpdate)
                    throws FacebookException

Comments on the album.

Parameters:

albumId - the ID of a album

commentUpdate - comment content

Returns:

The new comment ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#comments - Facebook Developers

getAlbumLikes

ResponseList<Like> getAlbumLikes(String albumId)
                                 throws FacebookException

Returns likes made on the album.

Parameters:

albumId - the ID of a album

Returns:

likes

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#likes - Facebook Developers

getAlbumLikes

ResponseList<Like> getAlbumLikes(String albumId,
                                 Reading reading)
                                 throws FacebookException

Returns likes made on the album.

Parameters:

albumId - the ID of a album

reading - optional reading parameters. see Graph API#reading - Facebook Developers see Graph API#reading - Facebook Developers

Returns:

likes

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#likes - Facebook Developers

likeAlbum

boolean likeAlbum(String albumId)
                  throws FacebookException

Likes the album.

Parameters:

albumId - the ID of a album

Returns:

true if like is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#likes - Facebook Developers

unlikeAlbum

boolean unlikeAlbum(String albumId)
                    throws FacebookException

Unlikes the album.

Parameters:

albumId - the ID of a album

Returns:

true if unlike is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album#likes - Facebook Developers

getAlbumCoverPhoto

URL getAlbumCoverPhoto(String albumId)
                       throws FacebookException

Returns url of the album's cover photo.

Parameters:

albumId - the ID of a album

Returns:

url

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Album - Facebook Developers - Connections - picture

getAlbumReactions

ResponseList<Reaction> getAlbumReactions(String albumId)
                                         throws FacebookException

Returns the reactions on the album.

Parameters:

albumId - the ID of the album

Returns:

reactions

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Reactions - Facebook Developers

getAlbumReactions

ResponseList<Reaction> getAlbumReactions(String albumId,
                                         Reading reading)
                                         throws FacebookException

Returns the reactions on the album.

Parameters:

albumId - the ID of a album

reading - optional reading parameters. see Graph API#reading - Facebook Developers see Graph API#reading - Facebook Developers

Returns:

reactions

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Reactions - Facebook Developers