nim_chatroom_def.h

Go to the documentation of this file.

 
#ifndef NIM_CHATROOM_NIM_CHATROOM_DEFINES_NIM_CHATROOM_DEF_H_
#define NIM_CHATROOM_NIM_CHATROOM_DEFINES_NIM_CHATROOM_DEF_H_
 
#include "public_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _tagNIMChatRoomLocation {
    float x_;
    float y_;
    float z_;
    float distance_;
} NIMChatRoomLocation;
 
typedef struct _tagNIMChatRoomUpdateTagsInfo {
    char* tags_;
    char* notify_target_tags_;
    int need_notify_;
    char* ext_;
} NIMChatRoomUpdateTagsInfo;
 
typedef 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);
 
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);
 
typedef void (*nim_chatroom_link_condition_cb_func)(int64_t room_id, int condition, const char* json_extension, const void* user_data);
 
typedef 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);
 
typedef void (*nim_chatroom_receive_msg_cb_func)(int64_t room_id, const char* result, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_receive_notification_cb_func)(int64_t room_id, const char* result, const char* json_extension, const void* user_data);
 
typedef 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);
 
typedef 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);
 
typedef 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);
 
typedef 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);
 
typedef void (*nim_chatroom_kick_member_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef 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);
 
typedef 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);
 
typedef 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);
 
typedef void (*nim_chatroom_update_room_info_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_update_my_role_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_queue_offer_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef 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);
 
typedef 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);
 
typedef 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);
 
typedef void (*nim_chatroom_queue_drop_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_queue_init_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_query_robots_cb_func)(int rescode, const char* result, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_batch_update_cb)(int64_t room_id, int error_code, const char* result, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_update_location_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_custom_token_cb_func)(char* auth_token, const uint32_t length, const char* json_params, const void* user_data);
 
typedef void (*nim_chatroom_tags_changed_cb_func)(int64_t room_id, const char* new_tags, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_update_tags_cb_func)(int64_t room_id, int error_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_chatroom_sdk_log_cb_func)(const char* log_content, const void* user_data);
 
static const char* kNIMChatRoomEnterKeyNick = "nick";
static const char* kNIMChatRoomEnterKeyAvatar = "avatar";
static const char* kNIMChatRoomEnterKeyExt = "ext";
static const char* kNIMChatRoomEnterKeyNotifyExt = "notify_ext";
static const char* kNIMChatRoomEnterLoginTags = "login_tags";
static const char* kNIMChatRoomEnterNotifyTags = "notify_tags";
static const char* kNIMChatRoomEnterAuthType = "auth_type";
static const char* kNIMChatRoomEnterLoginExt = "login_ext";
static const char* kNIMChatRoomEnterAntiSpamBusinessID = "anti_spam_business_id";
static const char* kNIMChatRoomEnterEnableLocation = "enable_location";
static const char* kNIMChatRoomEnterLocationX = "location_x";
static const char* kNIMChatRoomEnterLocationY = "location_y";
static const char* kNIMChatRoomEnterLocationZ = "location_z";
static const char* kNIMChatRoomEnterLocationDistance = "location_distance";  // 进入聊天室的可选填信息Json Keys
 
static const char* kNIMChatRoomEnterKeyAppKey = "app_key";
static const char* kNIMChatRoomEnterKeyAppDataPath = "app_data_path";
static const char* kNIMChatRoomEnterKeyLogLevel = "log_level";
static const char* kNIMChatRoomEnterKeyAddress = "address";
static const char* kNIMChatRoomEnterKeyRandomID = "random_id";
static const char* kNIMChatRoomEnterKeyAccID = "accid";
static const char* kNIMChatRoomEnterKeyToken = "token";  // 独立聊天室进入的信息Json Keys
 
// 协议定义
static const char* kNIMChatRoomMsgKeyType = "msg_type";
static const char* kNIMChatRoomMsgKeyAttach = "msg_attach";
static const char* kNIMChatRoomMsgKeyClientMsgid = "client_msg_id";
static const char* kNIMChatRoomMsgKeyResendFlag = "resend_flag";
static const char* kNIMChatRoomMsgKeyExt = "ext";
static const char* kNIMChatRoomMsgKeyAntiSpamEnable = "anti_spam_enable";
static const char* kNIMChatRoomMsgKeyAntiSpamContent = "anti_spam_content";
static const char* kNIMChatRoomMsgKeyAntiSpamBizId = "anti_spam_business_id";
static const char* kNIMChatRoomMsgKeyHistorySave = "history_save";
static const char* kNIMChatRoomMsgKeyAntiSpamUsingYiDun = "anti_spam_using_yidun";
static const char* kNIMChatRoomMsgKeyBody = "body";
static const char* kNIMChatRoomMsgKeyThirdPartyCBEXT = "third_party_callback_ext";
static const char* kNIMChatRoomMsgKeySubType = "msg_sub_type";
static const char* kNIMChatRoomMsgKeyYiDunAntiCheating = "yidun_anti_cheating";
static const char* kNIMChatRoomMsgKeyEnvConfig = "env_config";
static const char* kNIMChatRoomMsgKeyNotifyTags = "notify_tags";
static const char* kNIMChatRoomMsgKeyAntiSpamExt = "anti_spam_ext";
static const char* kNIMChatRoomMsgKeyAntiSpamRes = "anti_spam_res";
static const char* kNIMChatRoomMsgKeyLocationX = "location_x";
static const char* kNIMChatRoomMsgKeyLocationY = "location_y";
static const char* kNIMChatRoomMsgKeyLocationZ = "location_z";
static const char* kNIMChatRoomMsgKeyToAccids = "to_accids";
static const char* kNIMChatRoomMsgNeedHighPriorityAck = "need_high_priority_ack";
 
// 以下定义对于客户端只读
static const char* kNIMChatRoomMsgKeyRoomID = "room_id";
static const char* kNIMChatRoomMsgKeyFromAccount = "from_id";
static const char* kNIMChatRoomMsgKeyTime = "time";
static const char* kNIMChatRoomMsgKeyFromClientType = "from_client_type";
static const char* kNIMChatRoomMsgKeyFromNick = "from_nick";
static const char* kNIMChatRoomMsgKeyFromAvatar = "from_avator";
static const char* kNIMChatRoomMsgKeyFromExt = "from_ext";
static const char* kNIMChatRoomMsgKeyHighPriorityFlag = "high_priority_flag";
 
// 本地定义
static const char* kNIMChatRoomMsgKeyLocalFilePath = "local_res_path";
static const char* kNIMChatRoomMsgKeyLocalResId = "res_id";
static const int iNIMMaxBatchQueue = 100;  // 消息结构 Json Keys
 
enum NIMSDKLogLevel {
    kNIMSDKLogLevelFatal = 1, 
    kNIMSDKLogLevelError = 2, 
    kNIMSDKLogLevelWarn = 3,  
    kNIMSDKLogLevelApp = 5,   
    kNIMSDKLogLevelPro = 6,   
};
 
enum NIMChatRoomMsgType {
    kNIMChatRoomMsgTypeText = 0,         
    kNIMChatRoomMsgTypeImage = 1,        
    kNIMChatRoomMsgTypeAudio = 2,        
    kNIMChatRoomMsgTypeVideo = 3,        
    kNIMChatRoomMsgTypeLocation = 4,     
    kNIMChatRoomMsgTypeNotification = 5, 
    kNIMChatRoomMsgTypeFile = 6,         
    kNIMChatRoomMsgTypeRobot = 11,       
    kNIMChatRoomMsgTypeTips = 10,        
    kNIMChatRoomMsgTypeCustom = 100,     
    kNIMChatRoomMsgTypeUnknown = 1000,   
};
 
enum NIMChatRoomClientType {
    kNIMChatRoomClientTypeDefault = 0,      
    kNIMChatRoomClientTypeAndroid = 1,      
    kNIMChatRoomClientTypeiOS = 2,          
    kNIMChatRoomClientTypePCWindows = 4,    
    kNIMChatRoomClientTypeWindowsPhone = 8, 
    kNIMChatRoomClientTypeWeb = 16,         
    kNIMChatRoomClientTypeRestAPI = 32,     
    kNIMChatRoomClientTypeMacOS = 64,       
};
 
static const char* kNIMChatRoomEnterCallbackKeyRoomInfo = "room_info";
static const char* kNIMChatRoomEnterCallbackKeyMyInfo = "my_info";
  // 进入回调结果Json Keys
 
static const char* kNIMChatRoomInfoKeyID = "id";
static const char* kNIMChatRoomInfoKeyName = "name";
static const char* kNIMChatRoomInfoKeyAnnouncement = "announcement";
static const char* kNIMChatRoomInfoKeyBroadcastUrl = "broadcast_url";
static const char* kNIMChatRoomInfoKeyCreatorID = "creator_id";
static const char* kNIMChatRoomInfoKeyValidFlag = "valid_flag";
static const char* kNIMChatRoomInfoKeyExt = "ext";
static const char* kNIMChatRoomInfoKeyOnlineCount = "online_count";
static const char* kNIMChatRoomInfoKeyMuteAll = "mute_all";
static const char* kNIMChatRoomInfoKeyQueuelevel = "queuelevel";  // 聊天室Info Json Keys
 
enum NIMChatRoomExitReason {
    kNIMChatRoomExitReasonExit = 0,            
    kNIMChatRoomExitReasonRoomInvalid = 1,     
    kNIMChatRoomExitReasonKickByManager = 2,   
    kNIMChatRoomExitReasonKickByMultiSpot = 3, 
    kNIMChatRoomExitReasonIllegalState = 4,    
    kNIMChatRoomExitReasonBeBlacklisted = 5,   
};
 
static const char* kNIMChatRoomMemberInfoKeyRoomID = "room_id";
static const char* kNIMChatRoomMemberInfoKeyAccID = "account_id";
static const char* kNIMChatRoomMemberInfoKeyType = "type";
static const char* kNIMChatRoomMemberInfoKeyLevel = "level";
static const char* kNIMChatRoomMemberInfoKeyNick = "nick";
static const char* kNIMChatRoomMemberInfoKeyAvatar = "avatar";
static const char* kNIMChatRoomMemberInfoKeyExt = "ext";
static const char* kNIMChatRoomMemberInfoKeyTag = "tags";
static const char* kNIMChatRoomMemberInfoKeyNotifyTags = "notify_tags";
static const char* kNIMChatRoomMemberInfoKeyOnlineState = "online_state";
static const char* kNIMChatRoomMemberInfoKeyGuestFlag = "guest_flag";
static const char* kNIMChatRoomMemberInfoKeyEnterTimetag = "enter_timetag";
// 以下字段仅在返回前端时使用
static const char* kNIMChatRoomMemberInfoKeyBlacklist = "is_blacklist";
static const char* kNIMChatRoomMemberInfoKeyMuted = "is_muted";
static const char* kNIMChatRoomMemberInfoKeyValid = "valid";
static const char* kNIMChatRoomMemberInfoKeyUpdateTimetag = "update_timetag";
static const char* kNIMChatRoomMemberInfoKeyTempMute = "temp_mute";
static const char* kNIMChatRoomMemberInfoKeyTempMuteRestDuration = "temp_mute_rest_duration";
static const char* kNIMChatRoomAntiSpamBusinessID = "anti_spam_business_id";  // 聊天室个人Info Json Keys
 
static const char* kNIMChatRoomUpdateMyRoleExtNeedSave = "need_save";  // 更新我的信息扩展字段 Json Keys
 
enum NIMChatRoomLoginState {
    kNIMChatRoomLoginStateLogin = 1,   
    kNIMChatRoomLoginStateUnLogin = 2, 
};
 
enum NIMChatRoomOnlineState {
    kNIMChatRoomOnlineStateOffline = 0, 
    kNIMChatRoomOnlineStateOnline = 1,  
};
 
enum NIMChatRoomGuestFlag {
    kNIMChatRoomGuestFlagNoGuest = 0, 
    kNIMChatRoomGuestFlagGuest = 1,   
};
 
enum NIMChatRoomGetMemberType {
    kNIMChatRoomGetMemberTypeSolid = 0,
    kNIMChatRoomGetMemberTypeTemp = 1,
    kNIMChatRoomGetMemberTypeSolidOL = 2,
    kNIMChatRoomGetMemberTypeTempOL = 3,
};
 
enum NIMChatRoomMemberAttribute {
    kNIMChatRoomMemberAttributeAdminister = 1,  
    kNIMChatRoomMemberAttributeNomalMember = 2, 
    kNIMChatRoomMemberAttributeBlackList = -1,  
    kNIMChatRoomMemberAttributeMuteList = -2,   
};
 
static const char* kNIMChatRoomGetMembersKeyType = "type";
static const char* kNIMChatRoomGetMembersKeyTag = "tag";
static const char* kNIMChatRoomGetMembersKeyOffset = "offset";
static const char* kNIMChatRoomGetMembersKeyLimit = "limit";  // 分页获取成员列表条件Keys
 
static const char* kNIMChatRoomGetMsgHistoryKeyTags = "tags";
static const char* kNIMChatRoomGetMsgHistoryKeyStartTime = "start";
static const char* kNIMChatRoomGetMsgHistoryKeyEndTime = "end";
static const char* kNIMChatRoomGetMsgHistoryKeyLimit = "limit";
static const char* kNIMChatRoomGetMsgHistoryKeyReverse = "reverse";
static const char* kNIMChatRoomGetMsgHistoryKeyMsgtypes = "msgtypes";  // 分获取历史消息条件Keys
 
static const char* kNIMChatRoomSetMemberAttributeKeyAccoutID = "account_id";
static const char* kNIMChatRoomSetMemberAttributeKeyAttribute = "attribute";
static const char* kNIMChatRoomSetMemberAttributeKeyOpt = "opt";
static const char* kNIMChatRoomSetMemberAttributeKeyNotifyExt = "notify_ext";  // 设定聊天室成员标记身份条件Keys
 
static const char* kChatRoomNotificationKeyData = "data";
static const char* kChatRoomNotificationKeyID = "id";
static const char* kChatRoomNotificationDataKeyExt = "ext";
static const char* kChatRoomNotificationDataKeyOpt = "operator";
static const char* kChatRoomNotificationDataKeyOptNick = "opeNick";
static const char* kChatRoomNotificationDataKeyTargetNick = "tarNick";
static const char* kChatRoomNotificationDataKeyTarget = "target";
static const char* kChatRoomNotificationDataKeyTempMuteDuration = "muteDuration";
static const char* kChatRoomNotificationDataKeyMuteFlag = "muted";
static const char* kChatRoomNotificationDataKeyTempMutedFlag = "tempMuted";
static const char* kChatRoomNotificationDataKeyMemberInTempMutedDuration = "muteTtl";
static const char* kChatRoomNotificationDataKeyQueueChange = "queueChange";
static const char* kChatRoomNotificationDataKeyTargetTag = "targetTag";
static const char* kChatRoomNotificationDataKeyMsgTimetag = "msgTime";
static const char* kChatRoomNotificationDataKeyMsgId = "msgId";
static const char* kChatRoomNotificationDataKeyTags = "tags";
  // 聊天室通知Keys
 
static const char* kNIMChatRoomQueueElementKey = "key";
static const char* kNIMChatRoomQueueElementValue = "value";  // 聊天室麦序队列元素Keys
 
static const char* kNIMChatRoomQueueOfferOptionTransient = "transient";
static const char* kNIMChatRoomQueueOfferOptionElementAccId = "element_accid";  // 聊天室添加、更新队列元素选项
 
static const char* kNIMChatRoomNotificationQueueChangedType_OFFER = "OFFER";
static const char* kNIMChatRoomNotificationQueueChangedType_POLL = "POLL";
static const char* kNIMChatRoomNotificationQueueChangedType_DROP = "DROP";
static const char* kNIMChatRoomNotificationQueueChangedType_PARTCLEAR = "PARTCLEAR";  // 麦序队列变更通知扩展字段type取值
 
static const char* kNIMChatRoomNotificationQueueChangedKeyType = "_e";
static const char* kNIMChatRoomNotificationQueueChangedKeyKey = "key";
static const char* kNIMChatRoomNotificationQueueChangedKeyValue = "content";  // 聊天室通知 麦序队列变更通知扩展字段queueChange keys
 
static const char* kNIMChatRoomNotificationQueueBatchChangedKeyType = "_e";
static const char* kNIMChatRoomNotificationQueueBatchChangedKeyKey = "key";
static const char* kNIMChatRoomNotificationQueueBatchChangedKeyValue = "content";
static const char* kNIMChatRoomNotificationQueueBatchChangedKeyObject = "kvObject";  // 聊天室通知 麦序队列中有批量变更通知扩展字段queueBatchChange keys
 
enum NIMChatRoomNotificationId {
    kNIMChatRoomNotificationIdMemberIn = 301,         
    kNIMChatRoomNotificationIdMemberExit = 302,       
    kNIMChatRoomNotificationIdAddBlack = 303,         
    kNIMChatRoomNotificationIdRemoveBlack = 304,      
    kNIMChatRoomNotificationIdAddMute = 305,          
    kNIMChatRoomNotificationIdRemoveMute = 306,       
    kNIMChatRoomNotificationIdAddManager = 307,       
    kNIMChatRoomNotificationIdRemoveManager = 308,    
    kNIMChatRoomNotificationIdAddFixed = 309,         
    kNIMChatRoomNotificationIdRemoveFixed = 310,      
    kNIMChatRoomNotificationIdClosed = 311,           
    kNIMChatRoomNotificationIdInfoUpdated = 312,      
    kNIMChatRoomNotificationIdMemberKicked = 313,     
    kNIMChatRoomNotificationIdMemberTempMute = 314,   
    kNIMChatRoomNotificationIdMemberTempUnMute = 315, 
    kNIMChatRoomNotificationIdMyRoleUpdated = 316,    
    kNIMChatRoomNotificationIdQueueChanged = 317, 
    kNIMChatRoomNotificationIdRoomMuted = 318,    
    kNIMChatRoomNotificationIdRoomDeMuted = 319, 
    kNIMChatRoomNotificationIdQueueBatchChanged = 320, 
    kNIMChatRoomNotificationIdTagTempMuteAdd = 321, 
    kNIMChatRoomNotificationIdTagTempMuteRemove = 322, 
    kNIMChatRoomNotificationIdRecallMessage = 323, 
    kNIMChatRoomNotificationIdQueueBatchOffer = 324,
    kNIMChatRoomNotificationIdMemberTagChanged = 325
};
 
enum NIMChatRoomLinkCondition {
    kNIMChatRoomLinkConditionAlive = 0,        
    kNIMChatRoomLinkConditionDeadAndRetry = 1, 
    kNIMChatRoomLinkConditionDead = 2,         
};
 
enum NIMChatRoomEnterStep {
    kNIMChatRoomEnterStepInit = 1,              
    kNIMChatRoomEnterStepServerConnecting = 2,  
    kNIMChatRoomEnterStepServerConnectOver = 3, 
    kNIMChatRoomEnterStepRoomAuthing = 4,       
    kNIMChatRoomEnterStepRoomAuthOver = 5, 
};
 
enum NIMChatRoomProxyType {
    kNIMChatRoomProxyNone = 0,    
    kNIMChatRoomProxyHttp11 = 1,  
    kNIMChatRoomProxySocks4 = 4,  
    kNIMChatRoomProxySocks4a = 5, 
    kNIMChatRoomProxySocks5 = 6,  
};
 
// 协议定义
static const char* kNIMRobotInfoKeyAccid = "accid";
static const char* kNIMRobotInfoKeyName = "name";
static const char* kNIMRobotInfoKeyIcon = "icon";
static const char* kNIMRobotInfoKeyIntro = "intro";
static const char* kNIMRobotInfoKeyRobotId = "rid";
static const char* kNIMRobotInfoKeyCreateTime = "create_timetag";
static const char* kNIMRobotInfoKeyUpdateTime = "update_timetag";  // 机器人信息 Json Keys
 
static const char* kEnterKeyPublicConfigRoot = "public_config";
static const char* kEnterKeyDedicatedClusteFlag = "dedicated_cluste_flag";
static const char* kEnterKeyNegoKeyNECA = "nego_key_neca";
static const char* kEnterKeyCommNECA = "comm_enca";
static const char* kEnterKeyHandShakeType = "hand_shake_type";
static const char* kEnterKeyPrivateConfigRoot = "private_config";
static const char* kEnterKeyNegoKeyNECAKeyPA = "nego_key_enca_key_parta";
static const char* kEnterKeyNegoKeyNECAKeyPB = "nego_key_enca_key_partb";
static const char* kEnterKeyNegoKeyNECAKeyV = "nego_key_enca_key_version";
typedef char* NIMChatRoomConfigGetter;
#define EmptyNIMChatRoomConfigGetter ("")
#ifdef __cplusplus
};
#endif  // __cplusplus
#endif  // NIM_CHATROOM_NIM_CHATROOM_DEFINES_NIM_CHATROOM_DEF_H_