node-nim 9.16.10 → 9.18.0

package/types/nim_def/team_def.d.ts

@@ -3,76 +3,116 @@ import { IMMessage, NIMNotificationId } from './msglog_def';
 import { UserNameCard } from './user_def';
 /** @enum NIMTeamBeInviteMode 被邀请人同意方式 */
 export declare enum NIMTeamBeInviteMode {
-    kNIMTeamBeInviteModeNeedAgree = 0 /** < 需要同意 */,
-    kNIMTeamBeInviteModeNotNeedAgree = 1 /** < 不需要同意 */
+    /** 需要同意 */
+    kNIMTeamBeInviteModeNeedAgree = 0,
+    /** 不需要同意 */
+    kNIMTeamBeInviteModeNotNeedAgree = 1
 }
 /** @enum NIMTeamInviteMode 谁可以邀请他人入群 */
 export declare enum NIMTeamInviteMode {
-    kNIMTeamInviteModeManager = 0 /** < 管理员 */,
-    kNIMTeamInviteModeEveryone = 1 /** < 所有人 */
+    /** 管理员 */
+    kNIMTeamInviteModeManager = 0,
+    /** 所有人 */
+    kNIMTeamInviteModeEveryone = 1
 }
 /** @enum NIMTeamUpdateInfoMode 谁可以修改群资料 */
 export declare enum NIMTeamUpdateInfoMode {
-    kNIMTeamUpdateInfoModeManager = 0 /** < 管理员 */,
-    kNIMTeamUpdateInfoModeEveryone = 1 /** < 所有人 */
+    /** 管理员 */
+    kNIMTeamUpdateInfoModeManager = 0,
+    /** 所有人 */
+    kNIMTeamUpdateInfoModeEveryone = 1
 }
 /** @enum NIMTeamUpdateCustomMode 谁可以更新群自定义属性 */
 export declare enum NIMTeamUpdateCustomMode {
-    kNIMTeamUpdateCustomModeManager = 0 /** < 管理员 */,
-    kNIMTeamUpdateCustomModeEveryone = 1 /** < 所有人 */
+    /** 管理员 */
+    kNIMTeamUpdateCustomModeManager = 0,
+    /** 所有人 */
+    kNIMTeamUpdateCustomModeEveryone = 1
 }
 /** @enum NIMTeamMuteType 群信息kTeamInfoKeyMuteType的配置定义 */
 export declare enum NIMTeamMuteType {
-    kNIMTeamMuteTypeNone = 0 /** < 不禁言 */,
-    kNIMTeamMuteTypeNomalMute = 1 /** < 普通成员禁言 */,
-    kNIMTeamMuteTypeAllMute = 3 /** < 全部禁言 */
+    /** 不禁言 */
+    kNIMTeamMuteTypeNone = 0,
+    /** 普通成员禁言 */
+    kNIMTeamMuteTypeNomalMute = 1,
+    /** 全部禁言 */
+    kNIMTeamMuteTypeAllMute = 3
 }
 /** @enum NIMTeamBitsConfigMask 群组成员信息Bits属性kNIMTeamUserKeyBits的配置定义 */
 export declare enum NIMTeamBitsConfigMask {
-    kNIMTeamBitsConfigMaskMuteNone = 0 /** < 开启提醒 bits 0000b*/,
-    kNIMTeamBitsConfigMaskMuteNotify = 1 /** < 关闭提醒 bits 0001b*/,
-    kNIMTeamBitsConfigMaskOnlyAdmin = 2 /** < 只接收管理员消息 bits 0010b 超大群当前不支持该选项*/
+    /** 开启提醒 bits 0000b*/
+    kNIMTeamBitsConfigMaskMuteNone = 0,
+    /** 关闭提醒 bits 0001b*/
+    kNIMTeamBitsConfigMaskMuteNotify = 1,
+    /** 只接收管理员消息 bits 0010b 超大群当前不支持该选项*/
+    kNIMTeamBitsConfigMaskOnlyAdmin = 2
 }
 /** @enum NIMTeamType 群组类型 */
 export declare enum NIMTeamType {
-    kNIMTeamTypeNormal = 0 /** < 普通群 */,
-    kNIMTeamTypeAdvanced = 1 /** < 高级群 */
+    /** 普通群 */
+    kNIMTeamTypeNormal = 0,
+    /** 高级群 */
+    kNIMTeamTypeAdvanced = 1
 }
 /** @enum NIMTeamUserType 群成员类型 */
 export declare enum NIMTeamUserType {
-    kNIMTeamUserTypeNomal = 0 /** < 普通成员 */,
-    kNIMTeamUserTypeCreator = 1 /** < 创建者 */,
-    kNIMTeamUserTypeManager = 2 /** < 管理员 */,
-    kNIMTeamUserTypeApply = 3 /** < 申请加入用户 */,
-    kNIMTeamUserTypeLocalWaitAccept = 100 /** < 本地记录等待正在入群的用户 */
+    /** 普通成员 */
+    kNIMTeamUserTypeNomal = 0,
+    /** 创建者 */
+    kNIMTeamUserTypeCreator = 1,
+    /** 管理员 */
+    kNIMTeamUserTypeManager = 2,
+    /** 申请加入用户 */
+    kNIMTeamUserTypeApply = 3,
+    /** 本地记录等待正在入群的用户 */
+    kNIMTeamUserTypeLocalWaitAccept = 100
 }
 /** @enum NIMTeamJoinMode 群允许加入类型 */
 export declare enum NIMTeamJoinMode {
-    kNIMTeamJoinModeNoAuth = 0 /** < 不用验证 */,
-    kNIMTeamJoinModeNeedAuth = 1 /** < 需要验证 */,
-    kNIMTeamJoinModeRejectAll = 2 /** < 拒绝所有人入群 */
+    /** 不用验证 */
+    kNIMTeamJoinModeNoAuth = 0,
+    /** 需要验证 */
+    kNIMTeamJoinModeNeedAuth = 1,
+    /** 拒绝所有人入群 */
+    kNIMTeamJoinModeRejectAll = 2
 }
 export declare enum NIMTeamQueryType {
-    kNIMTeamQueryDefault = 0 /** < 默认，匹配群组 ID 和群名称 */,
-    kNIMTeamQueryByTeamId = 1 /** < 仅匹配群组 ID，传字符串，SDK 会自动转为 long 类型数据与群组 ID 严格匹配 */,
-    kNIMTeamQueryByTeamName = 2 /** < 仅匹配群组名称 */
+    /** 默认，匹配群组 ID 和群名称 */
+    kNIMTeamQueryDefault = 0,
+    /** 仅匹配群组 ID，传字符串，SDK 会自动转为 long 类型数据与群组 ID 严格匹配 */
+    kNIMTeamQueryByTeamId = 1,
+    /** 仅匹配群组名称 */
+    kNIMTeamQueryByTeamName = 2
 }
 export declare enum TeamQueryOrder {
+    /** 按时间降序排列 */
     kTeamQueryOrderDesc = 0,
+    /** 按时间升序排列 */
     kTeamQueryOrderAsc = 1
 }
 export interface TeamEvent {
-    res_code_?: NIMResCode; /**< 错误码 */
-    notification_id_?: NIMNotificationId; /**< 通知类型ID */
-    team_id_?: string; /**< 群组ID */
-    ids_?: Array<string>; /**< 通知可能涉及到的群成员ID */
-    invalid_ids_?: Array<string>; /**< 通知可能涉及到的失效的群成员ID，比如邀请入群的成员的群数量超限导致当次邀请失败 */
-    namecards_?: Array<UserNameCard>; /**< 通知可能涉及到的群成员的用户名片 */
-    team_info_?: TeamInfo; /**< 通知可能涉及到的群信息 */
-    member_property_?: TeamMemberProperty; /**< 群成员属性 */
-    opt_?: boolean; /**< 操作 */
-    attach_?: string; /**< 扩展字段,目前仅kick和invite事件可选 */
-    src_data_?: string; /**< 未解析过的原信息，目前仅支持群消息未读数相关事件 */
+    /** 错误码 */
+    res_code_?: NIMResCode;
+    /** 通知类型ID */
+    notification_id_?: NIMNotificationId;
+    /** 群组ID */
+    team_id_?: string;
+    /** 通知可能涉及到的群成员ID */
+    ids_?: Array<string>;
+    /** 通知可能涉及到的失效的群成员ID，比如邀请入群的成员的群数量超限导致当次邀请失败 */
+    invalid_ids_?: Array<string>;
+    /** 通知可能涉及到的群成员的用户名片 */
+    namecards_?: Array<UserNameCard>;
+    /** 通知可能涉及到的群信息 */
+    team_info_?: TeamInfo;
+    /** 群成员属性 */
+    member_property_?: TeamMemberProperty;
+    /** 操作 */
+    opt_?: boolean;
+    /** 扩展字段,目前仅kick和invite事件可选 */
+    attach_?: string;
+    /** 未解析过的原信息，目前仅支持群消息未读数相关事件 */
+    src_data_?: string;
 }
 export interface TeamInfoJsonValue {
     tid?: string;
@@ -86,7 +126,8 @@ export interface TeamInfoJsonValue {
     readonly list_timetag: number;
     readonly create_timetag: number;
     readonly update_timetag: number;
-    member_valid?: number; /**< 1:有效，0:无效 */
+    /** 1:有效，0:无效 */
+    member_valid?: number;
     intro?: string;
     announcement?: string;
     join_mode?: NIMTeamJoinMode;
@@ -100,22 +141,35 @@ export interface TeamInfoJsonValue {
     mute_type?: NIMTeamMuteType;
 }
 export interface TeamInfo {
+    /** json string */
     team_info_json_value_?: TeamInfoJsonValue;
 }
 export interface TeamMemberPropertyJsonValue {
+    /** 群成员类型(NIMTeamUserType),默认kNIMTeamUserTypeNomal(0) */
     type?: NIMTeamUserType;
+    /** 群成员昵称 */
     nick?: string;
+    /** 群成员属性,位操作 */
     bits?: number;
+    /** 群成员自定义扩展字段,必须为可以解析为json的非格式化的字符串 */
     custom?: string;
+    /** 群id */
     tid?: string;
+    /** 群成员id */
     accid?: string;
+    /** 群成员有效性标记位,有效1,无效0 */
     readonly valid: boolean;
+    /** 入群时间戳(毫秒) */
     readonly create_timetag: number;
+    /** 群成员信息上次更新时间戳(毫秒) */
     readonly update_timetag: number;
+    /** 是否被禁言,0-非禁言(默认),1-禁言 */
     readonly mute: number;
+    /** 邀请者的accid 主动入群的时为空 */
     readonly invitor_accid: string;
 }
 export interface TeamMemberProperty {
+    /** json string */
     member_info_json_value_?: TeamMemberPropertyJsonValue;
 }
 export interface TeamMemberSerachResult {

package/types/nim_def/tool_def.d.ts

@@ -1,16 +1,24 @@
 import { NIMResCode } from './client_def';
 /** @enum NIMAppDataType AppData类型 */
 export declare enum NIMAppDataType {
-    kNIMAppDataTypeUnknownOtherRes = 0 /** < 其他资源文件（除了消息历史文件和已知类型之外的消息数据缓存文件） */,
-    kNIMAppDataTypeImage = 1 /** < 图片消息文件 */,
-    kNIMAppDataTypeAudio = 2 /** < 语音消息文件 */,
-    kNIMAppDataTypeVideo = 3 /** < 视频消息文件 */
+    /** 其他资源文件（除了消息历史文件和已知类型之外的消息数据缓存文件） */
+    kNIMAppDataTypeUnknownOtherRes = 0,
+    /** 图片消息文件 */
+    kNIMAppDataTypeImage = 1,
+    /** 语音消息文件 */
+    kNIMAppDataTypeAudio = 2,
+    /** 视频消息文件 */
+    kNIMAppDataTypeVideo = 3
 }
 export interface AudioInfo {
-    mime_type_?: string; /** < string 语音类型 */
-    samplerate_?: string; /** < string 语音采样率 */
-    url_?: string; /** < string 语音url*/
-    duration_?: number; /** < long 语音时长，毫秒*/
+    /** string 语音类型 */
+    mime_type_?: string;
+    /** string 语音采样率 */
+    samplerate_?: string;
+    /** string 语音url*/
+    url_?: string;
+    /** long 语音时长，毫秒*/
+    duration_?: number;
 }
 export type GetAudioTextCallback = (rescode: NIMResCode, text: string) => void;
 export type FilterClientAntispamCallback = (succeed: boolean, rescode: NIMResCode, text: string) => void;

package/types/nim_def/user_def.d.ts

@@ -1,43 +1,69 @@
 import { NIMResCode } from './client_def';
 /** @enum NIMUserSpecialRelationshipChangeType 用户特殊关系数据变更类型 */
 export declare enum NIMUserSpecialRelationshipChangeType {
-    kNIMUserSpecialRelationshipChangeTypeMarkBlack = 1 /** < 添加删除黑名单 */,
-    kNIMUserSpecialRelationshipChangeTypeMarkMute = 2 /** < 添加删除静音名单 */,
-    kNIMUserSpecialRelationshipChangeTypeSyncMuteAndBlackList = 3 /** < 同步黑名单和静音名单 */
+    /** 添加删除黑名单 */
+    kNIMUserSpecialRelationshipChangeTypeMarkBlack = 1,
+    /** 添加删除静音名单 */
+    kNIMUserSpecialRelationshipChangeTypeMarkMute = 2,
+    /** 同步黑名单和静音名单 */
+    kNIMUserSpecialRelationshipChangeTypeSyncMuteAndBlackList = 3
 }
 /** @enum NIMUserQueryType 查询用户信息条件选项 */
 export declare enum NIMUserQueryType {
-    kNIMUserQueryDefault = 0 /** < 查询默认条件，将匹配账户ID和昵称 */,
-    kNIMUserQueryByAccId = 1 /** < 仅匹配账户ID */,
-    kNIMUserQueryByNickname = 2 /** < 仅匹配用户昵称 */
+    /** 查询默认条件，将匹配账户ID和昵称 */
+    kNIMUserQueryDefault = 0,
+    /** 仅匹配账户ID */
+    kNIMUserQueryByAccId = 1,
+    /** 仅匹配用户昵称 */
+    kNIMUserQueryByNickname = 2
 }
 export declare enum NINPushType {
-    kNIMPushTypeDefault = 0 /** < 默认apns */,
-    kNIMPushTypePushKit = 1 /** < pushkit,仅iOS */
+    /** 默认apns */
+    kNIMPushTypeDefault = 0,
+    /** pushkit,仅iOS */
+    kNIMPushTypePushKit = 1
 }
 export interface BlackMuteListInfo {
-    accid_?: string; /**< 用户ID */
-    set_black_?: boolean; /**< 是否黑名单 */
-    set_mute_?: boolean; /**< 是否被静音 */
-    create_timetag_?: number; /**< 档案创建时间（毫秒） */
-    update_timetag_?: number; /**< 档案更新时间（毫秒） */
+    /** 用户ID */
+    accid_?: string;
+    /** 是否黑名单 */
+    set_black_?: boolean;
+    /** 是否被静音 */
+    set_mute_?: boolean;
+    /** 档案创建时间（毫秒） */
+    create_timetag_?: number;
+    /** 档案更新时间（毫秒） */
+    update_timetag_?: number;
 }
 export interface UserNameCard {
-    accid?: string; /**< 用户ID */
-    name?: string; /**< 用户昵称 */
-    icon?: string; /**< 用户头像下载地址 */
-    sign?: string; /**< 用户签名 */
-    gender?: number; /**< 用户性别 */
-    email?: string; /**< 用户邮箱 */
-    birth?: string; /**< 用户生日 */
-    mobile?: string; /**< 用户电话 */
-    ex?: string; /**< 用户扩展数据 */
-    create_timetag?: number; /**< 用户档案创建时间戳(毫秒) */
-    update_timetag?: number; /**< 用户档案更新时间戳(毫秒) */
+    /** 用户ID */
+    accid?: string;
+    /** 用户昵称 */
+    name?: string;
+    /** 用户头像下载地址 */
+    icon?: string;
+    /** 用户签名 */
+    sign?: string;
+    /** 用户性别 */
+    gender?: number;
+    /** 用户邮箱 */
+    email?: string;
+    /** 用户生日 */
+    birth?: string;
+    /** 用户电话 */
+    mobile?: string;
+    /** 用户扩展数据 */
+    ex?: string;
+    /** 用户档案创建时间戳(毫秒) */
+    create_timetag?: number;
+    /** 用户档案更新时间戳(毫秒) */
+    update_timetag?: number;
 }
 export interface SpecialRelationshipChangeEvent {
-    type_?: NIMUserSpecialRelationshipChangeType; /**< 黑名单/静音名单更新事件类型 */
-    content_?: object; /**< 黑名单/静音名单更新事件内容 */
+    /** 黑名单/静音名单更新事件类型 */
+    type_?: NIMUserSpecialRelationshipChangeType;
+    /** 黑名单/静音名单更新事件内容 */
+    content_?: object;
 }
 export type SpecialRelationshipChangedCallback = (result: SpecialRelationshipChangeEvent) => void;
 export type UserNameCardChangedCallback = (result: Array<UserNameCard>) => void;

package/types/node-nim.d.ts

@@ -53,24 +53,43 @@ export * from './qchat_def/system_notification_def';
 export * from './qchat_def/attachment_def';
 export * from './qchat_def/role_def';
 export declare class NIM {
+    /** 客户端模块 */
     client: NIMClient;
+    /** 数据同步模块 */
     dataSync: NIMDataSync;
+    /** 好友模块 */
     friend: NIMFriend;
+    /** 全局模块 */
     global: NIMGlobal;
+    /** 消息历史模块 */
     msgLog: NIMMsgLog;
+    /** 云存储模块 */
     nos: NIMNOS;
+    /** 云端会话模块 */
     onlineSession: NIMOnlineSession;
+    /** 透传代理模块 */
     passThroughProxy: NIMPassThroughProxy;
+    /** 本地会话模块 */
     session: NIMSession;
+    /** 订阅事件模块 */
     subscribeEvent: NIMSubscribeEvent;
+    /** 超大群模块 */
     superTeam: NIMSuperTeam;
+    /** 系统通知模块 */
     sysMsg: NIMSysMsg;
+    /** 聊天模块 */
     talk: NIMTalk;
+    /** 群组模块 */
     team: NIMTeam;
+    /** 工具模块 */
     tool: NIMTool;
+    /** 用户模块 */
     user: NIMUser;
+    /** 插件模块 */
     plugin: NIMPlugin;
+    /** 聊天扩展模块 */
     talkEx: NIMTalkEx;
+    /** 初始化事件处理 */
     initEventHandlers(): void;
 }
 export declare class ChatRoom extends ChatRoomModule {

package/types/qchat_def/public_def.d.ts

@@ -80,6 +80,12 @@ export declare enum NIMQChatBanMemberOpeType {
     /** 解除封禁 */
     kNIMQChatBanMemberOpeTypeUnban = 2
 }
+export declare enum NIMQChatSortType {
+    /** 按时间排序 */
+    kNIMQChatSortByCreateTime = 1,
+    /** 按优先级排序 */
+    kNIMQChatSortByPriority = 2
+}
 export declare enum NIMQChatSearchOrder {
     /** 按时间正序 */
     kNIMQChatSearchOrderAsc = 1,

package/types/qchat_def/role_def.d.ts

@@ -1,4 +1,4 @@
-import { NIMResCode, QChatServerRoleInfo, QChatBaseResp, QChatChannelRoleInfo, QChatChannelCategoryRoleInfo, QChatMemberRoleInfo, QChatChannelCategoryMemberRoleInfo, QChatBaseCallback, QChatBusinessAntiSpamInfo, QChatPermission, NIMQChatPermissions, QChatRoleMemberInfo, NIMQChatPermissionsOption } from './public_def';
+import { NIMResCode, QChatServerRoleInfo, QChatBaseResp, QChatChannelRoleInfo, QChatChannelCategoryRoleInfo, QChatMemberRoleInfo, QChatChannelCategoryMemberRoleInfo, QChatBaseCallback, QChatBusinessAntiSpamInfo, QChatPermission, NIMQChatPermissions, QChatRoleMemberInfo, NIMQChatPermissionsOption, NIMQChatSortType, NIMQChatSearchOrder } from './public_def';
 /** @interface QChatCreateServerRoleResp */
 export interface QChatCreateServerRoleResp {
     /** 操作结果，@see NIMResCode */
@@ -317,6 +317,8 @@ export interface QChatGetRolesByAccidParam {
 export interface QChatGetExistingServerRolesByAccidsParam {
     server_id?: string;
     accids?: Array<string>;
+    sort_type?: NIMQChatSortType;
+    search_order?: NIMQChatSearchOrder;
 }
 /** @interface QChatGetExistingChannelRolesByServerRoleIdsParam */
 export interface QChatGetExistingChannelRolesByServerRoleIdsParam {