node-nim 10.4.0-beta.1 → 10.6.0-beta.0

package/dist/v2/v2_nim_friend_service.js

@@ -12,10 +12,18 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
         super();
         this.instance = new loader_1.default.V2NIMFriendService({ emit: this.emit.bind(this) });
     }
-    /** @brief 添加好友 */
-    /** @param accountId 账号 ID */
-    /** @param params 添加好友参数 */
-    /** @return void */
+    /**
+     * @brief 添加好友
+     * @param accountId 账号 ID
+     * @param params 添加好友参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.addFriend('accountId', {
+     *     addMode: 1
+     * })
+     * ```
+     */
     addFriend(accountId, params) {
         return new Promise((resolve, reject) => {
             this.instance.addFriend(accountId, params, () => {
@@ -25,10 +33,18 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 删除好友 */
-    /** @param accountId 账号 ID */
-    /** @param params 删除好友参数 */
-    /** @return void */
+    /**
+     * @brief 删除好友
+     * @param accountId 账号 ID
+     * @param params 删除好友参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.deleteFriend('accountId', {
+     *     deleteAlias: true
+     * })
+     * ```
+     */
     deleteFriend(accountId, params) {
         return new Promise((resolve, reject) => {
             this.instance.deleteFriend(accountId, params, () => {
@@ -38,9 +54,15 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 接受好友申请 */
-    /** @param application 好友申请 */
-    /** @return void */
+    /**
+     * @brief 接受好友申请
+     * @param application 好友申请
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.acceptAddApplication(application)
+     * ```
+     */
     acceptAddApplication(application) {
         return new Promise((resolve, reject) => {
             this.instance.acceptAddApplication(application, () => {
@@ -50,10 +72,16 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 拒绝好友申请 */
-    /** @param application 好友申请 */
-    /** @param postscript 拒绝理由 */
-    /** @return void */
+    /**
+     * @brief 拒绝好友申请
+     * @param application 好友申请
+     * @param postscript 拒绝理由
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.rejectAddApplication(application, 'reason')
+     * ```
+     */
     rejectAddApplication(application, postscript) {
         return new Promise((resolve, reject) => {
             this.instance.rejectAddApplication(application, postscript, () => {
@@ -63,10 +91,18 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 设置好友信息 */
-    /** @param accountId 账号 ID */
-    /** @param params 设置好友信息参数 */
-    /** @return void */
+    /**
+     * @brief 设置好友信息
+     * @param accountId 账号 ID
+     * @param params 设置好友信息参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.setFriendInfo('accountId', {
+     *     alias: 'alias'
+     * })
+     * ```
+     */
     setFriendInfo(accountId, params) {
         return new Promise((resolve, reject) => {
             this.instance.setFriendInfo(accountId, params, () => {
@@ -76,8 +112,14 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取好友列表 */
-    /** @return void */
+    /**
+     * @brief 获取好友列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getFriendList()
+     * ```
+     */
     getFriendList() {
         return new Promise((resolve, reject) => {
             this.instance.getFriendList((result) => {
@@ -87,9 +129,15 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 根据账号 ID 获取好友信息 */
-    /** @param accountIds 账号 ID 列表 */
-    /** @return void */
+    /**
+     * @brief 根据账号 ID 获取好友信息
+     * @param accountIds 账号 ID 列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getFriendByIds(['accountId1', 'accountId2'])
+     * ```
+     */
     getFriendByIds(accountIds) {
         return new Promise((resolve, reject) => {
             this.instance.getFriendByIds(accountIds, (result) => {
@@ -99,9 +147,15 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 根据账号 ID 检查好友状态 */
-    /** @param accountIds 账号 ID 列表 */
-    /** @return void */
+    /**
+     * @brief 根据账号 ID 检查好友状态
+     * @param accountIds 账号 ID 列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.checkFriend(['accountId1', 'accountId2'])
+     * ```
+     */
     checkFriend(accountIds) {
         return new Promise((resolve, reject) => {
             this.instance.checkFriend(accountIds, (result) => {
@@ -111,9 +165,18 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取申请添加好友信息列表 */
-    /** @param option 查询申请添加好友相关信息参数 */
-    /** @return void */
+    /**
+     * @brief 获取申请添加好友信息列表
+     * @param option 查询申请添加好友相关信息参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getAddApplicationList({
+     *     offset: 0,
+     *     limit: 10
+     * })
+     * ```
+     */
     getAddApplicationList(option) {
         return new Promise((resolve, reject) => {
             this.instance.getAddApplicationList(option, (result) => {
@@ -123,8 +186,14 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 获取申请添加好友未读数量 */
-    /** @return void */
+    /**
+     * @brief 获取申请添加好友未读数量
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getAddApplicationUnreadCount()
+     * ```
+     */
     getAddApplicationUnreadCount() {
         return new Promise((resolve, reject) => {
             this.instance.getAddApplicationUnreadCount((result) => {
@@ -134,8 +203,14 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
-    /** @brief 设置申请添加好友已读 */
-    /** @return void */
+    /**
+     * @brief 设置申请添加好友已读
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.setAddApplicationRead()
+     * ```
+     */
     setAddApplicationRead() {
         return new Promise((resolve, reject) => {
             this.instance.setAddApplicationRead(() => {
@@ -146,9 +221,15 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
         });
     }
     /**
-     * 根据关键字搜索用户信息
+     * @brief 根据关键字搜索用户信息
      * @param option 搜索选项 @see V2NIMFriendSearchOption
-     * @return Promise<Array<V2NIMFriend>>
+     * @returns Promise<Array<V2NIMFriend>>
+     * @example
+     * ```javascript
+     * await v2.friendService.searchFriendByOption({
+     *     keyword: 'keyword'
+     * })
+     * ```
      */
     searchFriendByOption(option) {
         return new Promise((resolve, reject) => {
@@ -164,6 +245,41 @@ class V2NIMFriendService extends eventemitter3_1.EventEmitter {
             });
         });
     }
+    /**
+     * @brief 清空所有添加好友申请
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.friendService.clearAllAddApplication()
+     * ```
+     */
+    clearAllAddApplication() {
+        return new Promise((resolve, reject) => {
+            this.instance.clearAllAddApplication(() => {
+                resolve();
+            }, (error) => {
+                reject(error);
+            });
+        });
+    }
+    /**
+     * @brief 删除添加好友申请
+     * @param application 添加好友申请
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.friendService.deleteAddApplication(application)
+     * ```
+     */
+    deleteAddApplication(application) {
+        return new Promise((resolve, reject) => {
+            this.instance.deleteAddApplication(application, () => {
+                resolve();
+            }, (error) => {
+                reject(error);
+            });
+        });
+    }
 }
 exports.V2NIMFriendService = V2NIMFriendService;
 //# sourceMappingURL=v2_nim_friend_service.js.map

package/dist/v2/v2_nim_friend_service.js.map

@@ -1 +1 @@
-{"version":3,"file":"v2_nim_friend_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_friend_service.ts"],"names":[],"mappings":";;;;;;AAWA,uDAA2B;AAC3B,iDAA4C;AAe5C,kBAAkB;AAClB,MAAa,kBAAmB,SAAQ,4BAAsC;IAE1E;QACI,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9E,CAAC;IACD,kBAAkB;IAClB,6BAA6B;IAC7B,2BAA2B;IAC3B,mBAAmB;IACnB,SAAS,CAAC,SAAiB,EAAE,MAA4B;QACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,SAAS,CACnB,SAAS,EACT,MAAM,EACN,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,kBAAkB;IAClB,6BAA6B;IAC7B,2BAA2B;IAC3B,mBAAmB;IACnB,YAAY,CAAC,SAAiB,EAAE,MAA+B;QAC3D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,YAAY,CACtB,SAAS,EACT,MAAM,EACN,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,8BAA8B;IAC9B,mBAAmB;IACnB,oBAAoB,CAAC,WAAsC;QACvD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAC9B,WAAW,EACX,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,8BAA8B;IAC9B,6BAA6B;IAC7B,mBAAmB;IACnB,oBAAoB,CAAC,WAAsC,EAAE,UAAkB;QAC3E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAC9B,WAAW,EACX,UAAU,EACV,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,6BAA6B;IAC7B,6BAA6B;IAC7B,mBAAmB;IACnB,aAAa,CAAC,SAAiB,EAAE,MAA4B;QACzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,aAAa,CACvB,SAAS,EACT,MAAM,EACN,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,mBAAmB;IACnB,aAAa;QACT,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,aAAa,CACvB,CAAC,MAA0B,EAAE,EAAE;gBAC3B,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,4BAA4B;IAC5B,iCAAiC;IACjC,mBAAmB;IACnB,cAAc,CAAC,UAAyB;QACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,cAAc,CACxB,UAAU,EACV,CAAC,MAA0B,EAAE,EAAE;gBAC3B,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,4BAA4B;IAC5B,iCAAiC;IACjC,mBAAmB;IACnB,WAAW,CAAC,UAAyB;QACjC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,WAAW,CACrB,UAAU,EACV,CAAC,MAA4B,EAAE,EAAE;gBAC7B,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,mCAAmC;IACnC,mBAAmB;IACnB,qBAAqB,CAAC,MAA4C;QAC9D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAC/B,MAAM,EACN,CAAC,MAAuC,EAAE,EAAE;gBACxC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,mBAAmB;IACnB,4BAA4B;QACxB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CACtC,CAAC,MAAc,EAAE,EAAE;gBACf,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,wBAAwB;IACxB,mBAAmB;IACnB,qBAAqB;QACjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAC/B,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,MAA+B;QAChD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,aAAa,GAAG;gBAChB,WAAW,EAAE,IAAI;gBACjB,eAAe,EAAE,KAAK;aACzB,CAAA;YACD,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,aAAa,EAAE,MAAM,CAAC,CAAA;YAC3D,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAC9B,YAAY,EACZ,CAAC,MAA0B,EAAE,EAAE;gBAC3B,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AA1ND,gDA0NC"}
+{"version":3,"file":"v2_nim_friend_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_friend_service.ts"],"names":[],"mappings":";;;;;;AAWA,uDAA2B;AAC3B,iDAA4C;AAgB5C,kBAAkB;AAClB,MAAa,kBAAmB,SAAQ,4BAAiC;IAGvE;QACE,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,kBAAkB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAE,SAAiB,EAAE,MAA4B;QACxD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,CACrB,SAAS,EACT,MAAM,EACN,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAE,SAAiB,EAAE,MAA+B;QAC9D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,YAAY,CACxB,SAAS,EACT,MAAM,EACN,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAE,WAAsC;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAChC,WAAW,EACX,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,oBAAoB,CAAE,WAAsC,EAAE,UAAkB;QAC9E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAChC,WAAW,EACX,UAAU,EACV,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CAAE,SAAiB,EAAE,MAA4B;QAC5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,aAAa,CACzB,SAAS,EACT,MAAM,EACN,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,aAAa;QACX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,aAAa,CACzB,CAAC,MAA0B,EAAE,EAAE;gBAC7B,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CAAE,UAAyB;QACvC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC1B,UAAU,EACV,CAAC,MAA0B,EAAE,EAAE;gBAC7B,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CAAE,UAAyB;QACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,WAAW,CACvB,UAAU,EACV,CAAC,MAA4B,EAAE,EAAE;gBAC/B,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAE,MAA4C;QACjE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACjC,MAAM,EACN,CAAC,MAAuC,EAAE,EAAE;gBAC1C,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,4BAA4B;QAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CACxC,CAAC,MAAc,EAAE,EAAE;gBACjB,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,qBAAqB;QACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACjC,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAAE,MAA+B;QACnD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,aAAa,GAAG;gBAClB,WAAW,EAAE,IAAI;gBACjB,eAAe,EAAE,KAAK;aACvB,CAAA;YACD,IAAI,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,aAAa,EAAE,MAAM,CAAC,CAAA;YAC3D,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAChC,YAAY,EACZ,CAAC,MAA0B,EAAE,EAAE;gBAC7B,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB;QACpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAClC,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAE,WAAsC;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAChC,WAAW,EACX,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAzVD,gDAyVC"}

package/dist/v2/v2_nim_login_service.js

@@ -12,11 +12,15 @@ class V2NIMLoginService extends eventemitter3_1.EventEmitter {
         this.instance = new loader_1.default.V2NIMLoginService({ emit: this.emit.bind(this) });
     }
     /**
-     * 登录接口
+     * @brief 登录接口
      * @param accountId 账号
      * @param token 密码
      * @param option 登录选项
      * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.loginService.login('accountId', 'token', {})
+     * ```
      */
     login(accountId, token, option) {
         return new Promise((resolve, reject) => {
@@ -28,8 +32,12 @@ class V2NIMLoginService extends eventemitter3_1.EventEmitter {
         });
     }
     /**
-     * 登出接口
+     * @brief 登出接口
      * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.loginService.logout()
+     * ```
      */
     logout() {
         return new Promise((resolve, reject) => {
@@ -41,30 +49,58 @@ class V2NIMLoginService extends eventemitter3_1.EventEmitter {
         });
     }
     /**
-     * 获取当前登录用户
+     * @brief 获取当前登录用户
      * @returns string 当前登录用户
+     * @example
+     * ```javascript
+     * const user = v2.loginService.getLoginUser()
+     * ```
      */
     getLoginUser() {
         return this.instance.getLoginUser();
     }
     /**
-     * 获取登录状态
+     * @brief 获取登录状态
      * @returns V2NIMLoginStatus 登录状态
+     * @example
+     * ```javascript
+     * const status = v2.loginService.getLoginStatus()
+     * ```
      */
     getLoginStatus() {
         return this.instance.getLoginStatus();
     }
     /**
-     * 获取登录客户端列表
+     * @brief 获取登录客户端列表
      * @returns V2NIMLoginClient[] 登录客户端列表
+     * @example
+     * ```javascript
+     * const clients = v2.loginService.getLoginClients()
+     * ```
      */
     getLoginClients() {
         return this.instance.getLoginClients();
     }
     /**
-     * 踢掉登录客户端下线
+     * @brief 获取当前登录客户端
+     * @returns V2NIMLoginClient 当前登录客户端
+     * @example
+     * ```javascript
+     * const client = v2.loginService.getCurrentLoginClient()
+     * ```
+     */
+    getCurrentLoginClient() {
+        return this.instance.getCurrentLoginClient();
+    }
+    /**
+     * @brief 踢掉登录客户端下线
      * @param client 登录客户端
      * @returns Promise<void>
+     * @example
+     * ```javascript
+     * const otherClients = v2.loginService.getLoginClients()
+     * await v2.loginService.kickOffline(otherClients[0])
+     * ```
      */
     kickOffline(client) {
         return new Promise((resolve, reject) => {
@@ -76,28 +112,47 @@ class V2NIMLoginService extends eventemitter3_1.EventEmitter {
         });
     }
     /**
-     * 获取被踢下线原因
+     * @brief 获取被踢下线原因
      * @returns V2NIMKickedOfflineDetail 被踢下线原因
+     * @example
+     * ```javascript
+     * const detail = v2.loginService.getKickedOfflineDetail()
+     * ```
      */
     getKickedOfflineDetail() {
         return this.instance.getKickedOfflineDetail();
     }
-    /* 获取连接状态
+    /**
+     * @brief 获取连接状态
      * @returns V2NIMConnectStatus 连接状态
+     * @example
+     * ```javascript
+     * const status = v2.loginService.getConnectStatus()
+     * ```
      */
     getConnectStatus() {
         return this.instance.getConnectStatus();
     }
     /**
-     * 获取数据同步状态
+     * @brief 获取数据同步状态
      * @returns V2NIMDataSyncDetail[]  数据同步状态列表
+     * @example
+     * ```javascript
+     * const details = v2.loginService.getDataSync()
+     * ```
      */
     getDataSync() {
         return this.instance.getDataSync();
     }
-    /** @brief 获取聊天室 link 地址 */
-    /** @param roomId 聊天室 ID */
-    /** @return void */
+    /**
+     * @brief 获取聊天室 link 地址
+     * @param roomId 聊天室 ID
+     * @returns Promise<Array<string>>
+     * @example
+     * ```javascript
+     * const linkAddresses = await v2.loginService.getChatroomLinkAddress('roomId')
+     * ```
+     */
     getChatroomLinkAddress(roomId) {
         return new Promise((resolve, reject) => {
             this.instance.getChatroomLinkAddress(roomId, (linkAddresses) => {
@@ -108,9 +163,13 @@ class V2NIMLoginService extends eventemitter3_1.EventEmitter {
         });
     }
     /**
-     * 设置获取重连延时回调
+     * @brief 设置获取重连延时回调
      * @param provider 获取重连延时回调
      * @returns void
+     * @example
+     * ```javascript
+     * v2.loginService.setReconnectDelayProvider(provider)
+     * ```
      */
     setReconnectDelayProvider(provider) {
         this.instance.setReconnectDelayProvider(provider);

package/dist/v2/v2_nim_login_service.js.map

@@ -1 +1 @@
-{"version":3,"file":"v2_nim_login_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_login_service.ts"],"names":[],"mappings":";;;;;;AACA,uDAA2B;AAC3B,iDAA4C;AAsB5C,MAAa,iBAAkB,SAAQ,4BAAqC;IAExE;QACI,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC7E,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,SAAiB,EAAE,KAAa,EAAE,MAAwB;QAC5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CACf,SAAS,EACT,KAAK,EACL,MAAM,EACN,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;OAGG;IACH,MAAM;QACF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAChB,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;OAGG;IACH,YAAY;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAA;IACvC,CAAC;IAED;;;OAGG;IACH,cAAc;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAA;IACzC,CAAC;IAED;;;OAGG;IACH,eAAe;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAAwB;QAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,WAAW,CACrB,MAAM,EACN,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;OAGG;IACH,sBAAsB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAA;IACjD,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAA;IAC3C,CAAC;IAED;;;OAGG;IACH,WAAW;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAA;IACtC,CAAC;IAED,2BAA2B;IAC3B,2BAA2B;IAC3B,mBAAmB;IACnB,sBAAsB,CAAC,MAAc;QACjC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAChC,MAAM,EACN,CAAC,aAA4B,EAAE,EAAE;gBAC7B,OAAO,CAAC,aAAa,CAAC,CAAA;YAC1B,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED;;;;OAIG;IACH,yBAAyB,CAAC,QAAqC;QAC3D,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAA;IACrD,CAAC;CACJ;AAzID,8CAyIC"}
+{"version":3,"file":"v2_nim_login_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_login_service.ts"],"names":[],"mappings":";;;;;;AAOA,uDAA2B;AAC3B,iDAA4C;AA6B5C,MAAa,iBAAkB,SAAQ,4BAAgC;IAGrE;QACE,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC3E,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAE,SAAiB,EAAE,KAAa,EAAE,MAAwB;QAC/D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,KAAK,CACjB,SAAS,EACT,KAAK,EACL,MAAM,EACN,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,MAAM;QACJ,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAClB,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAA;IACrC,CAAC;IAED;;;;;;;OAOG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAA;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAA;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,qBAAqB,EAAE,CAAA;IAC9C,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CAAE,MAAwB;QACnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,WAAW,CACvB,MAAM,EACN,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAA;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAA;IACzC,CAAC;IAED;;;;;;;OAOG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAA;IACpC,CAAC;IAED;;;;;;;;OAQG;IACH,sBAAsB,CAAE,MAAc;QACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAClC,MAAM,EACN,CAAC,aAA4B,EAAE,EAAE;gBAC/B,OAAO,CAAC,aAAa,CAAC,CAAA;YACxB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,yBAAyB,CAAE,QAAqC;QAC9D,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAA;IACnD,CAAC;CACF;AAvMD,8CAuMC"}