Go to the documentation of this file.
7 #ifndef NIM_CHATROOM_NIM_CHATROOM_DEFINES_NIM_CHATROOM_DEF_H_
8 #define NIM_CHATROOM_NIM_CHATROOM_DEFINES_NIM_CHATROOM_DEF_H_
53 const char* json_extension,
54 const void* user_data);
65 typedef void (*
nim_chatroom_exit_cb_func)(int64_t room_id,
int error_code,
int exit_type,
const char* json_extension,
const void* user_data);
147 const char* json_extension,
148 const void* user_data);
201 const char* json_extension,
202 const void* user_data);
217 const char* json_extension,
218 const void* user_data);
338 typedef void (*nim_chatroom_update_location_cb_func)(int64_t room_id,
int error_code,
const char* json_extension,
const void* user_data);
348 typedef void (*nim_chatroom_custom_token_cb_func)(
char* auth_token,
const uint32_t length,
const char* json_params,
const void* user_data);
358 typedef void (*nim_chatroom_update_tags_cb_func)(int64_t room_id,
int error_code,
const char* json_extension,
const void* user_data);
366 typedef void (*nim_chatroom_sdk_log_cb_func)(
const char* log_content,
const void* user_data);
391 static const char* kNIMChatRoomEnterLocationX =
"location_x";
392 static const char* kNIMChatRoomEnterLocationY =
"location_y";
393 static const char* kNIMChatRoomEnterLocationZ =
"location_z";
394 static const char* kNIMChatRoomEnterLocationDistance =
"location_distance";
898 typedef char* NIMChatRoomConfigGetter;
899 #define EmptyNIMChatRoomConfigGetter ("")
902 #endif // __cplusplus
903 #endif // NIM_CHATROOM_NIM_CHATROOM_DEFINES_NIM_CHATROOM_DEF_H_
static const char * kNIMChatRoomEnterCallbackKeyMyInfo
json value, 见聊天室个人Info Json Keys
Definition: nim_chatroom_def.h:536
static const char * kNIMChatRoomGetMembersKeyLimit
int 数量
Definition: nim_chatroom_def.h:674
@ kNIMChatRoomNotificationIdMemberTempUnMute
Definition: nim_chatroom_def.h:813
static const char * kNIMRobotInfoKeyName
string 名字
Definition: nim_chatroom_def.h:859
NIMChatRoomLoginState
Definition: nim_chatroom_def.h:627
static const char * kNIMChatRoomAntiSpamBusinessID
string 反垃圾
Definition: nim_chatroom_def.h:616
static const char * kNIMChatRoomMsgKeyHistorySave
int,(可选)该消息是否存储云端历史,可选,0:不是,1:是, 默认1
Definition: nim_chatroom_def.h:439
static const char * kChatRoomNotificationDataKeyTempMuteDuration
long 当通知为临时禁言相关时有该值,禁言时kNIMChatRoomNotificationIdMemberTempMute代表本次禁言的时长(秒)
Definition: nim_chatroom_def.h:721
static const char * kNIMChatRoomNotificationQueueBatchChangedKeyType
string 变更类型,目前有OFFER,POLL,DROP,PARTCLEAR四个类型
Definition: nim_chatroom_def.h:787
static const char * kNIMChatRoomMsgKeyClientMsgid
string,客户端消息id
Definition: nim_chatroom_def.h:427
static const char * kNIMChatRoomEnterAuthType
int 鉴权方式,0表示最初的loginToken的校验方式,1表示基于appSecret计算的token鉴权方式,2表示基于第三方回调的token鉴权方式,默认0
Definition: nim_chatroom_def.h:384
static const char * kNIMChatRoomEnterKeyNick
string, (匿名登录时必填)进入聊天室后展示的昵称,选填,聊天室成员收到聊天室进入通知中可以获取该数据
Definition: nim_chatroom_def.h:372
@ kNIMChatRoomExitReasonExit
Definition: nim_chatroom_def.h:567
static const char * kNIMChatRoomNotificationQueueChangedType_DROP
清理队列操作
Definition: nim_chatroom_def.h:766
NIMChatRoomExitReason
Definition: nim_chatroom_def.h:566
@ kNIMSDKLogLevelWarn
Definition: nim_chatroom_def.h:498
@ kNIMChatRoomNotificationIdRemoveMute
Definition: nim_chatroom_def.h:804
static const char * kNIMChatRoomMemberInfoKeyNotifyTags
string 聊天室成员登录时指定的 notify_tags 信息
Definition: nim_chatroom_def.h:595
static const char * kEnterKeyPublicConfigRoot
json obj 公共配置root key
Definition: nim_chatroom_def.h:876
void(* nim_chatroom_get_members_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:120
static const char * kNIMChatRoomMemberInfoKeyUpdateTimetag
long 固定成员的记录更新时间,用于固定成员列表的排列查询
Definition: nim_chatroom_def.h:610
static const char * kNIMChatRoomMemberInfoKeyAvatar
string 聊天室内的头像,预留字段, 可从Uinfo中取icon
Definition: nim_chatroom_def.h:589
static const char * kEnterKeyNegoKeyNECAKeyV
int 非对称加密算法的 key version 自定义时则必填
Definition: nim_chatroom_def.h:896
static const char * kNIMChatRoomMemberInfoKeyRoomID
long 聊天室id
Definition: nim_chatroom_def.h:579
static const char * kNIMChatRoomMsgKeyFromAvatar
string, 消息发送方头像,服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:479
float x_
位置信息 x 坐标
Definition: nim_chatroom_def.h:18
@ kNIMChatRoomMsgTypeRobot
Definition: nim_chatroom_def.h:512
static const char * kNIMChatRoomMemberInfoKeyType
成员类型, -1:受限用户; 0:普通;1:创建者;2:管理员;3:临时用户,非固定成员;4:匿名非注册用户,非云信注册用户
Definition: nim_chatroom_def.h:583
static const char * kChatRoomNotificationDataKeyOpt
string 操作者的账号accid
Definition: nim_chatroom_def.h:713
@ kNIMChatRoomNotificationIdTagTempMuteRemove
Definition: nim_chatroom_def.h:820
@ kNIMChatRoomGuestFlagGuest
Definition: nim_chatroom_def.h:641
@ kNIMChatRoomProxyHttp11
Definition: nim_chatroom_def.h:845
void(* nim_chatroom_exit_cb_func)(int64_t room_id, int error_code, int exit_type, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:65
NIMChatRoomMemberAttribute
Definition: nim_chatroom_def.h:657
static const char * kNIMChatRoomMemberInfoKeyMuted
int 是禁言用户
Definition: nim_chatroom_def.h:606
@ kNIMChatRoomGetMemberTypeTemp
非固定成员,非固定成员,又称临时成员,只有在线时才能在列表中看到,数量无上限,查询时时间戳使用"进入聊天室时间"
Definition: nim_chatroom_def.h:649
@ kNIMChatRoomMsgTypeVideo
Definition: nim_chatroom_def.h:508
static const char * kNIMRobotInfoKeyRobotId
string 机器人ID
Definition: nim_chatroom_def.h:865
static const char * kNIMChatRoomMsgKeySubType
(可选)int,消息的子类型,客户端定义,服务器透传
Definition: nim_chatroom_def.h:447
static const char * kNIMChatRoomNotificationQueueChangedType_POLL
从队列中取出新队列
Definition: nim_chatroom_def.h:764
static const char * kNIMChatRoomQueueElementKey
string 元素key
Definition: nim_chatroom_def.h:743
@ kNIMChatRoomEnterStepRoomAuthOver
Definition: nim_chatroom_def.h:839
static const char * kNIMChatRoomGetMembersKeyType
NIMChatRoomGetMemberType 成员类型
Definition: nim_chatroom_def.h:668
static const char * kEnterKeyNegoKeyNECAKeyPA
string "交换密钥"协议加密算法密钥 part A 自定义时则必填 BigNumHex string 不含0x RSA:module,SM2:X
Definition: nim_chatroom_def.h:892
@ kNIMChatRoomClientTypePCWindows
Definition: nim_chatroom_def.h:523
static const char * kNIMChatRoomMsgKeyExt
string, 第三方扩展字段, 长度限制4096, 必须为可以解析为Json的非格式化的字符串
Definition: nim_chatroom_def.h:431
@ kNIMChatRoomNotificationIdMemberIn
Definition: nim_chatroom_def.h:799
@ kNIMChatRoomNotificationIdMemberExit
Definition: nim_chatroom_def.h:800
static const char * kNIMChatRoomMemberInfoKeyValid
int 记录有效标记位
Definition: nim_chatroom_def.h:608
static const char * kNIMChatRoomMemberInfoKeyGuestFlag
NIMChatRoomGuestFlag 是否是普通游客类型,0:不是游客,1:是游客; 游客身份在聊天室中没有持久化, 只有在线时才会有内存状态
Definition: nim_chatroom_def.h:599
void(* nim_chatroom_enter_cb_func)(int64_t room_id, int enter_step, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:49
static const char * kNIMChatRoomNotificationQueueChangedKeyType
string 变更类型,目前有OFFER,POLL,DROP,BATCH_UPDATE 类型
Definition: nim_chatroom_def.h:775
static const char * kNIMChatRoomMsgKeyAntiSpamContent
string, (可选)开发者自定义的反垃圾字段, 长度限制2048
Definition: nim_chatroom_def.h:435
static const char * kNIMChatRoomMsgKeyFromClientType
int,消息发送方客户端类型(NIMChatRoomClientType),服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:475
static const char * kNIMChatRoomQueueElementValue
string 元素value
Definition: nim_chatroom_def.h:745
static const char * kChatRoomNotificationDataKeyTarget
string json array 被操作者的accid
Definition: nim_chatroom_def.h:719
@ kNIMChatRoomProxySocks4
Definition: nim_chatroom_def.h:846
static const char * kChatRoomNotificationDataKeyMuteFlag
int 当通知为kNIMChatRoomNotificationIdMemberIn才有,代表是否禁言状态,1:是 缺省或0:不是
Definition: nim_chatroom_def.h:723
static const char * kNIMChatRoomMemberInfoKeyEnterTimetag
long 进入聊天室的时间点,对于离线成员该字段为空
Definition: nim_chatroom_def.h:601
static const char * kNIMChatRoomEnterLoginExt
string, 登录自定义字段,用于提交给用户的第三方回调服务进行登录检测,不会同步给其他端
Definition: nim_chatroom_def.h:386
static const char * kNIMChatRoomInfoKeyAnnouncement
string, 聊天室公告
Definition: nim_chatroom_def.h:548
@ kNIMChatRoomLinkConditionDeadAndRetry
Definition: nim_chatroom_def.h:829
void(* nim_chatroom_queue_poll_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:261
NIMChatRoomProxyType
Definition: nim_chatroom_def.h:843
@ kNIMChatRoomClientTypeAndroid
Definition: nim_chatroom_def.h:521
@ kNIMChatRoomNotificationIdInfoUpdated
Definition: nim_chatroom_def.h:810
static const char * kEnterKeyHandShakeType
int 登录时使用的握手协议类型 0:支持配置多种对称与非对称加密算法,1:只支持RAS + RC4,缺省 1
Definition: nim_chatroom_def.h:884
static const char * kNIMChatRoomUpdateMyRoleExtNeedSave
bool 我的资料是否需要持久化保存,默认false
Definition: nim_chatroom_def.h:623
NIMChatRoomEnterStep
Definition: nim_chatroom_def.h:834
static const char * kNIMChatRoomInfoKeyExt
string, 第三方扩展字段, 必须为可以解析为Json的非格式化的字符串, 长度4k
Definition: nim_chatroom_def.h:556
@ kNIMChatRoomNotificationIdRecallMessage
Definition: nim_chatroom_def.h:821
static const char * kNIMChatRoomNotificationQueueChangedKeyKey
string 变更元素的key
Definition: nim_chatroom_def.h:777
static const char * kNIMChatRoomQueueOfferOptionTransient
bool (可选参数)true 表示当提交这个新元素的用户从聊天室掉线或退出的时候,需要删除这个元素;默认 false 表示不删除
Definition: nim_chatroom_def.h:753
@ kNIMChatRoomEnterStepRoomAuthing
Definition: nim_chatroom_def.h:838
static const char * kNIMChatRoomGetMsgHistoryKeyLimit
int 本次返回的消息数量
Definition: nim_chatroom_def.h:683
static const char * kNIMChatRoomMsgKeyHighPriorityFlag
int, 高优先级消息标记,1:是; 非高优先级消息不带该字段,服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:483
float z_
位置信息 z 坐标
Definition: nim_chatroom_def.h:22
static const char * kNIMChatRoomMsgKeyLocalFilePath
string, 暂时不用,多媒体消息资源本地绝对路径,SDK本地维护,发送多媒体消息时必填
Definition: nim_chatroom_def.h:487
static const char * kNIMChatRoomInfoKeyMuteAll
int, 聊天室禁言标志 1:禁言,0:解除禁言
Definition: nim_chatroom_def.h:560
void(* nim_chatroom_query_members_count_by_tag_cb_func)(int64_t room_id, int error_code, uint64_t count, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:198
static const char * kNIMRobotInfoKeyCreateTime
long 创建时间戳 毫秒
Definition: nim_chatroom_def.h:867
static const char * kNIMChatRoomMsgKeyType
int, 消息类型(NIMChatRoomMsgType)
Definition: nim_chatroom_def.h:423
float distance_
距离信息,仅在更新位置信息时会用到,发送消息、加入房间不需要填写
Definition: nim_chatroom_def.h:24
static const char * kNIMChatRoomMsgKeyAntiSpamRes
String, 易盾反垃圾返回的结果字段
Definition: nim_chatroom_def.h:457
static const char * kNIMChatRoomGetMsgHistoryKeyMsgtypes
array:数组 要查询的消息类型,取值NIMChatRoomMsgType中所枚举类型
Definition: nim_chatroom_def.h:687
@ kNIMChatRoomGetMemberTypeSolid
固定成员,固定成员,包括创建者,管理员,普通等级用户,受限用户(禁言+黑名单)即使非在线也可以在列表中看到,有数量限制,查询时时间戳使用"updatetime"
Definition: nim_chatroom_def.h:647
static const char * kChatRoomNotificationDataKeyMsgId
string 当通知为 kChatRoomNotificationIdRecallMessage,代表被撤回消息的消息 ID
Definition: nim_chatroom_def.h:735
NIMChatRoomGetMemberType
Definition: nim_chatroom_def.h:645
static const char * kNIMChatRoomEnterKeyAppDataPath
Definition: nim_chatroom_def.h:405
static const char * kNIMChatRoomGetMsgHistoryKeyStartTime
long 开始时间,单位毫秒
Definition: nim_chatroom_def.h:681
static const char * kChatRoomNotificationDataKeyTempMutedFlag
int 当通知为kNIMChatRoomNotificationIdMemberIn才有,代表是否临时禁言状态,1:是 缺省或0:不是
Definition: nim_chatroom_def.h:725
static const char * kNIMChatRoomMsgKeyResendFlag
int,消息重发标记位,第一次发送0,重发1
Definition: nim_chatroom_def.h:429
static const char * kChatRoomNotificationKeyData
string 通知内容
Definition: nim_chatroom_def.h:707
@ kNIMChatRoomNotificationIdAddFixed
Definition: nim_chatroom_def.h:807
static const char * kNIMChatRoomMsgKeyAntiSpamBizId
string, (可选)用户配置的对某些单条消息另外的反垃圾的业务ID
Definition: nim_chatroom_def.h:437
static const char * kEnterKeyNegoKeyNECAKeyPB
string "交换密钥"协议加密算法密钥 part B 自定义时则必填 BigNumHex string 不含0x RSA:EXP,SM2:Y
Definition: nim_chatroom_def.h:894
static const char * kNIMChatRoomMemberInfoKeyTempMute
int 临时禁言
Definition: nim_chatroom_def.h:612
@ kNIMChatRoomMsgTypeText
Definition: nim_chatroom_def.h:505
@ kNIMChatRoomMsgTypeFile
Definition: nim_chatroom_def.h:511
@ kNIMChatRoomMsgTypeNotification
Definition: nim_chatroom_def.h:510
static const char * kNIMChatRoomMsgKeyToAccids
(可选)string, json array,消息接受者,如果设置了本字段,且不为空,则本消息为聊天室定向消息(聊天室定向消息不会存历史)
Definition: nim_chatroom_def.h:465
static const char * kNIMChatRoomMsgKeyFromAccount
string, 消息发送者的账号,服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:471
@ kNIMChatRoomClientTypeMacOS
Definition: nim_chatroom_def.h:527
static const char * kChatRoomNotificationDataKeyMsgTimetag
int64_t 当通知为 kChatRoomNotificationIdRecallMessage,代表被撤回消息的消息时间戳
Definition: nim_chatroom_def.h:733
static const char * kNIMChatRoomMsgKeyTime
long, 消息发送的时间戳(毫秒),服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:473
static const char * kNIMChatRoomSetMemberAttributeKeyNotifyExt
string 自定义的事件通知扩展字段, 必须为可以解析为Json的非格式化的字符串
Definition: nim_chatroom_def.h:700
static const char * kNIMChatRoomNotificationQueueChangedType_OFFER
放元素到新队列
Definition: nim_chatroom_def.h:762
void(* nim_chatroom_queue_list_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:274
@ kNIMChatRoomNotificationIdRemoveManager
Definition: nim_chatroom_def.h:806
NIMChatRoomNotificationId
Definition: nim_chatroom_def.h:798
@ kNIMSDKLogLevelPro
Definition: nim_chatroom_def.h:500
NIMChatRoomMsgType
Definition: nim_chatroom_def.h:504
void(* nim_chatroom_receive_notification_cb_func)(int64_t room_id, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:107
@ kNIMChatRoomProxySocks5
Definition: nim_chatroom_def.h:848
@ kNIMChatRoomNotificationIdTagTempMuteAdd
Definition: nim_chatroom_def.h:819
static const char * kNIMChatRoomMsgKeyLocationZ
(可选)int, 位置信息 Z 轴坐标
Definition: nim_chatroom_def.h:463
static const char * kNIMChatRoomSetMemberAttributeKeyAccoutID
string 成员ID
Definition: nim_chatroom_def.h:694
static const char * kNIMChatRoomEnterAntiSpamBusinessID
string, 反垃圾相关业务id
Definition: nim_chatroom_def.h:388
static const char * kNIMRobotInfoKeyAccid
string 帐号
Definition: nim_chatroom_def.h:857
static const char * kNIMChatRoomEnterKeyAppKey
string, 应用appkey,匿名登录时必填
Definition: nim_chatroom_def.h:401
static const char * kNIMChatRoomSetMemberAttributeKeyAttribute
NIMChatRoomMemberAttribute.
Definition: nim_chatroom_def.h:696
@ kNIMChatRoomNotificationIdAddManager
Definition: nim_chatroom_def.h:805
@ kNIMChatRoomNotificationIdMemberKicked
Definition: nim_chatroom_def.h:811
static const char * kNIMChatRoomQueueOfferOptionElementAccId
string (可选参数)队列元素所属账号,默认不传表示队列元素属于当前操作人,管理员可以指定队列元素归属于其他合法账号
Definition: nim_chatroom_def.h:755
void(* nim_chatroom_kick_member_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:170
static const char * kNIMRobotInfoKeyIntro
string 介绍
Definition: nim_chatroom_def.h:863
@ kNIMChatRoomNotificationIdQueueBatchChanged
Definition: nim_chatroom_def.h:818
@ kNIMChatRoomOnlineStateOffline
Definition: nim_chatroom_def.h:634
static const char * kNIMChatRoomEnterKeyLogLevel
int,匿名登录时选填,定义见NIMSDKLogLevel(选填,SDK默认的内置级别为kNIMSDKLogLevelPro)
Definition: nim_chatroom_def.h:407
static const char * kNIMChatRoomNotificationQueueChangedKeyValue
string 变更元素的内容
Definition: nim_chatroom_def.h:779
@ kNIMChatRoomProxySocks4a
Definition: nim_chatroom_def.h:847
void(* nim_chatroom_temp_mute_member_by_tag_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:214
NIMSDKLogLevel
Definition: nim_chatroom_def.h:495
void(* nim_chatroom_get_info_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:160
static const char * kNIMChatRoomMsgKeyAntiSpamUsingYiDun
int, (可选) 单条消息是否使用易盾反垃圾 0:(在开通易盾的情况下)不过易盾反垃圾而是通用反垃圾 其他都是按照原来的规则
Definition: nim_chatroom_def.h:441
static const char * kNIMChatRoomEnterKeyNotifyExt
string, 进入聊天室通知开发者扩展字段,必须为可以解析为Json的非格式化的字符串,选填,聊天室成员收到聊天室进入通知中可以获取该数据
Definition: nim_chatroom_def.h:378
@ kNIMChatRoomNotificationIdAddMute
Definition: nim_chatroom_def.h:803
static const char * kNIMChatRoomMsgKeyLocalResId
string, 暂时不用,多媒体资源id,发送方选填,接收方收到的是客户端消息id
Definition: nim_chatroom_def.h:489
static const char * kNIMChatRoomMemberInfoKeyTempMuteRestDuration
long 临时禁言的解除时长,单位秒
Definition: nim_chatroom_def.h:614
static const char * kNIMChatRoomMemberInfoKeyTag
string 聊天室成员所属的 tag 信息
Definition: nim_chatroom_def.h:593
static const char * kNIMChatRoomEnterKeyExt
string, 聊天室可用的扩展字段,必须为可以解析为Json的非格式化的字符串,选填,设置后通过获取聊天室成员信息接口可以获取该数据
Definition: nim_chatroom_def.h:376
@ kNIMChatRoomLinkConditionDead
Definition: nim_chatroom_def.h:830
void(* nim_chatroom_queue_drop_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:297
static const char * kChatRoomNotificationDataKeyTargetTag
string 当通知为 kChatRoomNotificationIdTagTempMuteAdd 或 kChatRoomNotificationIdTagTempMuteRemove,代表被禁言的目标...
Definition: nim_chatroom_def.h:731
static const char * kChatRoomNotificationDataKeyExt
string 上层开发自定义的事件通知扩展字段, 必须为可以解析为Json的非格式化的字符串
Definition: nim_chatroom_def.h:711
@ kNIMChatRoomLinkConditionAlive
Definition: nim_chatroom_def.h:828
NIMChatRoomGuestFlag
Definition: nim_chatroom_def.h:639
void(* nim_chatroom_batch_update_cb)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:328
NIMChatRoomClientType
Definition: nim_chatroom_def.h:519
@ kNIMSDKLogLevelError
Definition: nim_chatroom_def.h:497
void(* nim_chatroom_update_my_role_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:238
static const char * kNIMChatRoomGetMembersKeyOffset
long 时间戳,填0会使用当前服务器最新时间开始查询,即第一页
Definition: nim_chatroom_def.h:672
@ kNIMChatRoomClientTypeDefault
Definition: nim_chatroom_def.h:520
static const char * kNIMChatRoomEnterKeyAvatar
string, (匿名登录时必填)设置后通过获取聊天室成员信息接口可以获取该数据
Definition: nim_chatroom_def.h:374
static const char * kNIMChatRoomMemberInfoKeyNick
string 聊天室内的昵称字段,预留字段, 可从Uinfo中取
Definition: nim_chatroom_def.h:587
@ kNIMSDKLogLevelApp
Definition: nim_chatroom_def.h:499
static const char * kNIMChatRoomMsgKeyNotifyTags
(可选)String 消息的目标标签表达式,参见TagPattern和TagCalculator v8.4.0 新增
Definition: nim_chatroom_def.h:453
static const char * kNIMChatRoomMsgKeyThirdPartyCBEXT
(可选)string第三方回调回来的自定义扩展字段 v7.8 新增
Definition: nim_chatroom_def.h:445
@ kNIMChatRoomNotificationIdRemoveBlack
Definition: nim_chatroom_def.h:802
@ kNIMChatRoomNotificationIdRemoveFixed
Definition: nim_chatroom_def.h:808
static const char * kNIMChatRoomMsgKeyAntiSpamEnable
int, 是否需要过易盾反垃圾, 0:不需要,1:需要, 默认0
Definition: nim_chatroom_def.h:433
Definition: nim_chatroom_def.h:16
static const char * kNIMChatRoomMsgKeyLocationX
(可选)int, 位置信息 X 轴坐标
Definition: nim_chatroom_def.h:459
@ kNIMChatRoomMsgTypeCustom
Definition: nim_chatroom_def.h:514
static const char * kNIMChatRoomInfoKeyCreatorID
string, 聊天室创建者账号
Definition: nim_chatroom_def.h:552
void(* nim_chatroom_get_msg_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:132
NIM SDK 及 NIM ChatRoom SDK 公用头文件
static const char * kChatRoomNotificationDataKeyMemberInTempMutedDuration
long 当通知为kNIMChatRoomNotificationIdMemberIn,代表临时禁言时长(秒), 其他通知事件不带该数据
Definition: nim_chatroom_def.h:727
static const char * kNIMChatRoomNotificationQueueChangedType_PARTCLEAR
部分清理操作(发生在提交元素的用户掉线时,清理这个用户对应的key
Definition: nim_chatroom_def.h:768
@ kNIMChatRoomMsgTypeUnknown
Definition: nim_chatroom_def.h:515
static const char * kEnterKeyPrivateConfigRoot
json obj 私有配置root key
Definition: nim_chatroom_def.h:890
NIMChatRoomLinkCondition
Definition: nim_chatroom_def.h:827
@ kNIMChatRoomExitReasonRoomInvalid
Definition: nim_chatroom_def.h:568
@ kNIMChatRoomExitReasonKickByManager
Definition: nim_chatroom_def.h:569
static const char * kNIMChatRoomInfoKeyOnlineCount
int, 当前在线用户数量
Definition: nim_chatroom_def.h:558
@ kNIMChatRoomMsgTypeLocation
Definition: nim_chatroom_def.h:509
@ kNIMChatRoomClientTypeWeb
Definition: nim_chatroom_def.h:525
static const char * kNIMChatRoomMsgKeyBody
string,(可选)文本消息内容(聊天室机器人文本消息)
Definition: nim_chatroom_def.h:443
@ kNIMChatRoomNotificationIdQueueChanged
Definition: nim_chatroom_def.h:815
static const char * kNIMChatRoomMemberInfoKeyAccID
string 成员账号
Definition: nim_chatroom_def.h:581
static const char * kNIMRobotInfoKeyIcon
string 头像
Definition: nim_chatroom_def.h:861
@ kNIMChatRoomNotificationIdRoomMuted
Definition: nim_chatroom_def.h:816
@ kNIMChatRoomExitReasonKickByMultiSpot
Definition: nim_chatroom_def.h:570
@ kNIMChatRoomGetMemberTypeTempOL
非固定成员(反向查询) 查询时时间戳使用"进入聊天室时间"
Definition: nim_chatroom_def.h:653
static const char * kNIMChatRoomNotificationQueueBatchChangedKeyKey
string 变更元素的key
Definition: nim_chatroom_def.h:789
void(* nim_chatroom_update_room_info_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:228
static const char * kNIMChatRoomEnterKeyAccID
string,登录聊天室的账号非匿名模式下使用
Definition: nim_chatroom_def.h:413
void(* nim_chatroom_queue_offer_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:248
void(* nim_chatroom_receive_msg_cb_func)(int64_t room_id, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:97
static const char * kEnterKeyCommNECA
int 通信加密算法 {1(RC4),2(AES128),4(SM4)} def:1(RC4) 对称加密
Definition: nim_chatroom_def.h:882
@ kNIMChatRoomExitReasonBeBlacklisted
Definition: nim_chatroom_def.h:572
static const char * kEnterKeyNegoKeyNECA
int "交换密钥"协议加密算法 {1(RSA),2(SM2)}, def:1(RSA) 非对称加密
Definition: nim_chatroom_def.h:880
static const char * kNIMChatRoomNotificationQueueBatchChangedKeyValue
string 变更元素的内容
Definition: nim_chatroom_def.h:791
@ kNIMChatRoomLoginStateUnLogin
Definition: nim_chatroom_def.h:629
@ kNIMChatRoomNotificationIdRoomDeMuted
Definition: nim_chatroom_def.h:817
static const char * kNIMChatRoomMemberInfoKeyExt
string 开发者扩展字段, 长度限制2k, 必须为可以解析为Json的非格式化的字符串
Definition: nim_chatroom_def.h:591
@ kNIMChatRoomEnterStepInit
Definition: nim_chatroom_def.h:835
static const char * kNIMChatRoomInfoKeyBroadcastUrl
string, 视频直播拉流地址
Definition: nim_chatroom_def.h:550
@ kNIMChatRoomNotificationIdMyRoleUpdated
Definition: nim_chatroom_def.h:814
@ kNIMChatRoomClientTypeiOS
Definition: nim_chatroom_def.h:522
@ kNIMSDKLogLevelFatal
Definition: nim_chatroom_def.h:496
static const char * kNIMChatRoomMsgKeyFromNick
string, 消息发送方昵称,服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:477
@ kNIMChatRoomEnterStepServerConnectOver
Definition: nim_chatroom_def.h:837
static const char * kNIMChatRoomSetMemberAttributeKeyOpt
boolean: true:是,false:否
Definition: nim_chatroom_def.h:698
static const char * kChatRoomNotificationKeyID
string 通知类型ID
Definition: nim_chatroom_def.h:709
float y_
位置信息 y 坐标
Definition: nim_chatroom_def.h:20
static const char * kNIMChatRoomEnterKeyAddress
string array,聊天室地址,地址通过应用服务器接口获取
Definition: nim_chatroom_def.h:409
void(* nim_chatroom_queue_init_cb_func)(int64_t room_id, int error_code, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:307
void(* nim_chatroom_query_robots_cb_func)(int rescode, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:317
static const char * kNIMChatRoomGetMembersKeyTag
获取成员时指定的 tag
Definition: nim_chatroom_def.h:670
@ kNIMChatRoomExitReasonIllegalState
Definition: nim_chatroom_def.h:571
static const char * kNIMChatRoomInfoKeyID
long, 聊天室ID
Definition: nim_chatroom_def.h:544
void(* nim_chatroom_queue_header_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:287
static const char * kEnterKeyDedicatedClusteFlag
int 是否为专属集群 1:是 0: 否
Definition: nim_chatroom_def.h:878
static const char * kNIMChatRoomMemberInfoKeyLevel
int 成员级别: >=0表示用户开发者可以自定义的级别
Definition: nim_chatroom_def.h:585
@ kNIMChatRoomMsgTypeTips
Definition: nim_chatroom_def.h:513
static const char * kNIMChatRoomMemberInfoKeyBlacklist
int 是黑名单
Definition: nim_chatroom_def.h:604
static const char * kNIMChatRoomInfoKeyName
string, 聊天室名称
Definition: nim_chatroom_def.h:546
@ kNIMChatRoomMemberAttributeAdminister
Definition: nim_chatroom_def.h:658
static const char * kNIMChatRoomMsgKeyLocationY
(可选)int, 位置信息 Y 轴坐标
Definition: nim_chatroom_def.h:461
static const char * kNIMChatRoomEnterNotifyTags
string 登录登出通知的目标标签
Definition: nim_chatroom_def.h:382
static const char * kNIMChatRoomInfoKeyQueuelevel
int, 队列管理权限:0:所有人都有权限变更队列,1:只有主播管理员才能操作变更
Definition: nim_chatroom_def.h:562
static const char * kNIMChatRoomMsgKeyEnvConfig
(可选)String, 自定义抄送配置 v8.0.0 新增
Definition: nim_chatroom_def.h:451
static const char * kNIMChatRoomMsgKeyAttach
string, 消息内容,长度限制2048, 如果约定的是json字符串,必须为可以解析为json的非格式化的字符串
Definition: nim_chatroom_def.h:425
static const char * kNIMChatRoomMsgKeyYiDunAntiCheating
(可选)String, 易盾反垃圾增强反作弊专属字段, 限制json,长度限制1024
Definition: nim_chatroom_def.h:449
@ kNIMChatRoomMsgTypeAudio
Definition: nim_chatroom_def.h:507
static const char * kNIMRobotInfoKeyUpdateTime
long 更新时间戳 毫秒
Definition: nim_chatroom_def.h:869
void(* nim_chatroom_temp_mute_member_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:183
void(* nim_chatroom_set_member_attribute_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:144
static const char * kNIMChatRoomMsgKeyFromExt
string, 消息发送方身份扩展字段,服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:481
@ kNIMChatRoomClientTypeWindowsPhone
Definition: nim_chatroom_def.h:524
NIMChatRoomOnlineState
Definition: nim_chatroom_def.h:633
static const char * kNIMChatRoomEnterLoginTags
string array 登录标签,可以设置多个,json array 格式,例子:["tag1", "tag2"]
Definition: nim_chatroom_def.h:380
@ kNIMChatRoomClientTypeRestAPI
Definition: nim_chatroom_def.h:526
static const char * kChatRoomNotificationDataKeyOptNick
string 操作者的账号nick
Definition: nim_chatroom_def.h:715
static const char * kNIMChatRoomMemberInfoKeyOnlineState
NIMChatRoomOnlineState 成员是否处于在线状态, 仅特殊成员才可能离线, 对游客/匿名用户而言只能是在线
Definition: nim_chatroom_def.h:597
@ kNIMChatRoomMemberAttributeBlackList
Definition: nim_chatroom_def.h:660
static const char * kNIMChatRoomEnterKeyRandomID
int,是否开启随机ID模式,默认为关闭(0),建议默认值
Definition: nim_chatroom_def.h:411
@ kNIMChatRoomOnlineStateOnline
Definition: nim_chatroom_def.h:635
static const char * kNIMChatRoomEnterEnableLocation
int 登录时使用的位置信息
Definition: nim_chatroom_def.h:390
@ kNIMChatRoomNotificationIdQueueBatchOffer
聊天室麦序队列中有批量增加通知消息 "ext" :{"_e":"BATCH_OFFER","elements":[{"nick":"ddd","accid":"ljmt",...
Definition: nim_chatroom_def.h:823
@ kNIMChatRoomGetMemberTypeSolidOL
在线固定成员 查询时时间戳使用"updatetime"
Definition: nim_chatroom_def.h:651
@ kNIMChatRoomMemberAttributeNomalMember
Definition: nim_chatroom_def.h:659
@ kNIMChatRoomMemberAttributeMuteList
Definition: nim_chatroom_def.h:661
static const char * kNIMChatRoomNotificationQueueBatchChangedKeyObject
map 变更元素的内容
Definition: nim_chatroom_def.h:793
static const char * kNIMChatRoomEnterCallbackKeyRoomInfo
json value, 见聊天室Info Json Keys
Definition: nim_chatroom_def.h:534
void(* nim_chatroom_link_condition_cb_func)(int64_t room_id, int condition, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:75
static const char * kNIMChatRoomMsgKeyRoomID
long, 消息所属的聊天室id,服务器填写,发送方不需要填写
Definition: nim_chatroom_def.h:469
static const char * kNIMChatRoomMsgKeyAntiSpamExt
(可选)String, 易盾反垃圾扩展字段,限制json,长度限制1024
Definition: nim_chatroom_def.h:455
@ kNIMChatRoomGuestFlagNoGuest
Definition: nim_chatroom_def.h:640
static const char * kNIMChatRoomEnterKeyToken
string,登录聊天室的密码非匿名模式下使用
Definition: nim_chatroom_def.h:415
static const char * kNIMChatRoomGetMsgHistoryKeyReverse
boolean: true:按时间正序起查,正序排列,false:按时间逆序起查,逆序排列
Definition: nim_chatroom_def.h:685
static const char * kNIMChatRoomInfoKeyValidFlag
int, 聊天室有效标记, 1:有效,0:无效
Definition: nim_chatroom_def.h:554
@ kNIMChatRoomNotificationIdClosed
Definition: nim_chatroom_def.h:809
void(* nim_chatroom_sendmsg_arc_cb_func)(int64_t room_id, int error_code, const char *result, const char *json_extension, const void *user_data)
Definition: nim_chatroom_def.h:87
static const char * kChatRoomNotificationDataKeyTargetNick
string json array 被操作者的nick列表
Definition: nim_chatroom_def.h:717
static const char * kChatRoomNotificationDataKeyQueueChange
string 当通知为kNIMChatRoomNotificationIdQueueChange,代表队列变更具体内容,内容解析 参考麦序队列变更通知扩展字段queueChange
Definition: nim_chatroom_def.h:729
@ kNIMChatRoomProxyNone
Definition: nim_chatroom_def.h:844
@ kNIMChatRoomMsgTypeImage
Definition: nim_chatroom_def.h:506
@ kNIMChatRoomEnterStepServerConnecting
Definition: nim_chatroom_def.h:836
@ kNIMChatRoomLoginStateLogin
Definition: nim_chatroom_def.h:628
static const int iNIMMaxBatchQueue
int 聊天室更新的批量最大数
Definition: nim_chatroom_def.h:491
@ kNIMChatRoomNotificationIdMemberTempMute
Definition: nim_chatroom_def.h:812
@ kNIMChatRoomNotificationIdAddBlack
Definition: nim_chatroom_def.h:801