NIM C# SDK  6.3.0
NIM.NIMIMMessage Class Reference
Inheritance diagram for NIM.NIMIMMessage:
NimUtility.NimJsonObject< NIMIMMessage > NIM.NIMAudioMessage NIM.NIMCustomMessage< T > NIM.NIMFileMessage NIM.NIMImageMessage NIM.NIMLocationMessage NIM.NIMTeamNotificationMessage NIM.NIMTextMessage NIM.NIMTipMessage NIM.NIMUnknownMessage NIM.NIMVideoMessage NIM.Robot.ResponseMessage NIM.Robot.RobotMessage

Public Member Functions

override string Serialize ()
 
- Public Member Functions inherited from NimUtility.NimJsonObject< NIMIMMessage >
virtual string SerializeWithIndented ()
 

Protected Member Functions

 NIMIMMessage ()
 

Properties

NIMSessionType SessionType [get, set]
 会话类型 More...
 
string SenderID [get, set]
 消息发送方id,服务器填写,发送方不需要填写 More...
 
string ReceiverID [get, set]
 消息接收方id,给自己发送消息时填写自己id More...
 
NIMClientType SenderClientType [get, set]
 消息发送方客户端类型,服务器填写,发送方不需要填写 More...
 
string SenderDeviceId [get]
 消息发送方设备id,服务器填写,发送方不需要填写 More...
 
string SenderNickname [get]
 消息发送方昵称,服务器填写,发送方不需要填写 More...
 
long TimeStamp [get, set]
 消息时间戳(毫秒) More...
 
NIMMessageType MessageType [get, set]
 消息类型 More...
 
string ClientMsgID [get, set]
 消息ID(客户端) More...
 
long ServerMsgId [get]
 服务器端消息id More...
 
int ResendFlag [get, set]
 消息重发标记位,第一次发送0,重发1 More...
 
bool NeedCounting [get, set]
 (可选)推送是否要做消息计数(角标) 默认 True More...
 
string ServerExtension [get, set]
 第三方扩展字段, 格式不限,长度限制1024 More...
 
string PushPayload [get, set]
 自定义的推送属性,限制非格式化的json string,长度2048 More...
 
string PushContent [get, set]
 自定义推送文案,长度限制200字节 More...
 
bool NeedPush [get, set]
 (可选)是否需要推送 默认 True More...
 
bool NeedPushNick [get, set]
 (可选)推送是否需要前缀 默认 True More...
 
bool ServerSaveHistory [get, set]
 (可选)该消息是否存储云端历史,可选,默认 True More...
 
bool Roaming [get, set]
 (可选)该消息是否支持漫游,可选, 默认 True More...
 
bool MultiSync [get, set]
 (可选)该消息是否支持发送者多端同步,可选, 默认 True More...
 
bool Routable [get, set]
 (可选)该消息是否抄送,0:不支持,1:支持,默认按照app的路由开关 More...
 
bool SavedOffline [get, set]
 (可选)消息是否要存离线,0:不需要, 1:需要,默认1 More...
 
bool? AntiSpamEnabled [get, set]
 是否需要过易盾反垃圾,默认false More...
 
string AntiSpamContent [get, set]
 (可选)开发者自定义的反垃圾字段,长度限制:5000字符, 格式为json string,{"type" : 1:文本,2:图片,3视频, "data" : "文本内容or图片地址or视频地址"} More...
 
bool ClientAntiSpamHitting [get, set]
 是否命中客户端反垃圾 More...
 
string AntiSpamBizID [get, set]
 (可选)用户配置的对某些单条消息另外的反垃圾的业务ID More...
 
int AntiSpamUsingYiDun [get, set]
 (可选) 单条消息是否使用易盾反垃圾 0:(在开通易盾的情况下)不过易盾反垃圾而是通用反垃圾 其他都是按照原来的规则 More...
 
int NeedTeamAck [get, set]
 群消息是否需要已读业务,0:不需要,1:需要 More...
 
bool TeamMsgAckSent [get, set]
 是否已经发送群消息已读回执 More...
 
int TeamMsgUnreadCount [get, set]
 群消息未读数 More...
 
string LocalFilePath [get, set]
 多媒体消息资源本地绝对路径,SDK本地维护,发送多媒体消息时必填 More...
 
string TalkID [get, set]
 会话id,发送方选填,接收方收到的是消息发送方id More...
 
string ResourceId [get, set]
 多媒体资源id,发送方选填,接收方收到的是客户端消息id More...
 
NIMMsgLogStatus MsgLogStatus [get, set]
 消息状态 More...
 
NIMMsgLogSubStatus MsgLogSubStatus [get, set]
 消息状态 More...
 
string LocalExtension [get, set]
 本地扩展内容 More...
 
- Properties inherited from NimUtility.NimJsonObject< NIMIMMessage >
virtual bool IgnoreDefauleValue [get, set]
 
string JSON [get, set]
 

Additional Inherited Members

- Static Public Member Functions inherited from NimUtility.NimJsonObject< NIMIMMessage >
static T Deserialize (string json)
 

Constructor & Destructor Documentation

◆ NIMIMMessage()

NIM.NIMIMMessage.NIMIMMessage ( )
protected

Member Function Documentation

◆ Serialize()

override string NIM.NIMIMMessage.Serialize ( )
virtual

Property Documentation

◆ AntiSpamBizID

string NIM.NIMIMMessage.AntiSpamBizID
getset

(可选)用户配置的对某些单条消息另外的反垃圾的业务ID

◆ AntiSpamContent

string NIM.NIMIMMessage.AntiSpamContent
getset

(可选)开发者自定义的反垃圾字段,长度限制:5000字符, 格式为json string,{"type" : 1:文本,2:图片,3视频, "data" : "文本内容or图片地址or视频地址"}

◆ AntiSpamEnabled

bool? NIM.NIMIMMessage.AntiSpamEnabled
getset

是否需要过易盾反垃圾,默认false

◆ AntiSpamUsingYiDun

int NIM.NIMIMMessage.AntiSpamUsingYiDun
getset

(可选) 单条消息是否使用易盾反垃圾 0:(在开通易盾的情况下)不过易盾反垃圾而是通用反垃圾 其他都是按照原来的规则

◆ ClientAntiSpamHitting

bool NIM.NIMIMMessage.ClientAntiSpamHitting
getset

是否命中客户端反垃圾

◆ ClientMsgID

string NIM.NIMIMMessage.ClientMsgID
getset

消息ID(客户端)

◆ LocalExtension

string NIM.NIMIMMessage.LocalExtension
getset

本地扩展内容

◆ LocalFilePath

string NIM.NIMIMMessage.LocalFilePath
getset

多媒体消息资源本地绝对路径,SDK本地维护,发送多媒体消息时必填

◆ MessageType

NIMMessageType NIM.NIMIMMessage.MessageType
getset

消息类型

◆ MsgLogStatus

NIMMsgLogStatus NIM.NIMIMMessage.MsgLogStatus
getset

消息状态

◆ MsgLogSubStatus

NIMMsgLogSubStatus NIM.NIMIMMessage.MsgLogSubStatus
getset

消息状态

◆ MultiSync

bool NIM.NIMIMMessage.MultiSync
getset

(可选)该消息是否支持发送者多端同步,可选, 默认 True

◆ NeedCounting

bool NIM.NIMIMMessage.NeedCounting
getset

(可选)推送是否要做消息计数(角标) 默认 True

◆ NeedPush

bool NIM.NIMIMMessage.NeedPush
getset

(可选)是否需要推送 默认 True

◆ NeedPushNick

bool NIM.NIMIMMessage.NeedPushNick
getset

(可选)推送是否需要前缀 默认 True

◆ NeedTeamAck

int NIM.NIMIMMessage.NeedTeamAck
getset

群消息是否需要已读业务,0:不需要,1:需要

◆ PushContent

string NIM.NIMIMMessage.PushContent
getset

自定义推送文案,长度限制200字节

◆ PushPayload

string NIM.NIMIMMessage.PushPayload
getset

自定义的推送属性,限制非格式化的json string,长度2048

◆ ReceiverID

string NIM.NIMIMMessage.ReceiverID
getset

消息接收方id,给自己发送消息时填写自己id

◆ ResendFlag

int NIM.NIMIMMessage.ResendFlag
getset

消息重发标记位,第一次发送0,重发1

◆ ResourceId

string NIM.NIMIMMessage.ResourceId
getset

多媒体资源id,发送方选填,接收方收到的是客户端消息id

◆ Roaming

bool NIM.NIMIMMessage.Roaming
getset

(可选)该消息是否支持漫游,可选, 默认 True

◆ Routable

bool NIM.NIMIMMessage.Routable
getset

(可选)该消息是否抄送,0:不支持,1:支持,默认按照app的路由开关

◆ SavedOffline

bool NIM.NIMIMMessage.SavedOffline
getset

(可选)消息是否要存离线,0:不需要, 1:需要,默认1

◆ SenderClientType

NIMClientType NIM.NIMIMMessage.SenderClientType
getset

消息发送方客户端类型,服务器填写,发送方不需要填写

◆ SenderDeviceId

string NIM.NIMIMMessage.SenderDeviceId
get

消息发送方设备id,服务器填写,发送方不需要填写

◆ SenderID

string NIM.NIMIMMessage.SenderID
getset

消息发送方id,服务器填写,发送方不需要填写

◆ SenderNickname

string NIM.NIMIMMessage.SenderNickname
get

消息发送方昵称,服务器填写,发送方不需要填写

◆ ServerExtension

string NIM.NIMIMMessage.ServerExtension
getset

第三方扩展字段, 格式不限,长度限制1024

◆ ServerMsgId

long NIM.NIMIMMessage.ServerMsgId
get

服务器端消息id

◆ ServerSaveHistory

bool NIM.NIMIMMessage.ServerSaveHistory
getset

(可选)该消息是否存储云端历史,可选,默认 True

◆ SessionType

NIMSessionType NIM.NIMIMMessage.SessionType
getset

会话类型

◆ TalkID

string NIM.NIMIMMessage.TalkID
getset

会话id,发送方选填,接收方收到的是消息发送方id

◆ TeamMsgAckSent

bool NIM.NIMIMMessage.TeamMsgAckSent
getset

是否已经发送群消息已读回执

◆ TeamMsgUnreadCount

int NIM.NIMIMMessage.TeamMsgUnreadCount
getset

群消息未读数

◆ TimeStamp

long NIM.NIMIMMessage.TimeStamp
getset

消息时间戳(毫秒)