cn.jpush.im.android.api.content

类 ImageContent

java.lang.Object

cn.jpush.im.android.api.content.MessageContent

cn.jpush.im.android.api.content.MediaContent

cn.jpush.im.android.api.content.ImageContent

所有已实现的接口:

java.lang.Cloneable

public class ImageContent
extends MediaContent

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	ImageContent.CreateImageContentCallback

构造器概要

构造器

构造器和说明
ImageContent(android.graphics.Bitmap image) 创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。
ImageContent(android.graphics.Bitmap image, java.lang.String format) 创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。
ImageContent(java.io.File imageFile) 创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。
ImageContent(java.io.File imageFile, java.lang.String format) 创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。

方法概要

限定符和类型	方法和说明
void	cancelDownload(Message message) 取消下载,手动下载后可调用此接口取消下载, 注意可以自动下载的文件不可取消 是否取消成功需要根据下载的回调来判断,如果取消成功，下载回调中错误码为ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED
static void	createImageContentAsync(android.graphics.Bitmap image, ImageContent.CreateImageContentCallback callback) 异步创建ImageContent。
static void	createImageContentAsync(android.graphics.Bitmap image, java.lang.String format, ImageContent.CreateImageContentCallback callback) 异步创建ImageContent。
static void	createImageContentAsync(java.io.File imageFile, ImageContent.CreateImageContentCallback callback) 异步创建ImageContent。
static void	createImageContentAsync(java.io.File imageFile, java.lang.String format, ImageContent.CreateImageContentCallback callback) 异步创建ImageContent。
void	downloadOriginImage(Message message, DownloadCompletionCallback callback) 下载图片消息中的原图,下载过程中想要取消的话调用cancelDownload(Message)。
void	downloadThumbnailImage(Message message, DownloadCompletionCallback callback) 下载图片消息中原图对应的缩略图 对于用户在线期间收到的图片消息：sdk会在接收到图片消息时自动下载缩略图。
int	getHeight() 获取原图高度
java.lang.String	getImg_link()
java.lang.String	getLocalThumbnailPath() 获取对应缩略图的本地路径。
int	getWidth() 获取原图宽度
boolean	needAutoDownloadWhenRecv()
void	setImg_link(java.lang.String img_link)
void	setLocalThumbnailPath(java.lang.String localThumbnailPath)

从类继承的方法 cn.jpush.im.android.api.content.MediaContent

getCrc, getFileSize, getFormat, getHash, getLocalPath, getMediaID, getResourceId, isFileUploaded, setFileUploaded, setFormat, setLocalPath, setMediaID

从类继承的方法 cn.jpush.im.android.api.content.MessageContent

clone, fromJson, getBooleanExtra, getBooleanExtras, getContentType, getNumberExtra, getNumberExtras, getStringExtra, getStringExtras, setBooleanExtra, setExtras, setNumberExtra, setStringExtra, toJson, toJsonElement

从类继承的方法 java.lang.Object

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

构造器详细资料

ImageContent

public ImageContent(java.io.File imageFile)
             throws java.io.FileNotFoundException

创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。

创建ImageContent过程可能会比较耗时，具体根据传入图片的大小而定。 建议使用异步创建ImageContent的接口 createImageContentAsync(File, CreateImageContentCallback)。

参数:

imageFile - 本地图片的File对象

抛出:

java.io.FileNotFoundException - 如果file为null或路径指向的文件不存在，将抛出此异常

ImageContent

public ImageContent(java.io.File imageFile,
                    java.lang.String format)
             throws java.io.FileNotFoundException

创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。

此接口可以指定文件在后台存储时的扩展名，如果填空或者不填，则后台存储文件时将没有扩展名。

创建ImageContent过程可能会比较耗时，具体根据传入图片的大小而定。 建议使用异步创建ImageContent的接口 createImageContentAsync(File, CreateImageContentCallback)。

参数:

imageFile - 本地图片的File对象

format - 文件扩展名，注意名称中不要包括"."

抛出:

java.io.FileNotFoundException - 如果file为null或路径指向的文件不存在，将抛出此异常

从以下版本开始:

2.2.1

ImageContent

public ImageContent(android.graphics.Bitmap image)

创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。

创建ImageContent过程可能会比较耗时，具体根据传入图片的大小而定。 建议使用异步创建ImageContent的接口 createImageContentAsync(Bitmap, CreateImageContentCallback)。

参数:

image - 图片的Bitmap对象

ImageContent

public ImageContent(android.graphics.Bitmap image,
                    java.lang.String format)

创建一个图片类型的MessageContent，同时会依据传入的图片生成相应的缩略图，并存储在本地。

此接口可以指定文件在后台存储时的扩展名，如果填空或者不填，则后台存储文件时将没有扩展名。

创建ImageContent过程可能会比较耗时，具体根据传入图片的大小而定。 建议使用异步创建ImageContent的接口 createImageContentAsync(Bitmap, CreateImageContentCallback)。

参数:

image - 图片的Bitmap对象

format - 文件扩展名，注意名称中不要包括"."

从以下版本开始:

2.2.1

方法详细资料

needAutoDownloadWhenRecv

public boolean needAutoDownloadWhenRecv()

指定者:

needAutoDownloadWhenRecv 在类中 MessageContent

createImageContentAsync

public static void createImageContentAsync(java.io.File imageFile,
                                           ImageContent.CreateImageContentCallback callback)

异步创建ImageContent。因为创建ImageContent时需要生成对应的缩略图并存储，整个过程会有耗时，有可能造成 线程阻塞。所以推荐使用此异步接口来创建ImageContent。

参数:

imageFile - 本地图片的File对象

callback - 创建ImageContent的回调接口

createImageContentAsync

public static void createImageContentAsync(java.io.File imageFile,
                                           java.lang.String format,
                                           ImageContent.CreateImageContentCallback callback)

异步创建ImageContent。因为创建ImageContent时需要生成对应的缩略图并存储，整个过程会有耗时，有可能造成 线程阻塞。所以推荐使用此异步接口来创建ImageContent。

此接口可以指定文件在后台存储时的扩展名，如果填空或者不填，则后台存储文件时将没有扩展名。

参数:

imageFile - 本地图片的File对象

format - 文件扩展名，注意名称中不要包括"."

callback - 创建ImageContent的回调接口

从以下版本开始:

2.2.1

createImageContentAsync

public static void createImageContentAsync(android.graphics.Bitmap image,
                                           ImageContent.CreateImageContentCallback callback)

异步创建ImageContent。因为创建ImageContent时需要生成对应的缩略图并存储，整个过程会有耗时，有可能造成 线程阻塞。所以推荐使用此异步接口来创建ImageContent。

参数:

image - 图片的Bitmap对象

callback - 创建ImageContent的回调接口

createImageContentAsync

public static void createImageContentAsync(android.graphics.Bitmap image,
                                           java.lang.String format,
                                           ImageContent.CreateImageContentCallback callback)

异步创建ImageContent。因为创建ImageContent时需要生成对应的缩略图并存储，整个过程会有耗时，有可能造成 线程阻塞。所以推荐使用此异步接口来创建ImageContent。

此接口可以指定文件在后台存储时的扩展名，如果填空或者不填，则后台存储文件时将没有扩展名。

参数:

image - 图片的Bitmap对象

format - 文件扩展名，注意名称中不要包括"."

callback - 创建ImageContent的回调接口

从以下版本开始:

2.2.1

getWidth

public int getWidth()

获取原图宽度

返回:

图片宽度像素值

getHeight

public int getHeight()

获取原图高度

返回:

图片高度像素值

getImg_link

public java.lang.String getImg_link()

setImg_link

public void setImg_link(java.lang.String img_link)

getLocalThumbnailPath

public java.lang.String getLocalThumbnailPath()

获取对应缩略图的本地路径。

收到图片消息时，sdk会主动下载图片的缩略图。

但是当sdk主动下载失败，消息状态为MessageStatus.receive_fail时，此接口将返回null。 此时需要上层主动调用downloadThumbnailImage(Message, DownloadCompletionCallback)接口去再次尝试下载缩略图

返回:

缩略图的本地路径

setLocalThumbnailPath

public void setLocalThumbnailPath(java.lang.String localThumbnailPath)

downloadOriginImage

public void downloadOriginImage(Message message,
                                DownloadCompletionCallback callback)

下载图片消息中的原图,下载过程中想要取消的话调用cancelDownload(Message)。

收到图片消息后，sdk不会主动触发图片原图的下载，此时调用MediaContent.getLocalPath()接口将返回null 需要上层主动调用#ImageContent#downloadOriginImage(Message, DownloadCompletionCallback)接口触发下载。

下载成功之后通过此接口可以获取到图片原图在本地的地址

参数:

message - 图片消息对象

callback - 下载完成后的回调接口

downloadThumbnailImage

public void downloadThumbnailImage(Message message,
                                   DownloadCompletionCallback callback)

下载图片消息中原图对应的缩略图

对于用户在线期间收到的图片消息：sdk会在接收到图片消息时自动下载缩略图。仅当sdk主动下载失败，消息状态为MessageStatus.receive_fail时， 需要上层主动调用此接口下载缩略图。

对于离线期间批量收到的图片消息：sdk会主动下载最新20条消息中图片消息的缩略图。

参数:

message - 图片消息对象

callback - 下载完成后的回调接口

cancelDownload

public void cancelDownload(Message message)

从类复制的说明: MessageContent

取消下载,手动下载后可调用此接口取消下载, 注意可以自动下载的文件不可取消
是否取消成功需要根据下载的回调来判断,如果取消成功，下载回调中错误码为ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED

指定者:

cancelDownload 在类中 MessageContent

参数:

message - 该Content所对应的消息对象