node-nim 7.8.3 → 9.1.0-rc.3

package/js/api/team.js

@@ -3,114 +3,512 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const nim_1 = __importDefault(require("./nim"));
+exports.NIMTeam = void 0;
+const loader_1 = __importDefault(require("../loader"));
 const events_1 = __importDefault(require("events"));
 class NIMTeam extends events_1.default.EventEmitter {
     constructor() {
         super();
-        this.team = new nim_1.default.Team();
-    }
-    regTeamEventCb(cb, jsonExtension) {
-        return this.team.RegTeamEventCb(cb, jsonExtension);
-    }
+        this.team = new loader_1.default.NIMTeam({ "emit": this.emit.bind(this) });
+    }
+    /** 注册全局回调 */
+    initEventHandlers() {
+        return this.team.InitEventHandlers();
+    }
+    /** 创建群组
+       * @param team_info 群组信息
+       * @param ids		邀请对象id
+       * @param invitation_postscript 邀请附言
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		群通知的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 810:如果创建的是高级群，返回810表示邀请成功并带上tinfo
+       * 414:成员不足
+       * 801:成员数超限制
+       * 404:成员中有非法用户
+       * </pre>
+       */
     createTeamAsync(info, ids, invitationPostscript, cb, jsonExtension) {
         return this.team.CreateTeamAsync(info, ids, invitationPostscript, cb, jsonExtension);
     }
-    inviteAsync2(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension) {
-        return this.team.InviteAsync2(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension);
-    }
+    /** 邀请
+       * @param tid		群组id
+       * @param ids		邀请对象id
+       * @param invitation_postscript 邀请附言
+       * @param invitation_attachment 用户可自定义的补充邀请信息
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		邀请的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 810:如果是高级群，返回810表示邀请成功并带上timetag
+       * 404:非法用户
+       * 801:群人数超限
+       * 802:没有权限
+       * 803:群不存在
+       * </pre>
+       */
+    inviteAsync(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension) {
+        return this.team.InviteAsync(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension);
+    }
+    /** 踢人
+       * @param tid		群组id
+       * @param ids		被踢对象id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		踢人的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:无超大群功能
+       * 414:踢人数量超限
+       * 802:群人数超限、不能踢自己
+       * 803:群不存在
+       * 804:用户不在群里面
+       * </pre>
+       */
     kickAsync(tid, ids, cb, jsonExtension) {
         return this.team.KickAsync(tid, ids, cb, jsonExtension);
     }
+    /** 离开群
+       * @param tid		群组id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		离开群的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:无超大群功能
+       * 802:没有群权限、群主不能退群
+       * 803:群不存在
+       * 804:用户不在群里
+       * </pre>
+       */
     leaveAsync(tid, cb, jsonExtension) {
         return this.team.LeaveAsync(tid, cb, jsonExtension);
     }
+    /** 解散群
+       * @param tid		群组id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		解散群的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * </pre>
+       */
     dismissAsync(tid, cb, jsonExtension) {
         return this.team.DismissAsync(tid, cb, jsonExtension);
     }
+    /** 更新群信息
+       * @param tid		群组id
+       * @param team_info	群组信息
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		更新群信息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * </pre>
+       */
     updateTeamInfoAsync(tid, info, cb, jsonExtension) {
         return this.team.UpdateTeamInfoAsync(tid, info, cb, jsonExtension);
     }
+    /** 申请入群
+       * @param tid		群组id
+       * @param reason		附言
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		申请入群的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:群验证方式为拒绝所有人申请
+       * 808:申请成功，等待验证
+       * 809:已经在群里
+       * 801:人数限制
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     applyJoinAsync(tid, reason, cb, jsonExtension) {
         return this.team.ApplyJoinAsync(tid, reason, cb, jsonExtension);
     }
+    /** 同意入群申请
+       * @param tid			群组id
+       * @param applicant_id	申请者id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb				同意入群申请的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 509:操作已失效
+       * 809:已经在群里
+       * 801:人数限制
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     passJoinApplyAsync(tid, applicantId, cb, jsonExtension) {
         return this.team.PassJoinApplyAsync(tid, applicantId, cb, jsonExtension);
     }
+    /** 拒绝入群申请
+       * @param tid			群组id
+       * @param applicant_id	申请者id
+       * @param reason			附言
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb				拒绝入群申请的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功，如果用户处于申请状态则会通知申请用户被拒绝
+       * 509:操作已失效
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     rejectJoinApplyAsync(tid, applicantId, reason, cb, jsonExtension) {
         return this.team.RejectJoinApplyAsync(tid, applicantId, reason, cb, jsonExtension);
     }
+    /** 添加管理员
+       * @param tid	群组id
+       * @param ids	管理员id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		添加管理员的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     addManagersAsync(tid, ids, cb, jsonExtension) {
         return this.team.AddManagersAsync(tid, ids, cb, jsonExtension);
     }
+    /** 删除管理员
+       * @param tid	群组id
+       * @param ids	管理员id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		删除管理员的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     removeManagersAsync(tid, ids, cb, jsonExtension) {
         return this.team.RemoveManagersAsync(tid, ids, cb, jsonExtension);
     }
+    /** 移交群主
+       * @param tid			群组id
+       * @param new_owner_id	移交对象id
+       * @param is_leave		是否同时退出群
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		移交群主的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * 806:群数量上限
+       * </pre>
+       */
     transferTeamAsync(tid, newOwnerId, isLeave, cb, jsonExtension) {
-        return this.transferTeamAsync(tid, newOwnerId, isLeave, cb, jsonExtension);
-    }
+        return this.team.TransferTeamAsync(tid, newOwnerId, isLeave, cb, jsonExtension);
+    }
+    /** 更新自己的群属性
+       * @param prop	群成员属性
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		更新自己的群属性的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 803:群不存在
+       * 804:不在群里
+       * 805:群类型不对
+       * </pre>
+       */
     updateMyPropertyAsync(prop, cb, jsonExtension) {
         return this.team.UpdateMyPropertyAsync(prop, cb, jsonExtension);
     }
+    /** 修改别人的群昵称
+       * @param prop	群成员属性
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		修改别人的群昵称的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 803:群不存在
+       * 804:不在群里
+       * 805:群类型不对
+       * </pre>
+       */
     updateOtherNickAsync(prop, cb, jsonExtension) {
         return this.team.UpdateOtherNickAsync(prop, cb, jsonExtension);
     }
+    /** 接受邀请
+       * @param tid		群组id
+       * @param invitor_id	邀请者id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		接受邀请的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     acceptInvitationAsync(tid, inviterId, cb, jsonExtension) {
         return this.team.AcceptInvitationAsync(tid, inviterId, cb, jsonExtension);
     }
+    /** 拒绝邀请
+       * @param tid		群组id
+       * @param invitor_id	邀请者id
+       * @param reason	附言
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		拒绝邀请的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * 805:群类型不对
+       * </pre>
+       */
     rejectInvitationAsync(tid, inviterId, reason, cb, jsonExtension) {
         return this.team.RejectInvitationAsync(tid, inviterId, reason, cb, jsonExtension);
     }
+    /** 查询所有群
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		查询所有群的回调函数
+       * @return void 无返回值
+       */
     queryAllMyTeamsAsync(cb, jsonExtension) {
         return this.team.QueryAllMyTeamsAsync(cb, jsonExtension);
     }
+    /** 查询所有群信息
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		查询所有群信息的回调函数
+       * @return void 无返回值
+       */
     queryAllMyTeamsInfoAsync(cb, jsonExtension) {
         return this.team.QueryAllMyTeamsInfoAsync(cb, jsonExtension);
     }
+    /** 查询所有群里我的成员信息（使用场景：获取了所有群列表后，需要查询自己在每个群里自己的成员信息，使用成员信息里的bits字段，可以判断当某个群发来消息后，是否做消息通知）
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		查询所有群里我的成员信息的回调函数
+       * @return void 无返回值
+       */
     queryMyAllMemberInfosAsync(cb, jsonExtension) {
         return this.team.QueryMyAllMemberInfosAsync(cb, jsonExtension);
     }
+    /** 查询群成员
+       * @param tid		群组id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		查询群成员的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 406:没有变化
+       * 802:没有权限
+       * </pre>
+       */
     queryTeamMembersAsync(tid, cb, jsonExtension) {
         return this.team.QueryTeamMembersAsync(tid, cb, jsonExtension);
     }
+    /** 查询(单个)群成员信息
+       * @param tid		群组id
+       * @param id		    群成员id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		查询群成员的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       */
     queryTeamMemberAsync(tid, id, cb, jsonExtension) {
         return this.team.QueryTeamMemberAsync(tid, id, cb, jsonExtension);
     }
+    /** 查询群信息
+       * @param tid		群组id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		查询群信息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       */
     queryTeamInfoAsync(tid, cb, jsonExtension) {
         return this.team.QueryTeamInfoAsync(tid, cb, jsonExtension);
     }
+    /** 获取群信息（从服务器获取）
+       * @param tid		群组id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		获取群信息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 803:群不存在
+       * </pre>
+       */
     queryTeamInfoOnlineAsync(tid, cb, jsonExtension) {
         return this.team.QueryTeamInfoOnlineAsync(tid, cb, jsonExtension);
     }
-    unregTeamCb() {
-        return this.team.UnregTeamCb();
-    }
-    muteMemberAsync(tid, memberId, setMute, cb, jsonExtension) {
-        return this.team.MuteMemberAsync(tid, memberId, setMute, cb, jsonExtension);
-    }
+    /** 禁言/解除禁言
+       * @param tid		群组id
+       * @param member_id	操作对象id
+       * @param set_mute	禁言/解除禁言
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		踢人的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 404:禁言对象不存在
+       * 414:参数错误
+       * 803:群不存在
+       * 802:没有权限
+       * </pre>
+       */
+    muteMemberAsync(tid, member_id, set_mute, cb, jsonExtension) {
+        return this.team.MuteMemberAsync(tid, member_id, set_mute, cb, jsonExtension);
+    }
+    /** 获取群禁言成员列表
+       * @param tid	群组id
+       * @param cb		回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 802:没有权限
+       * 803:群不存在
+       * </pre>
+       */
     queryMuteListOnlineAsync(tid, cb, jsonExtension) {
         return this.team.QueryMuteListOnlineAsync(tid, cb, jsonExtension);
     }
-    muteAsync(tid, setMute, cb, jsonExtension) {
-        return this.team.MuteAsync(tid, setMute, cb, jsonExtension);
-    }
+    /** 群禁言/解除群禁言
+       * @param tid		群组id
+       * @param set_mute	禁言/解除禁言
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		踢人的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败.
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * </pre>
+       */
+    muteAsync(tid, set_mute, cb, jsonExtension) {
+        return this.team.MuteAsync(tid, set_mute, cb, jsonExtension);
+    }
+    /** 群消息回执
+       * @param tid		群组id
+       * @param msgs		需要发送消息回执的群消息
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb		回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * </pre>
+       */
     teamMsgAckRead(tid, msgs, cb, jsonExtension) {
         return this.team.TeamMsgAckRead(tid, msgs, cb, jsonExtension);
     }
-    teamMsgQueryUnreadList(tid, msg, cb, jsonExtension) {
-        return this.team.TeamMsgQueryUnreadList(tid, msg, cb, jsonExtension);
-    }
+    /** 根据指定 ID 获取群组消息已读未读情况
+       * @param[in] tid		群组id
+       * @param[in] msg		群消息
+       * @param[in] accids    要查询的 ID 列表
+       * @param[in] jsonExtension json扩展参数（备用，目前不需要）
+       * @param[in] cb		回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * </pre>
+       */
+    teamMsgQueryUnreadList(tid, msg, accids, cb, jsonExtension) {
+        return this.team.TeamMsgQueryUnreadList(tid, msg, accids, cb, jsonExtension);
+    }
+    /** 查询群成员的邀请人 accid 由接口 原 TeamQueryTeamMembersInvitor方法
+       * @param tid		群组id
+       * @param members		要查询 的群成员accid列表
+       * @param cb		回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
     queryTeamMembersInvitor(tid, members, cb) {
         return this.team.QueryTeamMembersInvitor(tid, members, cb);
     }
+    /** 查询群信息
+       * @param keyword		要查询的关键字
+       * @param cb				查询群信息的回调函数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       */
     queryTeamInfoByKeywordAsync(keyword, cb, jsonExtension) {
         return this.team.QueryTeamInfoByKeywordAsync(keyword, cb, jsonExtension);
     }
+    /** 更新群信息
+       * @param tid		群组id
+       * @param team_infos	群组信息
+       * @param notify_event	更新后是否触发事件以通知应用层
+       * @param cb		更新群信息的回调函数,回调中会指明更新成功与失败的群ID
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void
+       */
     updateTInfoLocal(infos, cb, jsonExtension) {
         return this.team.UpdateTInfoLocal(infos, cb, jsonExtension);
     }
-    getTeamInfoBatchSFTrans(cb, time_tag, jsonExtension) {
+    /** 查询所有群
+       * @param cb		查询所有群的回调函数
+       * @param time_tag	时间戳，没有特殊需求此参数赋0
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return void 无返回值
+       */
+    getTeamInfoBatchTrans(cb, time_tag, jsonExtension) {
         return this.team.GetTeamInfoBatchSFTrans(cb, time_tag, jsonExtension);
     }
+    /** 查询给定的一组群ID详细信息
+       * @param tid_list	 群组id列表，最多10个
+       * @param cb	查询给定的一组群ID详细信息的回调模板
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * 816:部分成功
+       * </pre>
+       */
+    getTeaminfoList(tids, cb) {
+        return this.team.GetTeaminfoList(tids, cb);
+    }
 }
-exports.default = NIMTeam;
+exports.NIMTeam = NIMTeam;
+//# sourceMappingURL=team.js.map

package/js/api/team.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"team.js","sourceRoot":"","sources":["../../ts/api/team.ts"],"names":[],"mappings":";;;;;;AAAA,uDAA4B;AAC5B,oDAAwB;AAexB,MAAa,OAAQ,SAAQ,gBAAE,CAAC,YAAY;IAExC;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,gBAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,aAAa;IACb,iBAAiB;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,eAAe,CAAC,IAAc,EAC1B,GAAkB,EAClB,oBAA4B,EAC5B,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE,oBAAoB,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;SAiBK;IACL,WAAW,CAAC,GAAW,EACnB,GAAkB,EAClB,oBAA4B,EAC5B,oBAA4B,EAC5B,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,SAAS,CAAC,GAAW,EACjB,GAAkB,EAClB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;SAaK;IACL,UAAU,CAAC,GAAW,EAClB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;SAWK;IACL,YAAY,CAAC,GAAW,EACpB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;SAYK;IACL,mBAAmB,CAAC,GAAW,EAC3B,IAAc,EACd,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;SAgBK;IACL,cAAc,CAAC,GAAW,EACtB,MAAc,EACd,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;SAgBK;IACL,kBAAkB,CAAC,GAAW,EAC1B,WAAmB,EACnB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,oBAAoB,CAAC,GAAW,EAC5B,WAAmB,EACnB,MAAc,EACd,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;SAaK;IACL,gBAAgB,CAAC,GAAW,EACxB,GAAkB,EAClB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;SAaK;IACL,mBAAmB,CAAC,GAAW,EAC3B,GAAkB,EAClB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,iBAAiB,CAAC,GAAW,EACzB,UAAkB,EAClB,OAAgB,EAChB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;;;SAYK;IACL,qBAAqB,CAAC,IAAwB,EAC1C,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;SAYK;IACL,oBAAoB,CAAC,IAAwB,EACzC,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;SAaK;IACL,qBAAqB,CAAC,GAAW,EAC7B,SAAiB,EACjB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;SAcK;IACL,qBAAqB,CAAC,GAAW,EAC7B,SAAiB,EACjB,MAAc,EACd,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACtF,CAAC;IAED;;;;SAIK;IACL,oBAAoB,CAAC,EAA2B,EAAE,aAAqB;QACnE,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IAC7D,CAAC;IAED;;;;SAIK;IACL,wBAAwB,CAAC,EAA+B,EAAE,aAAqB;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IACjE,CAAC;IAED;;;;SAIK;IACL,0BAA0B,CAAC,EAAiC,EAAE,aAAqB;QAC/E,OAAO,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;SAWK;IACL,qBAAqB,CAAC,GAAW,EAAE,EAA4B,EAAE,aAAqB;QAClF,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;SAMK;IACL,oBAAoB,CAAC,GAAW,EAC5B,EAAU,EACV,EAA2B,EAC3B,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAED;;;;;SAKK;IACL,kBAAkB,CAAC,GAAW,EAAE,EAAyB,EAAE,aAAqB;QAC5E,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;SAUK;IACL,wBAAwB,CAAC,GAAW,EAAE,EAAqB,EAAE,aAAqB;QAC9E,OAAO,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;SAeK;IACL,eAAe,CAAC,GAAW,EACvB,SAAiB,EACjB,QAAiB,EACjB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;SAWK;IACL,wBAAwB,CAAC,GAAW,EAAE,EAAkC,EAAE,aAAqB;QAC3F,OAAO,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;SAWK;IACL,SAAS,CAAC,GAAW,EACjB,QAAiB,EACjB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;SAWK;IACL,cAAc,CAAC,GAAW,EACtB,IAAsB,EACtB,EAA0B,EAC1B,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;SAYK;IACL,sBAAsB,CAAC,GAAW,EAC9B,GAAc,EACd,MAAqB,EACrB,EAAqB,EACrB,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;SASK;IACL,uBAAuB,CAAC,GAAW,EAC/B,OAAsB,EACtB,EAAmC;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;SAKK;IACL,2BAA2B,CAAC,OAAe,EACvC,EAA0B,EAC1B,aAAqB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;SAOK;IACL,gBAAgB,CAAC,KAAsB,EAAE,EAA4B,EAAE,aAAqB;QACxF,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;;;;SAKK;IACL,qBAAqB,CAAC,EAAmC,EAAE,QAAgB,EAAE,aAAqB;QAC9F,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;SAUK;IACL,eAAe,CAAC,IAAmB,EAAE,EAA2B;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC;CACJ;AAjmBD,0BAimBC"}

package/js/api/tool.js

@@ -3,39 +3,102 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NIMTool = void 0;
+const loader_1 = __importDefault(require("../loader"));
 const events_1 = __importDefault(require("events"));
-const nim_1 = __importDefault(require("./nim"));
 class NIMTool extends events_1.default.EventEmitter {
     constructor() {
         super();
-        this.tool = new nim_1.default.Tool();
+        this.tool = new loader_1.default.NIMTool({ "emit": this.emit.bind(this) });
     }
+    /** 注册全局回调 */
+    initEventHandlers() {
+        return this.tool.InitEventHandlers();
+    }
+    /** 获取SDK里app account对应的app data目录（各个帐号拥有独立的目录，其父目录相同）
+       * @param app_account APP account。如果传入空字符串，则将获取到各个帐号目录的父目录（谨慎删除！）
+       * @return std::string 返回的目录路径(UTF8)
+       */
     getUserAppdataDir(appAccount) {
         return this.tool.GetUserAppdataDir(appAccount);
     }
+    /** 获取SDK里app account对应的具体类型的app data目录（如图片消息文件存放目录，语音消息文件存放目录等），需要调用nim_free_buf(void *data)释放内存
+       * @param app_account APP account。如果传入空字符串，则返回结果为空
+       * @param appdata_type 具体类型的app data。见NIMAppDataType定义
+       * @return std::string返回的目录路径（目录可能未生成，需要app自行判断是否已生成）
+       */
     getSpecificAppdataDir(appAccount, appdataType) {
         return this.tool.GetSpecificAppdataDir(appAccount, appdataType);
     }
+    /** 获取本地存储路径
+       * @return std::string 返回的目录路径(UTF8)
+       */
     getLocalAppdataDir() {
         return this.tool.GetLocalAppdataDir();
     }
+    /** 获取安装目录（SDK DLL所在的当前目录）
+       * @return std::string 返回的目录路径(UTF8)
+       */
     getCurModuleDir() {
         return this.tool.GetCurModuleDir();
     }
-    getMD5(input) {
-        return this.tool.GetMD5(input);
+    /** 计算md5
+       * @param input 需要计算md5的内容
+       * @return std::string 返回的md5
+       */
+    getMd5(input) {
+        return this.tool.GetMd5(input);
     }
-    getFileMD5(filePath) {
-        return this.tool.GetFileMD5(filePath);
+    /** 计算文件的md5
+       * @param file_path 文件完整路径，UTF-8
+       * @return std::string 返回的md5
+       */
+    getFileMd5(filePath) {
+        return this.tool.GetFileMd5(filePath);
     }
-    getUUID() {
-        return this.tool.GetUUID();
+    /** 生成UUID
+       * @return std::string 返回的UUID
+       */
+    getUuid() {
+        return this.tool.GetUuid();
     }
+    /** 语音转文字
+       * @param audio_info 语音信息
+       * @param cb 语音转文字回调
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * 403:没有权限
+       * 414:参数错误
+       * 500:未知错误
+       * 6101:语音转码解析失败
+       * 6102:语音时长过长（超过60s
+       * 6103:服务不可用
+       * 6104:audioUrl不合法
+       * </pre>
+       */
     getAudioTextAsync(audioInfo, cb, jsonExtension) {
         return this.tool.GetAudioTextAsync(audioInfo, cb, jsonExtension);
     }
+    /** 客户端本地反垃圾
+       * @param text 文本内容，UTF-8
+       * @param replace_str 进行替换的字符串，UTF-8
+       * @param lib_name 词库名称，UTF-8
+       * @param callback 回调函数
+       * @return
+       * @note
+       * <pre>
+       * 回调函数ret
+       * 1：敏感词已被替换；
+       * 2：含有敏感词不允许发送；
+       * 3：需要将内容设置在消息结构的反垃圾字段里，由服务器过滤
+       * </pre>
+       */
     filterClientAntispam(text, replaceString, libName, cb) {
         return this.tool.FilterClientAntispam(text, replaceString, libName, cb);
     }
 }
-exports.default = NIMTool;
+exports.NIMTool = NIMTool;
+//# sourceMappingURL=tool.js.map

package/js/api/tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool.js","sourceRoot":"","sources":["../../ts/api/tool.ts"],"names":[],"mappings":";;;;;;AAAA,uDAA4B;AAC5B,oDAAwB;AAGxB,MAAa,OAAQ,SAAQ,gBAAE,CAAC,YAAY;IAExC;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,gBAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,aAAa;IACb,iBAAiB;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACzC,CAAC;IAED;;;SAGK;IACL,iBAAiB,CAAC,UAAkB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;;;SAIK;IACL,qBAAqB,CAAC,UAAkB,EAAE,WAA2B;QACjE,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IACpE,CAAC;IAED;;SAEK;IACL,kBAAkB;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC1C,CAAC;IAED;;SAEK;IACL,eAAe;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC;IAED;;;SAGK;IACL,MAAM,CAAC,KAAa;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;SAGK;IACL,UAAU,CAAC,QAAgB;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;SAEK;IACL,OAAO;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;;SAgBK;IACL,iBAAiB,CAAC,SAAoB,EAAE,EAAwB,EAAE,aAAqB;QACnF,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;SAaK;IACL,oBAAoB,CAAC,IAAY,EAAE,aAAqB,EAAE,OAAe,EAAE,EAAgC;QACvG,OAAO,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;CACJ;AAxGD,0BAwGC"}