net.jeremybrooks.jinx.api.PhotosetsCommentsApi Maven / Gradle / Ivy

Go to download
/*
 * Jinx is Copyright 2010-2018 by Jeremy Brooks and Contributors
 *
 * Jinx is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Jinx is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Jinx.  If not, see .
 */

package net.jeremybrooks.jinx.api;

import net.jeremybrooks.jinx.Jinx;
import net.jeremybrooks.jinx.JinxException;
import net.jeremybrooks.jinx.JinxUtils;
import net.jeremybrooks.jinx.response.Response;
import net.jeremybrooks.jinx.response.photosets.comments.CommentAdd;
import net.jeremybrooks.jinx.response.photosets.comments.CommentList;

import java.util.Map;
import java.util.TreeMap;

/**
 * Provides access to the flickr.photosets.comments API methods.
 *
 * @author Jeremy Brooks
 * @see Flickr API documentation for more details.
 */
public class PhotosetsCommentsApi {
  private Jinx jinx;

  public PhotosetsCommentsApi(Jinx jinx) {
    this.jinx = jinx;
  }


  /**
   * Add a comment to a photoset.
   * 

   * This method requires authentication with 'write' permission.
   *
   * @param photosetId id of the photoset to add a comment to.
   * @param comment    text of the comment.
   * @return object with the newly created comment's ID.
   * @throws JinxException if parameters are null or empty, or if there are any errors.
   * @see flickr.photosets.comments.addComment
   */
  public CommentAdd addComment(String photosetId, String comment) throws JinxException {
    JinxUtils.validateParams(photosetId, comment);
    Map params = new TreeMap<>();
    params.put("method", "flickr.photosets.comments.addComment");
    params.put("photoset_id", photosetId);
    params.put("comment_text", comment);
    return jinx.flickrPost(params, CommentAdd.class);
  }


  /**
   * Delete a photoset comment as the currently authenticated user.
   * 

   * This method requires authentication with 'write' permission.
   *
   * @param commentId id of the comment to delete from a photoset.
   * @return response object with status and any error messages.
   * @throws JinxException if parameters are null or empty, or if there are any errors.
   * @see flickr.photosets.comments.deleteComment
   */
  public Response deleteComment(String commentId) throws JinxException {
    JinxUtils.validateParams(commentId);
    Map params = new TreeMap<>();
    params.put("method", "flickr.photosets.comments.deleteComment");
    params.put("comment_id", commentId);
    return jinx.flickrPost(params, Response.class);
  }


  /**
   * Edit the text of a comment as the currently authenticated user.
   * 

   * This method requires authentication with 'write' permission.
   *
   * @param commentId id of the comment to edit.
   * @param comment   text of the updated comment.
   * @return response object with status and any error messages.
   * @throws JinxException if parameters are null or empty, or if there are any errors.
   * @see flickr.photosets.comments.editComment
   */
  public Response editComment(String commentId, String comment) throws JinxException {
    JinxUtils.validateParams(commentId, comment);
    Map params = new TreeMap<>();
    params.put("method", "flickr.photosets.comments.editComment");
    params.put("comment_id", commentId);
    params.put("comment_text", comment);
    return jinx.flickrPost(params, Response.class);
  }

  /**
   * Returns the comments for a photoset.
   *
   * @param photosetId id of the photoset to fetch comments for.
   * @return comment list object.
   * @throws JinxException if the parameter is null or empty, or if there are any errors.
   * @see flickr.photosets.comments.getList
   */
  public CommentList getList(String photosetId) throws JinxException {
    JinxUtils.validateParams(photosetId);
    Map params = new TreeMap<>();
    params.put("method", "flickr.photosets.comments.getList");
    params.put("photoset_id", photosetId);
    return jinx.flickrGet(params, CommentList.class);
  }
}