cn.jpush.api.image

Class ImageClient

java.lang.Object

cn.jpush.api.image.ImageClient

public class ImageClient
extends Object

Provide the ability to upload images to the Jiguang server. Only images in JPG, JPEG and PNG format are supported.

Version:

2020-12-14

Author:

fuyx

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
ImageClient(String masterSecret, String appKey)
ImageClient(String masterSecret, String appKey, cn.jiguang.common.connection.HttpProxy proxy, cn.jiguang.common.ClientConfig conf)

Method Summary

Modifier and Type	Method and Description
ImageUploadResult	modifyImage(String mediaId, ImageFilePayload imageFilePayload) Modify image by file.
ImageUploadResult	modifyImage(String mediaId, ImageUrlPayload imageUrlPayload) Modify image by url.
ImageUploadResult	uploadImage(ImageFilePayload imageFilePayload) Upload image by file.
ImageUploadResult	uploadImage(ImageUrlPayload imageUrlPayload) Upload image by url.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

ImageClient

public ImageClient(String masterSecret,
                   String appKey)

ImageClient

public ImageClient(String masterSecret,
                   String appKey,
                   cn.jiguang.common.connection.HttpProxy proxy,
                   cn.jiguang.common.ClientConfig conf)

Method Detail

uploadImage

public ImageUploadResult uploadImage(ImageUrlPayload imageUrlPayload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Upload image by url. Require at least one non-null url.

Parameters:

imageUrlPayload - image url payload

Returns:

ImageUploadResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

uploadImage

public ImageUploadResult uploadImage(ImageFilePayload imageFilePayload)

Upload image by file. Require at least 1 non-null fileName. Currently only support Xiaomi and OPPO

Parameters:

imageFilePayload - image file payload

Returns:

ImageUploadResult

modifyImage

public ImageUploadResult modifyImage(String mediaId,
                                     ImageUrlPayload imageUrlPayload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Modify image by url. Require at least one non-null url.

Parameters:

mediaId - media id

imageUrlPayload - image url payload

Returns:

ImageUploadResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connection exception

cn.jiguang.common.resp.APIRequestException - request exception

modifyImage

public ImageUploadResult modifyImage(String mediaId,
                                     ImageFilePayload imageFilePayload)

Modify image by file. Require at least 1 non-null fileName. Currently only support Xiaomi and OPPO

Parameters:

mediaId - media id

imageFilePayload - image file payload

Returns:

ImageUploadResult