EMImageMessageBody类 参考

#import <EMImageMessageBody.h>

类 EMImageMessageBody 继承关系图:

构造函数
(instancetype)	- initWithData:thumbnailData:
(instancetype)	- initWithGifFilePath:displayName:
构造函数 继承自 EMFileMessageBody
(instancetype _Nonnull)	- initWithLocalPath:displayName:
(instancetype _Nonnull)	- initWithData:displayName:
构造函数 继承自 EMMessageBody
(instancetype _Nonnull)	- NS_UNAVAILABLE

属性
CGSize	size
CGFloat	compressionRatio
NSString *	thumbnailDisplayName
NSString *	thumbnailLocalPath
NSString *	thumbnailRemotePath
NSString *	thumbnailSecretKey
CGSize	thumbnailSize
long long	thumbnailFileLength
EMDownloadStatus	thumbnailDownloadStatus
NSString *	bigImageLocalPath
NSString *	bigImageRemotePath
EMDownloadStatus	bigImageDownloadStatus
BOOL	isGif
BOOL	isOriginalImage
属性 继承自 EMFileMessageBody
NSString *	displayName
NSString *	localPath
NSString *	remotePath
NSString *	secretKey
long long	fileLength
EMDownloadStatus	downloadStatus
属性 继承自 EMMessageBody
EMMessageBodyType	type
NSUInteger	operationTime
NSString *	operatorId
NSUInteger	operatorCount

详细描述

@header EMImageMessageBody.h @abstract 图片消息体类

作者

Hyphenate

版本

3.00

创建的图片消息体。

可以调用 (instancetype)initWithData:displayName: 方法生成图片消息体。

Note: SDK 会根据压缩率 `compressRatio 发送消息。

函数文档

initWithData:thumbnailData:

- (instancetype) initWithData:		(NSData *)	aData
thumbnailData:		("Use -initWithLocalPath:displayName: instead")	__deprecated_msg

初始化图片消息体。

参数

aData

图片数据。如果该图片的分辨率和你在控制台 Thumbnail Size 中配置的 width 和 height 不一致，SDK 会对该图片进行压缩。压缩原则维持图片的宽高比，是在控制台 width 和 height 的值为缩略图宽高中的更大值，然后按宽高比计算另一个值。以控制台中配置的 width 和 height 为 200 x 200 为例：

如果 aData 的分辨率为 200 x 400 (1:2)，则生成的缩略图分辨率为 100 x 200。 如果 aData 的分辨率为 600 x 300 (2:1)，则生成的缩略图分辨率为 200 x 100。

参数

aThumbnailData

缩略图数据。该参数不会上传到服务器，只用于本地展示。

@Result 图片消息体实例。

initWithGifFilePath:displayName:

- (instancetype) initWithGifFilePath:		(NSString *)	aGifFilePath
displayName:		(NSString *)	aDisplayName

初始化 GIF 图片消息体。

参数

aGifFilePath	GIF 图片本地路径。
aDisplayName	GIF 图片显示名称（不包含路径）。

返回

GIF 消息体实例。

属性说明

bigImageDownloadStatus

- (EMDownloadStatus) bigImageDownloadStatus

readwritenonatomicassign

大图下载状态。

bigImageLocalPath

- (NSString*) bigImageLocalPath

readwritenonatomiccopy

大图的本地路径。

发送方可根据该属性获取大图的本地路径。调用 imageWithContentsOfFile 方法，传入该参数即可获取大图的数据。

bigImageRemotePath

- (NSString*) bigImageRemotePath

readnonatomiccopy

大图在服务器上的 URL。

接收方可通过该属性获取大图的服务器 URL。

compressionRatio

- (CGFloat) compressionRatio

readwritenonatomicassign

图片消息文件的压缩率。

SDK 在发送图片消息时，会根据该参数的值来压缩图片文件。取值范围是 (0.0,1.0]，默认值是 0.6。其中 1.0 表示原图文件不压缩，0.6 表示将原图文件大小压缩为初始文件的 0.6 倍。如果设置小于等于 0，则 SDK 使用默认值。

isGif

- (BOOL) isGif

readwritenonatomicassign

图片是否为 GIF 文件。

isOriginalImage

- (BOOL) isOriginalImage

readwritenonatomicassign

发送方是否发送原图。

发送方可以根据该属性来决定是发送原图还是大图（压缩图）。

接收方可以根据该属性来判断 remotePath 指向的是原图还是大图（压缩图）。

size

- (CGSize) size

readwritenonatomicassign

图片附件的尺寸。

thumbnailDisplayName

- (NSString*) thumbnailDisplayName

readwritenonatomiccopy

缩略图的显示名。

thumbnailDownloadStatus

- (EMDownloadStatus) thumbnailDownloadStatus

readwritenonatomicassign

缩略图下载状态。

thumbnailFileLength

- (long long) thumbnailFileLength

readwritenonatomicassign

缩略图大小, 以字节为单位。

thumbnailLocalPath

- (NSString*) thumbnailLocalPath

readwritenonatomiccopy

缩略图的本地路径。

发送方可以根据该属性获取缩略本地路径。调用 imageWithContentsOfFile 方法，传入 thumbnailLocalPath 即可获取缩略图的数据。

UIImage *image = [UIImage imageWithContentsOfFile:thumbnailLocalPath];

thumbnailRemotePath

- (NSString*) thumbnailRemotePath

readwritenonatomiccopy

缩略图在服务器的路径。

接收方可以通过该属性获取缩略图服务器路径。

thumbnailSecretKey

- (NSString*) thumbnailSecretKey

readwritenonatomiccopy

缩略图的密钥。

下载缩略图时用户需要提供密钥进行校验。

thumbnailSize

- (CGSize) thumbnailSize

readwritenonatomicassign

缩略图的尺寸。

---

该类的文档由以下文件生成:

• HyphenateChat.framework/Headers/EMImageMessageBody.h