NIMSDK-AOS  9.16.0
NIMMessage.java
浏览该文件的文档.
1 package com.netease.nimlib.sdk.msg.model;
2 
8 
9 import java.io.Serializable;
10 import java.util.Map;
11 
12 public interface NIMMessage extends Serializable {
18  String getUuid();
19 
27  boolean isTheSame(NIMMessage message);
28 
34  String getFromNick();
35 
42 
48  int getSubtype();
49 
55  void setSubtype(int subtype);
56 
63 
69  void setStatus(MsgStatusEnum status);
70 
76  void setDirect(MsgDirectionEnum direct);
77 
84 
92  void setContent(String content);
93 
101  String getContent();
102 
108  long getTime();
109 
115  void setFromAccount(String account);
116 
120  String getFromAccount();
121 
129  void setAttachment(MsgAttachment attachment);
130 
135 
141  String getAttachStr();
142 
147 
151  void setAttachStatus(AttachStatusEnum attachStatus);
152 
159 
165  void setConfig(CustomMessageConfig config);
166 
172  Map<String, Object> getRemoteExtension();
173 
179  void setRemoteExtension(Map<String, Object> remoteExtension);
180 
186  Map<String, Object> getLocalExtension();
187 
193  void setLocalExtension(Map<String, Object> localExtension);
194 
200  String getCallbackExtension();
201 
207  String getPushContent();
208 
214  void setPushContent(String pushContent);
215 
221  Map<String, Object> getPushPayload();
222 
228  void setPushPayload(Map<String, Object> pushPayload);
229 
236 
242  void setMemberPushOption(MemberPushOption pushOption);
243 
249  boolean isRemoteRead();
250 
256  boolean needMsgAck();
257 
261  void setMsgAck();
262 
268  boolean hasSendAck();
269 
275  int getTeamMsgAckCount();
276 
282  int getTeamMsgUnAckCount();
283 
289  int getFromClientType();
290 
297 
303  void setNIMAntiSpamOption(NIMAntiSpamOption nimAntiSpamOption);
304 
310  void setClientAntiSpam(boolean hit);
311 
312 
318  void setForceUploadFile(boolean forceUpload);
319 
320 
327  boolean isInBlackList();
328 
334  long getServerId();
335 
341  void setChecked(Boolean isChecked);
342 
348  Boolean isChecked();
349 
356  boolean isSessionUpdate();
357 
362  void setSessionUpdate(boolean sessionUpdate);
363 
370 
376  void setThreadOption(NIMMessage parent);
377 
381  boolean isThread();
382 
389 
395  boolean isDeleted();
396 
403 
409  String getYidunAntiCheating();
410 
416  void setYidunAntiCheating(String yidunAntiCheating);
417 
425  String getEnv();
426 
434  void setEnv(String env);
435 
440  String getYidunAntiSpamExt();
441 
446  void setYidunAntiSpamExt(String yidunAntiSpamExt);
447 
452  String getYidunAntiSpamRes();
453 }
void setYidunAntiSpamExt(String yidunAntiSpamExt)
设置易盾反垃圾扩展字段
MessageKey getMessageKey()
获取消息的关键信息
String getCallbackExtension()
获取第三方回调回来的自定义扩展字段
void setAttachment(MsgAttachment attachment)
设置消息附件对象。 如果附件内部包含状态,或是自定义附件类型,用户可自主更新,以便界面展现。 注意:...
AttachStatusEnum getAttachStatus()
获取消息附件接收/发送状态
String getAttachStr()
获取消息附件文本内容
boolean isTheSame(NIMMessage message)
判断与参数message是否是同一条消息。 先比较数据库记录ID,如果没有数据库记录ID,则比较getUuid() ...
void setLocalExtension(Map< String, Object > localExtension)
设置本地扩展字段(该字段仅在本地使用有效,不会发送给其他端),最大长度1024字节
Boolean isChecked()
消息的选中状态
void setConfig(CustomMessageConfig config)
设置消息配置
String getYidunAntiSpamRes()
获取易盾反垃圾返回的结果
MsgStatusEnum getStatus()
获取消息接收/发送状态。
long getQuickCommentUpdateTime()
获取快捷评论的最后更新时间
long getTime()
获取消息时间,单位为ms
int getTeamMsgAckCount()
返回群消息已读回执的已读数
指定成员推送相关可选项 配置后发送消息,如果遇到414,说明客户端提交参数(forcePushList)格式有误;811说...
String getYidunAntiSpamExt()
获取易盾反垃圾扩展字段
void setPushPayload(Map< String, Object > pushPayload)
设置第三方自定义的推送属性
long getServerId()
获取服务端消息id
void setDirect(MsgDirectionEnum direct)
设置消息方向
消息本身发送/接收状态,附件状态见AttachStatusEnum
Map< String, Object > getPushPayload()
获取第三方自定义的推送属性
MsgDirectionEnum getDirect()
获取消息方向:发出去的消息还是接收到的消息
void setStatus(MsgStatusEnum status)
设置消息状态
void setThreadOption(NIMMessage parent)
通过此消息的父消息设置消息的thread信息
boolean needMsgAck()
是否需要消息已读(主要针对群消息)
int getTeamMsgUnAckCount()
返回群消息已读回执的未读数
void setPushContent(String pushContent)
设置自定义推送文案(1.7.0及以上版本建议使用此字段,不要使用setContent来设置推送文案),目前长度限制为...
void setFromAccount(String account)
设置说话方的帐号。消息方向getDirect()根据改之
void setForceUploadFile(boolean forceUpload)
如果服务器存在相同的附件文件,是否强制重新上传文件 ,默认false
String getEnv()
获取环境变量 用于指向不同的抄送,第三方回调等配置 注意:数据库不会保存此字段
CustomMessageConfig getConfig()
获取消息配置
void setSubtype(int subtype)
设置消息的子类型。
Map< String, Object > getLocalExtension()
获取本地扩展字段(仅本地有效)
消息的配置选项,主要用于设定消息的声明周期,是否需要推送,是否需要计入未读数等。
MsgAttachment getAttachment()
获取消息附件对象。仅当getMsgType()返回为非text时有效
void setClientAntiSpam(boolean hit)
命中了客户端反垃圾,服务器处理
void setAttachStatus(AttachStatusEnum attachStatus)
设置消息附件状态
消息的关键信息,通过这些信息可以从服务端查询到该消息的完整部分
Definition: MessageKey.java:17
void setContent(String content)
设置消息具体内容。 当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时,该域为消息内容...
void setMemberPushOption(MemberPushOption pushOption)
设置指定成员推送选项
String getFromNick()
获取消息发送者的昵称
String getUuid()
获取消息的uuid, 该域在生成消息时即会填上
String getPushContent()
获取自定义推送文案
boolean isThread()
此消息是不是一条thread消息
NIMAntiSpamOption getNIMAntiSpamOption()
获取易盾反垃圾配置项
void setNIMAntiSpamOption(NIMAntiSpamOption nimAntiSpamOption)
设置易盾反垃圾选项
boolean isInBlackList()
发送消息给对方, 是不是被对方拉黑了(消息本身是发送成功的)
MsgTypeEnum getMsgType()
获取消息类型。
void setChecked(Boolean isChecked)
设置消息的选中状态
void setSessionUpdate(boolean sessionUpdate)
设置消息是否需要刷新到session服务 只有消息存离线的情况下,才会判断该参数
boolean isRemoteRead()
判断自己发送的消息对方是否已读
int getSubtype()
获取消息的子类型
void setRemoteExtension(Map< String, Object > remoteExtension)
设置扩展字段(该字段会发送到其他端),最大长度1024字节。
boolean isDeleted()
该消息是否已经被从服务端撤回或删除
void setEnv(String env)
设置环境变量 用于指向不同的抄送,第三方回调等配置 注意:数据库不会保存此字段
void setMsgAck()
设置该消息为需要消息已读的
boolean isSessionUpdate()
消息是否需要刷新到session服务 只有消息存离线的情况下,才会判断该参数,默认:是
String getYidunAntiCheating()
获取易盾反垃圾字段
MemberPushOption getMemberPushOption()
获取指定成员推送选项
Map< String, Object > getRemoteExtension()
获取扩展字段(该字段会发送到其他端)
void setYidunAntiCheating(String yidunAntiCheating)
设置易盾反垃圾字段,要求是Json格式
boolean hasSendAck()
是否已经发送过群消息已读回执
MsgThreadOption getThreadOption()
获取消息的thread信息
int getFromClientType()
获取消息发送方类型
String getFromAccount()
获取该条消息发送方的帐号
String getContent()
获取消息具体内容。 当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时,该域为消息内容...