node-nim
Version:
NetEase IM nodejs wrapper based on NetEase IM C++ SDK
763 lines (762 loc) • 28.6 kB
TypeScript
export declare enum NIMQChatChannelType {
/** 普通文本频道 */
kNIMQChatChannelTypeText = 0,
/** RTC频道 */
kNIMQChatChannelTypeRTC = 1,
/** 自定义频道类型 */
kNIMQChatChannelTypeCustom = 100
}
export declare enum NIMQChatChannelMemberIdentifyType {
kNIMQChatWhite = 1,
kNIMQChatBlack = 2
}
export declare enum NIMQChatChannelMemberIdentifyOpeType {
kNIMQChatChannelMemberIdentifyOpeTypeAdd = 1,
kNIMQChatChannelMemberIdentifyOpeTypeRemove = 2
}
export declare enum NIMQChatChannelWhiteBlackType {
kNIMQChatChannelWhite = 1,
kNIMQChatChannelBlack = 2
}
export declare enum NIMQChatChannelWhiteBlackOpeType {
kNIMQChatChannelWhiteBlackOpeTypeAdd = 1,
kNIMQChatChannelWhiteBlackOpeTypeRemove = 2
}
export declare enum NIMQChatChannelViewMode {
/** 公开模式 */
kNIMQChatChannelViewModePublic = 0,
/** 私密模式 */
kNIMQChatChannelViewModePrivate = 1
}
export declare enum NIMQChatChannelVisitorMode {
/** 游客可见 */
kNIMQChatChannelVisitorModeVisible = 0,
/** 游客不可见 */
kNIMQChatChannelVisitorModeInvisible = 1,
/** 跟随模式, 频道公开游客可见, 频道私密游客不可见 */
kNIMQChatChannelVisitorModeFollow = 2
}
export declare enum NIMQChatChannelSyncMode {
/** 不与频道分组同步 */
kNIMQChatChannelSyncModeNoSync = 0,
/** 与频道分组同步 */
kNIMQChatChannelSyncModeSync = 1
}
export declare enum NIMQChatSubscribeOpeType {
/** 订阅 */
kNIMQChatSubscribeOpeTypeSubscribe = 1,
/** 取消订阅 */
kNIMQChatSubscribeOpeTypeUnsubscribe = 2
}
export declare enum NIMQChatSubscribeType {
/** 未知 */
kNIMQChatSubscribeTypeUnknow = 0,
/** 订阅某个channel的【消息】/【通知】 */
kNIMQChatSubscribeTypeMsg = 1,
/** 订阅某个channel的【消息未读数】/【通知】 */
kNIMQChatSubscribeTypeUnreadCount = 2,
/** 订阅某个channel的【消息未读状态】/【通知】 */
kNIMQChatSubscribeTypeUnreadStatus = 3,
/** 订阅某个server的【通知】 */
kNIMQChatSubscribeTypeServerNotification = 4,
/** 订阅某个channel的【正在输入事件】 */
kNIMQChatSubscribeTypeTypingEvent = 5,
/** 以游客身份订阅某个channel的【消息】/【通知】 */
kNIMQChatSubscribeTypeVisitorMsg = 6,
/** 以游客身份订阅某个server的【消息】/【通知】 */
kNIMQChatSubscribeTypeVisitorServerNotification = 7
}
export declare enum NIMQChatDownloadResType {
/** 原文件 */
NIMQChatDownloadResTypeSource = 1,
/** 图片缩略图 */
NIMQChatDownloadResTypeImageThumnail = 2,
/** 视频封面 */
NIMQChatDownloadResTypeVideoCover = 3
}
export declare enum NIMQChatBanMemberOpeType {
/** 封禁 */
kNIMQChatBanMemberOpeTypeBan = 1,
/** 解除封禁 */
kNIMQChatBanMemberOpeTypeUnban = 2
}
export declare enum NIMQChatSortType {
/** 按时间排序 */
kNIMQChatSortByCreateTime = 1,
/** 按优先级排序 */
kNIMQChatSortByPriority = 2
}
export declare enum NIMQChatSearchOrder {
/** 按时间正序 */
kNIMQChatSearchOrderAsc = 1,
/** 按时间倒序 */
kNIMQChatSearchOrderDesc = 2
}
export declare enum NIMQChatMessageSearchSort {
/** 创建时间排序 */
kNIMQChatMessageSearchSortCreateTime = 1
}
export declare enum NIMQChatServerSearchSort {
/** 自定义权重排序(详见服务器端文档) */
kNIMQChatServerSearchSortCustom = 0,
/** 创建时间排序 */
kNIMQChatServerSearchSortCreateTime = 1,
/** 服务器总人数排序 */
kNIMQChatServerSearchSortMemberCOunt = 2
}
export declare enum NIMQChatChannelSearchSort {
/** 自定义权重排序(详见服务器端文档) */
kNIMQChatChannelSearchSortCustom = 0,
/** 创建时间排序 */
kNIMQChatChannelSearchSortCreateTime = 1
}
export declare enum NIMResCode {
kNIMResError = 0,
kNIMResSuccess = 200,
kNIMResVersionError = 201,
kNIMResUidPassError = 302,
kNIMResForbidden = 403,
kNIMResNotExist = 404,
kNIMResNoModify = 406,
kNIMResTimeoutError = 408,
kNIMResParameterError = 414,
kNIMResConnectionError = 415,
kNIMResFrequently = 416,
kNIMResExist = 417,
kNIMResOverrun = 419,
kNIMResAccountBlock = 422,
kNIMResUnknownError = 500,
kNIMResServerDataError = 501,
kNIMResTooBuzy = 503,
kNIMResExceedLimit = 508,
kNIMResInvalid = 509,
kNIMResTeamECountLimit = 801,
kNIMResTeamENAccess = 802,
kNIMResTeamENotExist = 803,
kNIMResTeamEMemberNotExist = 804,
kNIMResTeamErrType = 805,
kNIMResTeamLimit = 806,
kNIMResTeamUserStatusErr = 807,
kNIMResTeamApplySuccess = 808,
kNIMResTeamAlreadyIn = 809,
kNIMResTeamInviteSuccess = 810,
kNIMResForcePushCountLimit = 811,
kNIMResTeamMemberLimit = 813,
kNIMResTeamGetInfoListPartSuccess = 816,
kNIMResInvalidProtocol = 997,
kNIMResEUnpacket = 998,
kNIMResEPacket = 999,
kNIMResInBlack = 7101,
kNIMResRoomNotExists = 10404,
kNIMResRoomHasExists = 10405,
kNIMResRoomMemberNotExists = 10406,
kNIMResRoomMemberHasExists = 10407,
kNIMResRoomInviteNotExists = 10408,
kNIMResRoomInviteHasReject = 10409,
kNIMResRoomInviteHasAccept = 10410,
kNIMResPeerNimOffline = 10201,
kNIMResPeerPushOffline = 10202,
kNIMResRoomUidConflict = 10417,
kNIMResRoomMemberExceed = 10419,
kNIMResRoomMemberHasExistsOtherClient = 10420,
kNIMLocalRes = 10000,
kNIMResRoomLocalNeedRequestAgain = 10001,
kNIMLocalResNetworkError = 10010,
kNIMLocalResMsgNosUploadCancel = 10200,
kNIMLocalResMsgNosDownloadCancel = 10206,
kNIMLocalResMsgNosDownloadCheckError = 10207,
kNIMLocalResMsgAccessDenied = 10403,
kNIMLocalResMsgFileNotExist = 10404,
kNIMLocalResParameterError = 10414,
kNIMLocalResFrequently = 10416,
kNIMLocalResExist = 10417,
kNIMLocalResParaError = 10450,
kNIMLocalResMsgSendNosError = 10502,
kNIMLocalResExceedLimit = 10508,
kNIMLocalResCheckMsgDBFailed = 10600,
kNIMLocalResImportMsgDBFailed = 10601,
kNIMLocalResTMembersSyncUndone = 10602,
kNIMLocalResRtsError = 11100,
kNIMLocalResRtsIdNotExist = 11101,
kNIMLocalResRtsVChatExist = 11417,
kNIMLocalResRtsStatusError = 11501,
kNIMLocalResRtsChannelNotExist = 11510,
kNIMResRoomLinkError = 13001,
kNIMResRoomError = 13002,
kNIMResRoomBlackBeOut = 13003,
kNIMResRoomBeMuted = 13004,
kNIMResRoomAllMuted = 13006,
kNIMLocalResAPIErrorInitUndone = 20000,
kNIMLocalResAPIErrorLoginUndone = 20001,
kNIMLocalResAPIErrorLogined = 20002,
kNIMLocalResAPIErrorVersionError = 20003,
kNIMLocalResAPIErrorChatroomMixError = 20005,
kNIMLocalResAPIErrorLoginExceedRetryCount = 20006,
kNIMLocalResAPIErrorRunOutOfLinkAddress = 20007
}
export declare enum NIMQChatPermissions {
/** 管理服务器,Server */
kPermissionManageServer = 1,
/** 管理频道,Server/Channel */
kPermissionManageChannel = 2,
/** 管理角色,Server/Channel */
kPermissionManageRole = 3,
/** 发送消息,Server/Channel */
kPermissionSendMessage = 4,
/** 修改自己信息,Server */
kPermissionUpdateMyInfo = 5,
/** 邀请他人,Server */
kPermissionIviteMember = 6,
/** 踢除他人,Server */
kPermissionKickMember = 7,
/** 修改他人信息,Server */
kPermissionUpdateMemberInfo = 8,
/** 撤回他人信息,Server/Channel */
kPermissionRevokeMemberMessage = 9,
/** 删除他人消息,Server/Channel */
kPermissionDeleteMemberMessage = 10,
/** @ 他人,Server/Channel */
kPermissionAtMember = 11,
/** @ 所有人,Server/Channel */
kPermissionAtAll = 12,
/** 管理白/黑名单,Server/Channel */
kPermissionManageBlackWhiteList = 13,
/** 封禁他人,Server */
kPermissionBanServerMember = 14,
/** RTC频道: 连接的权限,Server/Channel */
kPermissionRTCConnect = 15,
/** RTC频道: 断开他人连接的权限,Server/Channel */
kPermissionRTCDisconnectOther = 16,
/** RTC频道: 开启自己麦克风的权限,Server/Channel */
kPermissionRTCOpenMic = 17,
/** RTC频道: 开启自己摄像头的权限,Server/Channel */
kPermissionRTCOpenCamera = 18,
/** RTC频道: 禁用/解禁他人麦克风的权限,Server/Channel */
kPermissionRTCOpenMuteOthersMic = 19,
/** RTC频道: 禁用/解禁他人摄像头的权限,Server/Channel */
kPermissionRTCOpenMuteOthersCamera = 20,
/** RTC频道: 禁用/解禁全员麦克风的权限,Server/Channel */
kPermissionRTCOpenMuteAllMic = 21,
/** RTC频道: 禁用/解禁全员摄像头的权限,Server/Channel */
kPermissionRTCOpenMuteAllCamera = 22,
/** RTC频道: 打开自己共享屏幕的权限,Server/Channel */
kPermissionRTCOpenScreenShare = 23,
/** RTC频道: 关闭他人共享屏幕的权限,Server/Channel */
kPermissionRTCCloseOthersScreenShare = 24,
/** 服务器申请处理权限,Server */
kPermissionServerHandleApply = 25,
/** 申请邀请历史查看权限,有这个权限才可以查询server级别的申请/邀请记录,Server */
kPermissionGetServerInviteApplyRecords = 26,
/** @ 身份组的权限,Server/Channel */
kPermissionMentionRole = 27
}
export declare enum NIMQChatRoleType {
/** 未知 */
kRoleTypeUnkonwn = 0,
/** 默认 Everyone 身份组 */
kRoleTypeEveryone = 1,
/** 自定义身份组 */
kRoleTypeCustom = 2
}
export declare enum NIMQChatPermissionsOption {
/** 拒绝 */
kPermissionSwitchDeny = -1,
/** 继承 */
kPermissionSwitchExtend = 0,
/** 允许 */
kPermissionSwitchAllow = 1
}
export declare enum NIMQChatLoginAuthType {
/** 默认login token鉴权方式 */
kNIMQChatLoginAuthTypeDefault = 0,
/** app secret鉴权方式 */
kNIMQChatLoginAuthTypeAppSecret = 1,
/** 基于第三方回调的token鉴权方式, 圈组暂不支持 */
kNIMQChatLoginAuthTypeAppThirdParty = 2
}
export declare enum NIMQChatClientType {
kQChatClientTypeUnknown = 0,
/** Android */
kQChatClientTypeAOS = 1,
/** iOS */
kQChatClientTypeIOS = 2,
/** Desktop PC (Windows/macOS/Linux) */
kQChatClientTypePC = 4,
/** WP */
kQChatClientTypeWP = 8,
/** Web */
kQChatClientTypeWeb = 16,
/** macOS */
kQChatClientTypeMacOS = 64,
/** HarmonyOS */
kQChatClientTypeHarmonyOS = 65
}
export declare enum NIMQChatLoginStep {
/** 连接 Link 地址阶段 */
kLoginStepLink = 0,
kLoginStepAuth = 1
}
export declare enum NIMQChatLoginStatus {
kLoginStatusUnlogin = 0,
kLoginStatusLogging = 1,
kLoginStatusLogin = 2,
kLoginStatusKicked = 3
}
export declare enum NIMQChatExchangeKeyEncryptionAlgorithm {
/** RSA 加密 */
kNIMQChatEncryptionAlgorithmRSA = 1,
/** SM2 加密 */
kNIMQChatEncryptionAlgorithmSM2 = 2
}
export declare enum NIMQChatCommEncryptionAlgorithm {
kNIMQChatCommEncryptionAlgorithmBase = 1,
/** RC4 加密 */
kNIMQChatCommEncryptionAlgorithmRC4 = 1,
/** AES128 加密 */
kNIMQChatCommEncryptionAlgorithmAES128 = 2,
kNIMQChatCommEncryptionAlgorithmSM4 = 4
}
export declare enum NIMQChatHandShakeType {
/** 支持配置多种对称与非对称加密算法 */
kNIMQChatHandShakeTypeMulti = 0,
kNIMQChatHandShakeTypeRASRC4 = 1
}
export declare enum NIMQChatFCSAuthenticationType {
kNIMQChatFCSAuthenticationTypeRefer = 1,
kNIMQChatFCSAuthenticationTypeToken = 2,
kNIMQChatFCSAuthenticationTypeURLToken = 3,
kNIMQChatFCSAuthenticationTypeCustom = 4
}
export declare enum NIMQChatMessageStatus {
/** 普通消息状态 */
kMsgStatusNormal = 0,
/** 被撤回的消息 */
kMsgStatusRevoke = 1,
/** 被删除的消息 */
kMsgStatusDelete = 2,
kMsgStatusUser = 10000
}
export declare enum NIMQChatMessageNotifyReason {
/** 未知原因 */
kMessageNotifyReasonUnkonw = 0,
/** 本消息发给了channel里的所有人 */
kMessageNotifyReasonNotifyAll = 1,
/** 本消息发给了channel里的订阅者 */
kMessageNotifyReasonNotifySubscribe = 2
}
export declare enum NIMQChatMsgType {
/** 文本类型消息 */
kNIMQChatMsgTypeText = 0,
/** 图片类型消息 */
kNIMQChatMsgTypeImage = 1,
/** 声音类型消息 */
kNIMQChatMsgTypeAudio = 2,
/** 视频类型消息 */
kNIMQChatMsgTypeVideo = 3,
/** 位置类型消息 */
kNIMQChatMsgTypeLocation = 4,
/** 通知类型消息 */
kNIMQChatMsgTypeNotification = 5,
/** 文件类型消息 */
kNIMQChatMsgTypeFile = 6,
/** 提醒类型消息 */
kNIMQChatMsgTypeTips = 10,
/** 自定义消息 */
kNIMQChatMsgTypeCustom = 100,
/** 未知类型消息,作为默认值 */
kNIMQChatMsgTypeUnknown = 1000
}
export declare enum NIMQChatQuickCommentOperation {
/** 添加 */
kNIMQChatQuickCommentAdd = 1,
/** 删除 */
kNIMQChatQuickCommentRemove = 2
}
export declare enum NIMQChatGetReferMessageType {
/** 获取被回复的消息 */
kNIMQChatGetReferMessageTypeReply = 1,
/** 获取 thread 根消息 */
kNIMQChatGetReferMessageTypeThreadRoot = 2,
/** 获取以上两个条件的消息 */
kNIMQChatGetReferMessageTypeAll = 3
}
export declare enum NIMQChatServerInviteMode {
/** 需要验证 */
kNIMQChatServerInviteModeNeedConfirm = 0,
kNIMQChatServerInviteModeNormal = 1
}
export declare enum NIMQChatServerApplyMode {
/** 不需要验证 */
kNIMQChatServerApplyModeNormal = 0,
/** 需要验证 */
kNIMQChatServerApplyModeNeedConfirm = 1
}
export declare enum NIMQChatServerInviteFailReason {
/** 服务器人数超过限制 */
kNIMQChatServerInviteFailReasonExceedLimit = 1,
/** 被封禁 */
kNIMQChatServerInviteFailReasonBanned = 2
}
export declare enum NIMQChatServerSearchType {
/** 广场搜索 */
kNIMQChatServerSearchTypeSquare = 1,
/** 个人服务器搜索 */
kNIMQChatServerSearchTypePersonal = 2
}
export declare enum NIMQChatInviteApplyRecordType {
/** 申请 */
kNIMQChatInviteApplyRecordTypeApply = 1,
/** 邀请 */
kNIMQChatInviteApplyRecordTypeInvite = 2,
/** 被邀请 */
kNIMQChatInviteApplyRecordTypeBeInvited = 3,
/** 生成邀请码 */
kNIMQChatInviteApplyRecordTypeGenerateInviteCode = 4,
/** 通过邀请码加入 */
kNIMQChatInviteApplyRecordTypeJoinByInviteCode = 5
}
export declare enum NIMQChatInviteApplyRecordStatus {
/** 初始状态 */
kNIMQChatInviteApplyRecordStatusInitial = 0,
/** 同意 */
kNIMQChatInviteApplyRecordStatusApprove = 1,
/** 拒绝 */
kNIMQChatInviteApplyRecordStatusReject = 2,
/** 通过其他请求同意 */
kNIMQChatInviteApplyRecordStatusApproveByOtherRequest = 3,
/** 通过其他请求拒绝 */
kNIMQChatInviteApplyRecordStatusRejectByOtherRequest = 4,
/** 邀请/申请时自动加入 */
kNIMQChatInviteApplyRecordStatusAutoJoin = 5,
/** 过期 */
kNIMQChatInviteApplyRecordStatusExpired = 6
}
export declare enum NIMQChatSystemNotificationToType {
kNIMQChatSystemNotificationToTypeUnknown = 0 /**< 默认值,需要由用户修改,否则报错 10414 参数错误 */,
kNIMQChatSystemNotificationToTypeServer = 1 /**< 发送到 Server,server_id 必填 */,
kNIMQChatSystemNotificationToTypeChannel = 2 /**< 发送到 Channel,server_id 和 channel_id 必填 */,
kNIMQChatSystemNotificationToTypeServerAccids = 3 /**< 发送到 Server 中的指定用户,server_id 和 to_accids 必填 */,
kNIMQChatSystemNotificationToTypeChannelAccids = 4 /**<发送到 Channel 中的指定用户,server_id、channel_id 和 to_accids 必填 */,
kNIMQChatSystemNotificationToTypeAccids = 5 /**< 发送给指定用户,to_accids 必填 */
}
export declare enum NIMQChatSystemNotificationType {
/** 未知类型系统通知 */
kNIMQChatSystemNotificationTypeUnkonwn = 0,
/** 服务器成员邀请 msg_data: NULL */
kNIMQChatSystemNotificationTypeMemberInvite = 1,
/** 服务器成员邀请被拒绝 msg_data: NULL */
kNIMQChatSystemNotificationTypeMemberInviteReject = 2,
/** 服务器成员申请 msg_data: NULL */
kNIMQChatSystemNotificationTypeMemberApply = 3,
/** 服务器成员申请被拒绝 msg_data: NULL */
kNIMQChatSystemNotificationTypeMemberApplyReject = 4,
/** 服务器创建 msg_data: NIMQChatSystemNotificationDataServerCreate */
kNIMQChatSystemNotificationTypeServerCreate = 5,
/** 服务器解散 msg_data: NULL */
kNIMQChatSystemNotificationTypeServerRemove = 6,
/** 服务器更新 msg_data: NIMQChatSystemNotificationDataServerUpdate */
kNIMQChatSystemNotificationTypeServerUpdate = 7,
/** 服务器成员邀请完成 msg_data: NIMQChatSystemNotificationDataMemberInviteDone */
kNIMQChatSystemNotificationTypeMemberInviteDone = 8,
/** 服务器成员邀请被接受 msg_data: NIMQChatSystemNotificationDataMemberInviteAccept */
kNIMQChatSystemNotificationTypeMemberInviteAccept = 9,
/** 服务器成员申请完成 msg_data: NIMQChatSystemNotificationDataMemberApplyDone */
kNIMQChatSystemNotificationTypeMemberApplyDone = 10,
/** 服务器成员申请被接受 msg_data: NIMQChatSystemNotificationDataMemberApplyAccept */
kNIMQChatSystemNotificationTypeMemberApplyAccept = 11,
/** 服务器成员被踢出 msg_data: NIMQChatSystemNotificationDataMemberKick */
kNIMQChatSystemNotificationTypeMemberKick = 12,
/** 服务器成员离开 msg_data: NIMQChatSystemNotificationDataMemberLeave */
kNIMQChatSystemNotificationTypeMemberLeave = 13,
/** 服务器成员更新 msg_data: NIMQChatSystemNotificationDataMemberUpdate */
kNIMQChatSystemNotificationTypeMemberUpdate = 14,
/** 频道创建 msg_data: NIMQChatSystemNotificationDataChannelCreate */
kNIMQChatSystemNotificationTypeChannelCreate = 15,
/** 频道解散 msg_data: NULL */
kNIMQChatSystemNotificationTypeChannelDelete = 16,
/** 频道更新 msg_data: NIMQChatSystemNotificationDataChannelUpdate */
kNIMQChatSystemNotificationTypeChannelUpdate = 17,
/** 频道白/黑名单身份组更新 msg_data: NIMQChatSystemNotificationDataWhiteBlackRoleUpdate */
kNIMQChatSystemNotificationTypeWhiteBlackRoleUpdate = 18,
/** 频道白/黑名单成员更新 msg_data: NIMQChatSystemNotificationDataWhiteBlackMembersUpdate */
kNIMQChatSystemNotificationTypeWhiteBlackMembersUpdate = 19,
/** 添加或删除快捷评论通知 msg_data: NIMQChatSystemNotificationQuickCommentChanged */
kNIMQChatSystemNotificationTypeQuickCommentChanged = 20,
/** 创建频道分组 msg_data: NIMQChatSystemNotificationDataChannelCategoryCreate */
kNIMQChatSystemNotificationTypeChannelCategoryCreate = 21,
/** 删除频道分组 msg_data: NIMQChatSystemNotificationDataChannelCategoryRemove */
kNIMQChatSystemNotificationTypeChannelCategoryRemove = 22,
/** 更新频道分组 msg_data: NIMQChatSystemNotificationDataChannelCategoryUpdate */
kNIMQChatSystemNotificationTypeChannelCategoryUpdate = 23,
/** 频道分组白/黑名单身份组更新 msg_data: NIMQChatSystemNotificationDataChannelCategoryWhiteBlackRoleUpdate */
kNIMQChatSystemNotificationTypeChannelCategoryWhiteBlackRoleUpdate = 24,
/** 频道分组白/黑名单成员更新 msg_data: NIMQChatSystemNotificationDataChannelCategoryWhiteBlackMembersUpdate */
kNIMQChatSystemNotificationTypeChannelCategoryWhiteBlackMembersUpdate = 25,
/** 服务器身份组加入成员 msg_data: NIMQChatSystemNotificationDataServerRoleAddMember */
kNIMQChatSystemNotificationTypeServerRoleAddMember = 26,
/** 服务器身份组移出成员 msg_data: NIMQChatSystemNotificationDataServerRoleRemoveMember */
kNIMQChatSystemNotificationTypeServerRoleRemoveMember = 27,
/** 服务器身份组权限变更 msg_data: NIMQChatSystemNotificationDataServerRolePermissionChange */
kNIMQChatSystemNotificationTypeServerRolePermissionChange = 28,
/** 频道定制身份组权限变更 msg_data: NIMQChatSystemNotificationDataChannelRolePermissionChange */
kNIMQChatSystemNotificationTypeChannelRolePermissionChange = 29,
/** 频道个人定制权限变更 msg_data: NIMQChatSystemNotificationDataMemberRolePermissionChange */
kNIMQChatSystemNotificationTypeMemberRolePermissionChange = 30,
/** 频道对当前用户可见性变更 msg_data: NIMQChatSystemNotificationDataChannelVisibilityChange */
kNIMQChatSystemNotificationTypeChannelVisibilityChange = 31,
/** 当前用户进入/离开服务器 msg_data: NIMQChatSystemNotificationDataServerEnterLeave */
kNIMQChatSystemNotificationTypeServerEnterLeave = 32,
/** 用户通过邀请码加入服务器 msg_data: NIMQChatSystemNotificationDataServerJoinByInviteCode */
kNIMQChatSystemNotificationTypeServerJoinByInviteCode = 33,
/** 频道对游客可见性变更 msg_data: NIMQChatSystemNotificationDataChannelGuestVisibilityChange */
kNIMQChatSystemNotificationTypeChannelVisitorVisibilityChange = 34,
/** 当前用户服务器成员信息对IM资料的联动变更 msg_data: NIMQChatSystemNotificationDataMyMemberInfoUpdated */
kNIMQChatSystemNotificationTypeMyMemberInfoUpdated = 35,
/** 自定义系统通知 msg_data: NULL */
kNIMQChatSystemNotificationTypeCustom = 100
}
export declare enum NIMQChatSystemNotificationStatus {
/** 普通状态 */
kNIMQChatSystemNotificationNormal = 0,
kNIMQChatSystemNotificationUser = 10000
}
export type QChatPermission = Map<NIMQChatPermissions, NIMQChatPermissionsOption>;
export type QChatBaseCallback = (resp: QChatBaseResp) => void;
export interface NIMQChatChannelIDInfo {
/** server id */
server_id?: string;
/** channel id */
channel_id?: string;
}
export interface QChatBaseResp {
/** 操作结果, 参考NIMResCode */
res_code?: NIMResCode;
}
export interface QChatPageInfo {
/** 是否还有更多 */
has_more?: boolean;
/** 下一次分页起始时间 */
next_timestamp?: number;
/** 下一次分页起始游标 */
cursor?: string;
}
export interface QChatBusinessAntiSpamInfo {
/** 反垃圾文本业务id */
text_bid?: string;
/** 反垃圾图片业务id */
pic_bid?: string;
}
export interface QChatMemberInfo {
/** server id */
server_id?: string;
/** 用户accid */
accid?: string;
/** 昵称 */
nick?: string;
/** 头像url */
avatar?: string;
/** 自定义字段 */
custom?: string;
/** 用户类型,0:普通用户 1:所有者 */
type?: number;
/** 加入时间 */
join_time?: number;
/** 邀请人 */
inviter?: string;
/** 有效标记,false:无效 true:有效 */
valid_flag?: boolean;
/** 创建时间 */
create_time?: number;
/** 更新时间 */
update_time?: number;
}
export interface QChatServerRoleInfo {
/** 服务器ID */
server_id?: string;
/** 身份组id */
role_id?: string;
/** 身份组名称 */
role_name?: string;
/** 身份组图片 URL */
role_icon?: string;
/** 身份组扩展字段 */
extension?: string;
/** 身份组权限设定 */
permissions?: QChatPermission;
/** 身份组类型 1 表示 Everyone,2 表示定制身份组 */
role_type?: NIMQChatRoleType;
/** 身份组创建时间 */
create_time?: number;
/** 身份组修改时间 */
update_time?: number;
/** 该身份组的成员数量,Everyone 身份组数量为 -1 */
member_count?: number;
/** 身份组优先级,Everyone 最高为 0,数字越大优先级越低,自定义优先级区间 1~9007199254740991 */
priority?: number;
}
export interface QChatChannelRoleInfo {
/** 服务器ID */
server_id?: string;
/** 身份组id */
role_id?: string;
/** 身份组名称 */
role_name?: string;
/** 身份组图片 URL */
role_icon?: string;
/** 身份组扩展字段 */
extension?: string;
/** 身份组权限设定 */
permissions?: QChatPermission;
/** 身份组类型 1 表示 Everyone,2 表示定制身份组 */
role_type?: NIMQChatRoleType;
/** 身份组创建时间 */
create_time?: number;
/** 身份组修改时间 */
update_time?: number;
/** 频道 ID */
channel_id?: string;
/** 继承的服务器身份组 ID */
parent_role_id?: string;
}
export interface QChatChannelCategoryRoleInfo {
/** 服务器ID */
server_id?: string;
/** 身份组id */
role_id?: string;
/** 身份组名称 */
role_name?: string;
/** 身份组图片 URL */
role_icon?: string;
/** 身份组扩展字段 */
extension?: string;
/** 身份组权限设定 */
permissions?: QChatPermission;
/** 身份组类型 1 表示 Everyone,2 表示定制身份组 */
role_type?: NIMQChatRoleType;
/** 身份组创建时间 */
create_time?: number;
/** 身份组修改时间 */
update_time?: number;
/** 频道分组 ID */
category_id?: string;
/** 继承的服务器身份组 ID */
parent_role_id?: string;
/** 有效标志 */
valid_flag?: boolean;
}
export interface QChatMemberRoleInfo {
/** 该定制权限所在的频道 ID */
channel_id?: string;
/** 该定制权限所在的身份组 ID */
role_id?: string;
/** 定制权限的用户信息 */
member_info?: QChatMemberInfo;
/** 身份组权限设定 */
permissions?: QChatPermission;
/** 身份组创建时间 */
create_time?: number;
/** 身份组修改时间 */
update_time?: number;
}
export interface QChatChannelCategoryMemberRoleInfo {
/** 频道分组 ID */
category_id?: string;
/** 该定制权限所在的身份组 ID */
role_id?: string;
/** 定制权限的用户信息 */
member_info?: QChatMemberInfo;
/** 身份组权限设定 */
permissions?: QChatPermission;
/** 身份组创建时间 */
create_time?: number;
/** 身份组修改时间 */
update_time?: number;
}
export interface NIMQChatUnreadInfo {
/** 服务器ID */
server_id?: string;
/** 频道ID */
channel_id?: string;
/** 已读时间戳 */
ack_timestamp?: number;
/** 未读数 */
unread_count?: number;
/** 被@未读数 */
mentioned_unread_count?: number;
/** 订阅未读数时的最大未读数 */
max_unread_count?: number;
/** 最后一条消息时间戳 */
last_msg_timestamp?: number;
}
export interface QChatRoleMemberInfo {
/** member_info */
member_info?: QChatMemberInfo;
/** 所在身份组role id */
role_id?: string;
}
export interface QChatServerInfo {
/** server id */
server_id?: string;
/** 用户自定义服务器类别, 0表示无类别 */
server_type?: number;
/** 是否能被搜索 */
searchable?: boolean;
/** 名称 */
name?: string;
/** 图标url */
icon?: string;
/** 自定义字段 */
custom?: string;
/** 所有者id */
owner_id?: string;
/** 成员数量 */
member_count?: number;
/** 邀请模式 */
invite_mode?: NIMQChatServerInviteMode;
/** 申请模式 */
apply_mode?: NIMQChatServerApplyMode;
/** 有效标记,false:无效 true:有效 */
valid_flag?: boolean;
/** 总频道数量 */
channel_count?: number;
/** 总频道分组数量 */
channel_category_count?: number;
/** 创建时间 */
create_time?: number;
/** 更新时间 */
update_time?: number;
/** 自定义排序权重值 */
reorder_weight?: number;
}
export interface QChatInviteUserInfo {
/** accid */
accid?: string;
/** 更新附言 */
update_postscript?: string;
/** 状态 */
status?: NIMQChatInviteApplyRecordStatus;
/** 更新时间 */
update_time?: number;
}
export interface QChatInviteApplyRecord {
/** accid */
accid?: string;
/** type */
type?: NIMQChatInviteApplyRecordType;
/** 服务器ID */
server_id?: string;
/** 状态 */
status?: NIMQChatInviteApplyRecordStatus;
/** 请求ID */
request_id?: string;
/** 记录ID */
record_id?: string;
/** 创建时间 */
create_time?: number;
/** 更新时间 */
update_time?: number;
/** 过期时间 */
expire_time?: number;
/** 邀请申请信息原始Json数据 */
raw_data?: string;
}