NIMSDK-AOS  9.16.3
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.msg.model.IMMessage接口 参考

NIM消息实体数据结构。 第三方APP不要调用设置类接口,调用之后不会被持久化 更多...

类 com.netease.nimlib.sdk.msg.model.IMMessage 继承关系图:
com.netease.nimlib.sdk.msg.model.NIMMessage com.netease.nimlib.sdk.chatroom.model.ChatRoomMessage

Public 成员函数

String getSessionId ()
 获取聊天对象的Id(好友帐号,群ID等)。 更多...
 
SessionTypeEnum getSessionType ()
 获取会话类型。 更多...
 
MessageRobotInfo getRobotInfo ()
 获取消息的机器人信息 更多...
 
void setRobotInfo (MessageRobotInfo robotInfo)
 设置消息的机器人信息 更多...
 
Serializable getRealMsgObj ()
 获取真实消息对象 如果是圈组消息,可强转为QChatMessage对象; 如果是其他消息,可强转为IMMessage对象,即当前对象本身。 更多...
 
- Public 成员函数 继承自 com.netease.nimlib.sdk.msg.model.NIMMessage
String getUuid ()
 获取消息的uuid, 该域在生成消息时即会填上 更多...
 
boolean isTheSame (NIMMessage message)
 判断与参数message是否是同一条消息。
先比较数据库记录ID,如果没有数据库记录ID,则比较getUuid() 更多...
 
String getFromNick ()
 获取消息发送者的昵称 更多...
 
MsgTypeEnum getMsgType ()
 获取消息类型。 更多...
 
int getSubtype ()
 获取消息的子类型 更多...
 
void setSubtype (int subtype)
 设置消息的子类型。 更多...
 
MsgStatusEnum getStatus ()
 获取消息接收/发送状态。 更多...
 
void setStatus (MsgStatusEnum status)
 设置消息状态 更多...
 
void setDirect (MsgDirectionEnum direct)
 设置消息方向 更多...
 
MsgDirectionEnum getDirect ()
 获取消息方向:发出去的消息还是接收到的消息 更多...
 
void setContent (String content)
 设置消息具体内容。
当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时,该域为消息内容。 当为其他消息类型时,该域为可选项,如果设置,将作为iOS的apns推送文本以及android内置消息推送的显示文本。 更多...
 
String getContent ()
 获取消息具体内容。
当消息类型com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#text时,该域为消息内容。 当为其他消息类型时,该域为可选项,如果设置,将作为iOS的apns推送文本以及android内置消息推送的显示文本(1.7.0及以上版本建议使用pushContent)。 更多...
 
long getTime ()
 获取消息时间,单位为ms 更多...
 
void setFromAccount (String account)
 设置说话方的帐号。消息方向getDirect()根据改之 更多...
 
String getFromAccount ()
 获取该条消息发送方的帐号 更多...
 
void setAttachment (MsgAttachment attachment)
 设置消息附件对象。
如果附件内部包含状态,或是自定义附件类型,用户可自主更新,以便界面展现。
注意:设置之后,如需持久化到数据库,需要调用com.netease.nimlib.sdk.msg.MsgService#updateIMMessageStatus更新 更多...
 
MsgAttachment getAttachment ()
 获取消息附件对象。仅当getMsgType()返回为非text时有效 更多...
 
String getAttachStr ()
 获取消息附件文本内容 更多...
 
AttachStatusEnum getAttachStatus ()
 获取消息附件接收/发送状态 更多...
 
void setAttachStatus (AttachStatusEnum attachStatus)
 设置消息附件状态 更多...
 
CustomMessageConfig getConfig ()
 获取消息配置 更多...
 
void setConfig (CustomMessageConfig config)
 设置消息配置 更多...
 
Map< String, Object > getRemoteExtension ()
 获取扩展字段(该字段会发送到其他端) 更多...
 
void setRemoteExtension (Map< String, Object > remoteExtension)
 设置扩展字段(该字段会发送到其他端),最大长度1024字节。 更多...
 
Map< String, Object > getLocalExtension ()
 获取本地扩展字段(仅本地有效) 更多...
 
void setLocalExtension (Map< String, Object > localExtension)
 设置本地扩展字段(该字段仅在本地使用有效,不会发送给其他端),最大长度1024字节 更多...
 
String getCallbackExtension ()
 获取第三方回调回来的自定义扩展字段 更多...
 
String getPushContent ()
 获取自定义推送文案 更多...
 
void setPushContent (String pushContent)
 设置自定义推送文案(1.7.0及以上版本建议使用此字段,不要使用setContent来设置推送文案),目前长度限制为500字以内 更多...
 
Map< String, Object > getPushPayload ()
 获取第三方自定义的推送属性 更多...
 
void setPushPayload (Map< String, Object > pushPayload)
 设置第三方自定义的推送属性 更多...
 
MemberPushOption getMemberPushOption ()
 获取指定成员推送选项 更多...
 
void setMemberPushOption (MemberPushOption pushOption)
 设置指定成员推送选项 更多...
 
boolean isRemoteRead ()
 判断自己发送的消息对方是否已读 更多...
 
boolean needMsgAck ()
 是否需要消息已读(主要针对群消息) 更多...
 
void setMsgAck ()
 设置该消息为需要消息已读的 更多...
 
boolean hasSendAck ()
 是否已经发送过群消息已读回执 更多...
 
int getTeamMsgAckCount ()
 返回群消息已读回执的已读数 更多...
 
int getTeamMsgUnAckCount ()
 返回群消息已读回执的未读数 更多...
 
int getFromClientType ()
 获取消息发送方类型 更多...
 
NIMAntiSpamOption getNIMAntiSpamOption ()
 获取易盾反垃圾配置项 更多...
 
void setNIMAntiSpamOption (NIMAntiSpamOption nimAntiSpamOption)
 设置易盾反垃圾选项 更多...
 
void setClientAntiSpam (boolean hit)
 命中了客户端反垃圾,服务器处理 更多...
 
void setForceUploadFile (boolean forceUpload)
 如果服务器存在相同的附件文件,是否强制重新上传文件 ,默认false 更多...
 
boolean isInBlackList ()
 发送消息给对方, 是不是被对方拉黑了(消息本身是发送成功的) 更多...
 
long getServerId ()
 获取服务端消息id 更多...
 
void setChecked (Boolean isChecked)
 设置消息的选中状态 更多...
 
Boolean isChecked ()
 消息的选中状态 更多...
 
boolean isSessionUpdate ()
 消息是否需要刷新到session服务 只有消息存离线的情况下,才会判断该参数,默认:是 更多...
 
void setSessionUpdate (boolean sessionUpdate)
 设置消息是否需要刷新到session服务 只有消息存离线的情况下,才会判断该参数 更多...
 
MsgThreadOption getThreadOption ()
 获取消息的thread信息 更多...
 
void setThreadOption (NIMMessage parent)
 通过此消息的父消息设置消息的thread信息 更多...
 
boolean isThread ()
 此消息是不是一条thread消息 更多...
 
long getQuickCommentUpdateTime ()
 获取快捷评论的最后更新时间 更多...
 
boolean isDeleted ()
 该消息是否已经被从服务端撤回或删除 更多...
 
MessageKey getMessageKey ()
 获取消息的关键信息 更多...
 
String getYidunAntiCheating ()
 获取易盾反垃圾字段 更多...
 
void setYidunAntiCheating (String yidunAntiCheating)
 设置易盾反垃圾字段,要求是Json格式 更多...
 
String getEnv ()
 获取环境变量 用于指向不同的抄送,第三方回调等配置 注意:数据库不会保存此字段 更多...
 
void setEnv (String env)
 设置环境变量 用于指向不同的抄送,第三方回调等配置 注意:数据库不会保存此字段 更多...
 
String getYidunAntiSpamExt ()
 获取易盾反垃圾扩展字段 更多...
 
void setYidunAntiSpamExt (String yidunAntiSpamExt)
 设置易盾反垃圾扩展字段 更多...
 
String getYidunAntiSpamRes ()
 获取易盾反垃圾返回的结果 更多...
 

详细描述

NIM消息实体数据结构。 第三方APP不要调用设置类接口,调用之后不会被持久化

在文件 IMMessage.java10 行定义.

成员函数说明

◆ getRealMsgObj()

Serializable com.netease.nimlib.sdk.msg.model.IMMessage.getRealMsgObj ( )

获取真实消息对象 如果是圈组消息,可强转为QChatMessage对象; 如果是其他消息,可强转为IMMessage对象,即当前对象本身。

返回
真实消息对象

◆ getRobotInfo()

MessageRobotInfo com.netease.nimlib.sdk.msg.model.IMMessage.getRobotInfo ( )

获取消息的机器人信息

返回
MessageRobotInfo

◆ getSessionId()

String com.netease.nimlib.sdk.msg.model.IMMessage.getSessionId ( )

获取聊天对象的Id(好友帐号,群ID等)。

返回
聊天对象ID

◆ getSessionType()

SessionTypeEnum com.netease.nimlib.sdk.msg.model.IMMessage.getSessionType ( )

获取会话类型。

返回
会话类型

◆ setRobotInfo()

void com.netease.nimlib.sdk.msg.model.IMMessage.setRobotInfo ( MessageRobotInfo  robotInfo)

设置消息的机器人信息

参数
robotInfo消息的机器人信息

该接口的文档由以下文件生成: