net.nurigo.java_sdk.api.Image Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javaSDK Show documentation

Coolsms Java SDK using Rest API.

There is a newer version: 2.2

package net.nurigo.java_sdk.api;

import java.util.HashMap;

import net.nurigo.java_sdk.Coolsms;
import net.nurigo.java_sdk.exceptions.CoolsmsException;
import net.nurigo.java_sdk.exceptions.CoolsmsSDKException;

import org.json.simple.JSONObject;

/**
 * @class Image
 * @brief management image, using Rest API
 */
public class Image extends Coolsms {
  /**
   * @brief constructor
   */
  public Image(String apiKey, String apiSecret) {
    super(apiKey, apiSecret);
  }

  /**
   * @brief get image list( HTTP Method GET )
   * @param hashmap params {
   * @param integer offset [optional]
   * @param integer limit [optional] }
   * @return JSONObject
   * @throws CoolsmsException
   */
  public JSONObject getImageList(HashMap params) throws CoolsmsException {
    return sendGetRequest("image_list", params);
  }

  /**
   * @brief get image info ( HTTP Method GET )
   * @param string imageID [required]
   * @return JSONObject
   * @throws CoolsmsException
   */
  public JSONObject getImageInfo(String imageID) throws CoolsmsException {
    HashMap params = new HashMap();
    String resource = "images/" + imageID;
    return sendGetRequest(resource, params);
  }

  /**
   * @brief upload image ( HTTP Method POST )
   * @param hashmap params {
   * @param string image [required]
   * @param string encoding [optional] }
   * @return JSONobject
   * @throws CoolsmsException
   */
  public JSONObject uploadImage(HashMap params) throws CoolsmsException {
    if (!checkString(params.get("image")))
      throw new CoolsmsSDKException("image is required", 202);
    return sendPostRequest("upload_image", params);
  }

  /**
   * @brief delete images ( HTTP Method POST )
   * @param string imageIDs [required]
   * @return JSONObject
   * @throws CoolsmsException
   */
  public JSONObject deleteImages(String imageIDs) throws CoolsmsException {
    if (!checkString(imageIDs))
      throw new CoolsmsSDKException("image_ids is required", 202);

    HashMap params = new HashMap();
    params.put("image_ids", imageIDs);
    return sendPostRequest("delete_images", params);
  }
}