cn.leancloud.im.v2.messages

Class LCIMFileMessage

java.lang.Object

cn.leancloud.im.v2.LCIMMessage

cn.leancloud.im.v2.LCIMTypedMessage

cn.leancloud.im.v2.messages.LCIMFileMessage

Direct Known Subclasses:

LCIMAudioMessage, LCIMImageMessage, LCIMVideoMessage

public class LCIMFileMessage
extends LCIMTypedMessage

Nested Class Summary

Nested classes/interfaces inherited from class cn.leancloud.im.v2.LCIMMessage

LCIMMessage.MessageIOType, LCIMMessage.MessageStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	DURATION
protected Map<String,Object>	file
static String	FORMAT

Fields inherited from class cn.leancloud.im.v2.LCIMMessage

bytes, content, conversationId, currentClient, deliveredAt, from, ioType, mentionAll, mentionList, messageId, readAt, status, timestamp, uniqueToken, updateAt

Constructor Summary

Constructors

Constructor and Description
LCIMFileMessage()
LCIMFileMessage(File localFile)
LCIMFileMessage(LCFile file)
LCIMFileMessage(String localPath)

Method Summary

Modifier and Type	Method and Description
void	attachLCFile(LCFile file, boolean keepName)
boolean	equals(Object other)
protected void	fulFillFileInfo(SaveCallback callback)
protected void	getAdditionalMetaData(Map<String,Object> meta, SaveCallback callback)
Map<String,Object>	getAttrs()
Map<String,Object>	getFile()
Map<String,Object>	getFileMetaData() 获取文件的metaData
String	getFileUrl() 获取文件地址
LCFile	getLCFile() 获取文件消息中得 LCFile 对象
String	getLocalFilePath() 获取本地文件地址，如果用户并未指定任何本地文件，则返回 null
protected String	getQueryName()
long	getSize() 获取文件大小
String	getText()
int	hashCode()
protected void	parseAdditionalMetaData(Map<String,Object> meta, JSONObject response)
void	setAttrs(Map<String,Object> attr)
protected void	setFile(Map<String,Object> file)
protected void	setHasAdditionalMetaAttr(boolean hasAdditionalMetaAttr)
void	setProgressCallback(ProgressCallback callback) 设置文件上传进度回调
void	setText(String text)
protected void	upload(SaveCallback callback)

Methods inherited from class cn.leancloud.im.v2.LCIMTypedMessage

computeFieldAttribute, getContent, getMessage, getMessageType, setContent, setMessageType

Methods inherited from class cn.leancloud.im.v2.LCIMMessage

dumpRawData, generateUniqueToken, getConversationId, getDeliveredAt, getFrom, getMentionList, getMentionListString, getMessageId, getMessageIOType, getMessageStatus, getReadAt, getReceiptTimestamp, getTimestamp, getUniqueToken, getUpdateAt, getUpdatedAt, isMentionAll, mentioned, parseJSON, parseJSONString, setConversationId, setFrom, setMentionAll, setMentionList, setMentionListString, setMessageId, setMessageIOType, setMessageStatus, setReadAt, setReceiptTimestamp, setTimestamp, setUniqueToken, setUpdateAt, setUpdatedAt, toJSONString

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final String FORMAT

See Also:

Constant Field Values

DURATION

public static final String DURATION

See Also:

Constant Field Values

file

protected Map<String,Object> file

Constructor Detail

LCIMFileMessage

public LCIMFileMessage()

LCIMFileMessage

public LCIMFileMessage(String localPath)
                throws IOException

Throws:

IOException

LCIMFileMessage

public LCIMFileMessage(File localFile)
                throws IOException

Throws:

IOException

LCIMFileMessage

public LCIMFileMessage(LCFile file)

Method Detail

getFile

public Map<String,Object> getFile()

getLocalFilePath

public String getLocalFilePath()

获取本地文件地址，如果用户并未指定任何本地文件，则返回 null

Returns:

local file path.

getLCFile

public LCFile getLCFile()

获取文件消息中得 LCFile 对象

Returns:

LCFile instance.

attachLCFile

public void attachLCFile(LCFile file,
                         boolean keepName)

setFile

protected void setFile(Map<String,Object> file)

setHasAdditionalMetaAttr

protected void setHasAdditionalMetaAttr(boolean hasAdditionalMetaAttr)

getFileUrl

public String getFileUrl()

获取文件地址

Returns:

file url.

getFileMetaData

public Map<String,Object> getFileMetaData()

获取文件的metaData

Returns:

meta data map.

getSize

public long getSize()

获取文件大小

Returns:

file size.

upload

protected void upload(SaveCallback callback)

setProgressCallback

public void setProgressCallback(ProgressCallback callback)

设置文件上传进度回调

Parameters:

callback - callback function.

getText

public String getText()

setText

public void setText(String text)

getAttrs

public Map<String,Object> getAttrs()

setAttrs

public void setAttrs(Map<String,Object> attr)

fulFillFileInfo

protected void fulFillFileInfo(SaveCallback callback)

getQueryName

protected String getQueryName()

parseAdditionalMetaData

protected void parseAdditionalMetaData(Map<String,Object> meta,
                                       JSONObject response)

getAdditionalMetaData

protected void getAdditionalMetaData(Map<String,Object> meta,
                                     SaveCallback callback)

hashCode

public int hashCode()

Overrides:

hashCode in class LCIMTypedMessage

equals

public boolean equals(Object other)

Overrides:

equals in class LCIMTypedMessage