类与常量定义说明

NIMSDKLogLevel

枚举定义 说明
kNIMSDKLogLevelFatal 1 SDK Fatal级别Log
kNIMSDKLogLevelError 2 SDK Error级别Log
kNIMSDKLogLevelWarn 3 SDK Warn级别Log
kNIMSDKLogLevelApp 4 SDK应用级别Log,正式发布时为了精简sdk log,可采用此级别
kNIMSDKLogLevelPro 5 SDK调试过程级别Log,更加详细,更有利于开发调试

File:nim_global_def.h

NIMProxyType

枚举定义 说明
kNIMProxyNone 0 不使用代理
kNIMProxyHttp11 1 HTTP 1.1 Proxy(暂不支持)
kNIMProxySocks4 2 Socks4 Proxy
kNIMProxySocks4a 3 Socks4a Proxy
kNIMProxySocks5 4 Socks5 Proxy

File:nim_global_def.h

NIMLogoutType

枚举定义 说明
kNIMLogoutChangeAccout 1 注销/切换帐号(返回到登录界面)
kNIMLogoutKickout 2 被踢(返回到登录界面)
kNIMLogoutAppExit 3 程序退出
kNIMLogoutRelogin 4 重连操作,包括保存密码时启动程序伪登录后的重连操作以及掉线后的重连操作(帐号未变化)

File:nim_client_def.h

NIMIMMessage

成员/方法 类型 只读 说明
Serialize() - - 序列化方法
SessionType enum N 会话类型
SenderID string Y 消息发送方id,服务器填写,发送方不需要填写
ReceiverID string N 消息接收方id,给自己发送消息时填写自己id
SenderClientType enum Y 消息发送方客户端类型,服务器填写,发送方不需要填写
SenderDeviceId string Y 消息发送方设备id,服务器填写,发送方不需要填写
SenderNickname string Y 消息发送方昵称,服务器填写,发送方不需要填写
TimeStamp int64 N 消息时间戳(毫秒)
MessageType enum N 消息类型
ClientMsgID string N 消息ID(客户端)
ServerMsgId string Y 服务器端消息id
ResendFlag int N 消息重发标记位,第一次发送0,重发1
NeedCounting bool N (可选)推送是否要做消息计数(角标) 默认 True
ServerExtension string N 第三方扩展字段, 格式不限,长度限制1024
PushPayload JsonExtension N 自定义的推送属性,限制非格式化的json string,长度2048
PushContent string N 自定义推送文案,长度限制200字节
NeedPush bool N (可选)是否需要推送 默认 True
NeedPushNick bool N (可选)推送是否需要前缀 默认 True
ServerSaveHistory bool N (可选)该消息是否存储云端历史,可选,默认 True
Roaming bool N (可选)该消息是否支持漫游,可选, 默认 True
MultiSync bool N (可选)该消息是否支持发送者多端同步,可选, 默认 True
Routable bool N (可选)该消息是否抄送,默认按照app的路由开关
SavedOffline bool N (可选)消息是否要存离线,默认true
AntiSpamEnabled bool N 是否需要过易盾反垃圾,默认false
AntiSpamContent string N (可选)开发者自定义的反垃圾字段,长度限制:5000字符, 格式为json string,{"type" : 1:文本,2:图片,3视频, "data" : "文本内容or图片地址or视地址"}
LocalFilePath string N 多媒体消息资源本地绝对路径,SDK本地维护,发送多媒体消息时必填
TalkID string N 会话id,发送方选填,接收方收到的是消息发送方id
ResourceId string N 多媒体资源id,发送方选填,接收方收到的是客户端消息id
MsgLogStatus enum N 消息状态
MsgLogSubStatus enum N 消息子状态
LocalExtension string N 本地扩展内容

NIMMessageType

枚举定义 说明
kNIMMessageTypeText 0 文本类型消息
kNIMMessageTypeImage 1 图片类型消息
kNIMMessageTypeAudio 2 声音类型消息
kNIMMessageTypeVideo 3 短视频类型消息
kNIMMessageTypeLocation 4 位置类型消息
kNIMMessageTypeNotification 5 系统类型通知(包括入群出群通知等)
kNIMMessageTypeFile 6 文件类型消息
kNIMMessageTypeTips 10 提醒类型消息,Tip内容根据格式要求填入消息结构中的kNIMMsgKeyServerExt字段
kNIMMessageTypeRobot 11 波特机器人消息
kNIMMessageTypeCustom 100 自定义消息
kNIMMessageTypeUnknown 1000 未知类型消息,本地使用,发送时勿使用,作为默认值

File:nim_msglog_def.h

NIMSessionType

枚举定义 说明
kNIMSessionTypeP2P 0 个人,即点对点
kNIMSessionTypeTeam 1 群组

File:nim_session_def.h

IMMessage

成员/方法 类型 只读 说明
ToJsonString (bool use_to_send) - - 序列化方法
attach_ string N 消息附件
client_msg_id_ string N 消息ID(客户端)
content_ string N 消息内容,长度限制5000
feature_ NIMMessageFeature Y 消息属性
local_res_id_ string N 媒体文件ID(客户端)
local_res_path_ string N 媒体文件本地绝对路径(客户端)
local_talk_id_ string N 会话ID(客户端)
msg_setting_ MessageSetting N 消息属性设置
readonly_sender_client_type_ NIMClientType Y 发送者客户端类型(只读)
readonly_sender_device_id_ string Y 发送者客户端设备ID(只读)
readonly_sender_nickname_ string Y 发送者昵称(只读)
readonly_server_id_ int64 Y 消息ID(服务器,只读)
receiver_accid_ string N 接收者ID
rescode_ NIMResCode Y 错误码
sender_accid_ string Y 发送者ID
session_type_ NIMSessionType N 会话类型
status_ NIMMsgLogStatus Y 消息状态(客户端)
sub_status_ NIMMsgLogSubStatus N 消息子状态(客户端)
timetag_ int64 Y 消息时间戳(毫秒)
type_ NIMMessageType N 消息类型

File:nim_talk_helper.h

NIMMessageFeature

枚举定义 说明
kNIMMessageFeatureDefault 0 默认
kNIMMessageFeatureLeaveMsg 1 离线消息
kNIMMessageFeatureRoamMsg 2 漫游消息
kNIMMessageFeatureSyncMsg 3 同步消息
kNIMMessageFeatureCustomizedMsg 4 透传消息

File:nim_msglog_def.h

NIMClientType

枚举定义 说明
kNIMClientTypeDefault 0 默认
kNIMClientTypeAndroid 1 Android
kNIMClientTypeiOS 2 iOS
kNIMClientTypePCWindows 4 PC Windows
kNIMClientTypeWeb 16 Web
kNIMClientTypeRestAPI 32 RestAPI
kNIMClientTypeMacOS 64 Mac

File:nim_client_def.h

NIMMsgLogStatus

枚举定义 说明
kNIMMsgLogStatusNone 0 默认,不能当查询条件,意义太多
kNIMMsgLogStatusUnread 1 收到消息,未读
kNIMMsgLogStatusRead 2 收到消息,已读
kNIMMsgLogStatusDeleted 3 已删
kNIMMsgLogStatusSending 4 发送中
kNIMMsgLogStatusSendFailed 5 发送失败
kNIMMsgLogStatusSent 6 已发送
kNIMMsgLogStatusReceipt 7 对方已读发送的内容
kNIMMsgLogStatusDraft 8 草稿
kNIMMsgLogStatusSendCancel 9 发送取消

File:nim_msglog_def.h

NIMMsgLogSubStatus

枚举定义 说明
kNIMMsgLogSubStatusNone 0 默认
kNIMMsgLogSubStatusNotPlaying 20 未播放
kNIMMsgLogSubStatusPlayed 21 已播放

File:nim_msglog_def.h

MessageSetting

成员/方法 类型 只读 说明
ToJsonValue (Json::Value &message) - - 组装Json Value字符串
ParseMessageSetting (const Json::Value &message) - - 从Json Value解析出消息属性设置
anti_spam_content_ string N (可选)开发者自定义的反垃圾字段,长度限制5000
anti_spam_enable_ BoolStatus N 是否需要过易盾反垃圾
force_push_content_ string N 群组消息强推文本
force_push_ids_list_ list N 群组消息强推列表
is_force_push_ BoolStatus N 群组消息强推开关,强推全员设置true并强推列表为空
local_ext_ string N 本地扩展字段, 格式不限,长度限制1024
need_offline_ BoolStatus N 是否支持离线消息
need_push_ BoolStatus N 是否需要推送
push_content_ string N 自定义推送文案,长度限制200字节
push_need_badge_ BoolStatus N 是否要做消息计数
push_need_prefix_ BoolStatus N 需要推送昵称
push_payload_ Json::Value N 第三方自定义的推送属性,长度2048
resend_flag_ BoolStatus N 该消息是否为重发状态
roaming_ BoolStatus N 该消息是否支持漫游
routable_ BoolStatus N 是否要抄送
self_sync_ BoolStatus N 该消息是否支持发送者多端同步
server_ext_ Json::Value N 第三方扩展字段, 长度限制1024
server_history_saved_ BoolStatus N 该消息是否存储云端历史

File:nim_talk_helper.h

Namespace:NIM

IMFile

成员/方法 类型 只读 说明
ToJsonString () - - 组装Json Value字符串
ToJsonString (Json::Value &attach) - - 组装Json Value字符串
display_name_ string N 用于显示的文件名称
file_extension_ string N 文件扩展名
md5_ string N 文件内容MD5
size_ int64 N 文件大小
url_ string N 上传云端后得到的文件下载地址

File:nim_talk_helper.h

Namespace:NIM

IMImage

基类IMFile

成员/方法 类型 只读 说明
ToJsonString () - - 序列化方法
height_ int N 图片宽度
width_ int N 消息发送方id,服务器填写,发送方不需要填写

File:nim_talk_helper.h

Namespace:NIM

IMAudio

基类IMFile

成员/方法 类型 只读 说明
ToJsonString () - - 序列化方法
duration_ int N 语音时长,单位秒

File:nim_talk_helper.h

Namespace:NIM

IMVideo

基类IMFile

成员/方法 类型 只读 说明
ToJsonString () - - 序列化方法
duration_ int N 视频时长,单位秒
height_ int N 视频画面高度
width_ int N 视频画面宽度

File:nim_talk_helper.h

Namespace:NIM

IMLocation

成员/方法 类型 只读 说明
ToJsonString () - - 序列化方法
description_ string N 位置描述内容
latitude_ double N 位置纬度
longitude_ double N 位置经度

File:nim_talk_helper.h

Namespace:NIM

IMBotRobot

成员/方法 类型 只读 说明
ToJsonString () - - 序列化方法
out_msg_ bool N 是否为机器人回复,是:true,不是:false,默认false
related_msg_id_ string N 机器人回复时带的字段,表示该条回复相关联的消息ID
robot_accid_ string N 机器人云信ID
robot_msg_content_ Json::Value N 机器人回复时带的字段,表示该条回复内容,字段内容定义可见Demo源码或参考波特开发文档
robot_msg_flag_ string N 机器人回复时带的字段,表示该条回复类型,类型定义可见Demo源码或参考波特开发文档
sent_param_ Json::Value N 给机器人发送时需要填的字段,字段内容定义可见Demo源码或参考波特开发文档

File:nim_talk_helper.h

Namespace:NIM

MessageArcEventArgs

传输门

SendMessageArc

传输门