com.aetrion.flickr.photos.comments
Class CommentsInterface

java.lang.Object
  extended by com.aetrion.flickr.photos.comments.CommentsInterface

public class CommentsInterface
extends java.lang.Object

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
CommentsInterface(java.lang.String apiKey, Transport transport)
           
 
Method Summary
 java.lang.String addComment(java.lang.String photoId, java.lang.String commentText)
          Add comment to a photo as the currently authenticated user.
 void deleteComment(java.lang.String commentId)
          Delete a 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 photoId)
          Returns the comments for a photo
 
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

CommentsInterface

public CommentsInterface(java.lang.String apiKey,
                         Transport transport)
Method Detail

addComment

public java.lang.String addComment(java.lang.String photoId,
                                   java.lang.String commentText)
                            throws java.io.IOException,
                                   org.xml.sax.SAXException,
                                   FlickrException
Add comment to a photo as the currently authenticated user. This method requires authentication with 'write' permission.

Parameters:
photoId - The id of the photo to add a comment to.
commentText - Text of the comment.
Returns:
a unique comment id.
Throws:
org.xml.sax.SAXException
java.io.IOException
FlickrException

deleteComment

public void deleteComment(java.lang.String commentId)
                   throws java.io.IOException,
                          org.xml.sax.SAXException,
                          FlickrException
Delete a comment as the currently authenticated user. This method requires authentication with 'write' permission.

Parameters:
commentId - The id of the comment to delete.
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

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 photoId)
                       throws FlickrException,
                              java.io.IOException,
                              org.xml.sax.SAXException
Returns the comments for a photo

Parameters:
photoId - The id of the photo to fetch comments for.
Returns:
a List of Comment objects.
Throws:
FlickrException
java.io.IOException
org.xml.sax.SAXException


Copyright (C) 2005-2007 Aetrion LLC. All Rights Reserved.