com.aetrion.flickr.photosets.comments
Class PhotosetsCommentsInterface

java.lang.Object
  com.aetrion.flickr.photosets.comments.PhotosetsCommentsInterface

public class PhotosetsCommentsInterface
extends java.lang.Object

Access to the flickr.photosets.comments methods

Author:

till (Till Krech) flickr:extranoise

Field Summary

static java.lang.String	METHOD_ADD_COMMENT
static java.lang.String	METHOD_DELETE_COMMENT
static java.lang.String	METHOD_EDIT_COMMENT
static java.lang.String	METHOD_GET_LIST

Constructor Summary

PhotosetsCommentsInterface(java.lang.String apiKey, Transport transport)

Method Summary

java.lang.String	addComment(java.lang.String photosetId, java.lang.String commentText) Add a comment to a photoset.
void	deleteComment(java.lang.String commentId) Delete a photoset comment as the currently authenticated user.
void	editComment(java.lang.String commentId, java.lang.String commentText) Edit the text of a comment as the currently authenticated user.
java.util.List	getList(java.lang.String photosetId) Returns the comments for a photoset.

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_ADD_COMMENT

public static final java.lang.String METHOD_ADD_COMMENT

See Also:

Constant Field Values

METHOD_DELETE_COMMENT

public static final java.lang.String METHOD_DELETE_COMMENT

See Also:

Constant Field Values

METHOD_EDIT_COMMENT

public static final java.lang.String METHOD_EDIT_COMMENT

See Also:

Constant Field Values

METHOD_GET_LIST

public static final java.lang.String METHOD_GET_LIST

See Also:

Constant Field Values

Constructor Detail

PhotosetsCommentsInterface

public PhotosetsCommentsInterface(java.lang.String apiKey,
                                  Transport transport)

Method Detail

addComment

public java.lang.String addComment(java.lang.String photosetId,
                                   java.lang.String commentText)
                            throws FlickrException,
                                   java.io.IOException,
                                   org.xml.sax.SAXException

Add a comment to a photoset. This method requires authentication with 'write' permission.

Parameters:

photosetId - The id of the photoset to add a comment to.

commentText - Text of the comment

Returns:

the comment id

Throws:

FlickrException

java.io.IOException

org.xml.sax.SAXException

deleteComment

public void deleteComment(java.lang.String commentId)
                   throws FlickrException,
                          java.io.IOException,
                          org.xml.sax.SAXException

Delete a photoset comment as the currently authenticated user.

Parameters:

commentId - The id of the comment to delete from a photoset.

Throws:

FlickrException

java.io.IOException

org.xml.sax.SAXException

editComment

public void editComment(java.lang.String commentId,
                        java.lang.String commentText)
                 throws java.io.IOException,
                        org.xml.sax.SAXException,
                        FlickrException

Edit the text of a comment as the currently authenticated user. This method requires authentication with 'write' permission.

Parameters:

commentId - The id of the comment to edit.

commentText - Update the comment to this text.

Throws:

java.io.IOException

org.xml.sax.SAXException

FlickrException

getList

public java.util.List getList(java.lang.String photosetId)
                       throws java.io.IOException,
                              org.xml.sax.SAXException,
                              FlickrException

Returns the comments for a photoset. This method does not require authentication.

Parameters:

photosetId - The id of the photoset to fetch comments for.

Returns:

a list of Comment objects

Throws:

org.xml.sax.SAXException

java.io.IOException

FlickrException