node-nim 10.5.2 → 10.6.0

package/types/v2/v2_nim_conversation_service.d.ts

@@ -1,7 +1,7 @@
 import { V2NIMError, V2NIMConversation, V2NIMConversationFilter, V2NIMConversationOperationResult, V2NIMConversationUpdate, V2NIMConversationResult, V2NIMConversationOption } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
 import { V2NIMConversationType } from 'ts/v2_def/v2_nim_enum_def';
-export declare interface V2NIMConversationServiceEvents {
+export declare interface V2NIMConversationListener {
     /** 会话同步开始通知 */
     syncStarted: [];
     /** 会话同步完成通知 */
@@ -21,101 +21,223 @@ export declare interface V2NIMConversationServiceEvents {
     /** 同账号多端标记会话 ACK 通知时间戳变更 */
     conversationReadTimeUpdated: [string, number];
 }
-export declare class V2NIMConversationService extends EventEmitter<V2NIMConversationServiceEvents> {
+export declare class V2NIMConversationService extends EventEmitter<V2NIMConversationListener> {
     instance: any;
     constructor();
-    /** @brief 创建空会话
+    /**
+     * @brief 创建空会话
      * @param conversationId 会话 ID
+     * @returns V2NIMConversation
+     * @example
+     * ```javascript
+     * const conversation = await v2.conversationService.createConversation('conversation1')
+     * ```
      */
     createConversation(conversationId: string): Promise<V2NIMConversation>;
-    /** @brief 删除会话
+    /**
+     * @brief 删除会话
      * @param conversationId 会话 ID
      * @param clearMessage 是否清除会话消息
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.deleteConversation('conversation1', true)
+     * ```
      */
     deleteConversation(conversationId: string, clearMessage: boolean): Promise<void>;
-    /** @brief 批量删除会话
+    /**
+     * @brief 批量删除会话
      * @param conversationIds 会话ID列表
      * @param clearMessage 是否清除会话消息
+     * @returns Array<V2NIMConversationOperationResult>
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.deleteConversationListByIds(['conversation1', 'conversation2'], true)
+     * ```
      */
     deleteConversationListByIds(conversationIds: string[], clearMessage: boolean): Promise<Array<V2NIMConversationOperationResult>>;
-    /** @brief 置顶会话
+    /**
+     * @brief 置顶会话
      * @param conversationId 会话 ID
      * @param stickTop 是否置顶
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.stickTopConversation('conversation1', true)
+     * ```
      */
     stickTopConversation(conversationId: string, stickTop: boolean): Promise<void>;
-    /** @brief 更新会话
+    /**
+     * @brief 更新会话
      * @param conversationId 会话 ID
      * @param updateInfo 更新参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.updateConversation('conversation1', { name: 'newName' })
+     * ```
      */
     updateConversation(conversationId: string, updateInfo: V2NIMConversationUpdate): Promise<void>;
-    /** @brief 更新会话本地扩展
+    /**
+     * @brief 更新会话本地扩展
      * @param conversationId 会话 ID
      * @param localExtension 本地扩展
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.updateConversationLocalExtension('conversation1', 'newExtension')
+     * ```
      */
     updateConversationLocalExtension(conversationId: string, localExtension: string): Promise<void>;
     /** @brief 获取会话
      * @param conversationId 会话 ID
+     * @returns V2NIMConversation
+     * @example
+     * ```javascript
+     * const conversation = await v2.conversationService.getConversation('conversation1')
+     * ```
      */
     getConversation(conversationId: string): Promise<V2NIMConversation>;
-    /** @brief 分页获取会话列表
+    /**
+     * @brief 分页获取会话列表
      * @param offset 分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
      * @param limit 分页数量
+     * @returns V2NIMConversationResult
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.getConversationList(0, 10)
+     * ```
      */
     getConversationList(offset: number, limit: number): Promise<V2NIMConversationResult>;
-    /** @brief 根据会话ID获取会话列表
+    /**
+     * @brief 根据会话ID获取会话列表
      * @param conversationIds 会话ID列表
+     * @returns Array<V2NIMConversation>
+     * @example
+     * ```javascript
+     * const list = await v2.conversationService.getConversationListByIds(['conversation1', 'conversation2'])
+     * ```
      */
     getConversationListByIds(conversationIds: string[]): Promise<Array<V2NIMConversation>>;
-    /** @brief 根据条件筛选分页获取会话列表
+    /**
+     * @brief 根据条件筛选分页获取会话列表
      * @param offset 分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
      * @param limit 分页数量
      * @param option 查询参数
+     * @returns V2NIMConversationResult
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.getConversationListByOption(0, 10, {
+     *   conversationTypes: [1, 2]
+     * })
+     * ```
      */
     getConversationListByOption(offset: number, limit: number, option: V2NIMConversationOption): Promise<V2NIMConversationResult>;
-    /** @brief 获取会话未读总数
-     * @param conversationId 会话 ID
-     * @return uint32_t 未读总数
+    /**
+     * @brief 获取会话未读总数
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.conversationService.getTotalUnreadCount()
+     * ```
      */
     getTotalUnreadCount(): number;
     /** @brief 根据会话 ID 列表获取未读总数
      * @param conversationIds 会话 ID 列表
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.conversationService.getUnreadCountByIds(['conversation1', 'conversation2'])
+     * ```
      */
     getUnreadCountByIds(conversationIds: string[]): Promise<number>;
-    /** @brief 根据过滤条件获取会话未读总数
+    /**
+     * @brief 根据过滤条件获取会话未读总数
      * @param filter 过滤条件
+     * @returns number
+     * @example
+     * ```javascript
+     * const count = await v2.conversationService.getUnreadCountByFilter({ conversationTypes: [1, 2] })
+     * ```
      */
     getUnreadCountByFilter(filter: V2NIMConversationFilter): Promise<number>;
-    /** @brief 清除会话总未读数
+    /**
+     * @brief 清除会话总未读数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.clearTotalUnreadCount()
+     * ```
      */
     clearTotalUnreadCount(): Promise<void>;
-    /** @brief 根据会话 ID 列表清除会话未读数
+    /**
+     * @brief 根据会话 ID 列表清除会话未读数
      * @param conversationIds 会话 ID 列表
+     * @returns Array<V2NIMConversationOperationResult>
+     * @example
+     * ```javascript
+     * const result = await v2.conversationService.clearUnreadCountByIds(['conversation1', 'conversation2'])
+     * ```
      */
     clearUnreadCountByIds(conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
-    /** @brief 根据会话类型清除会话未读数
+    /**
+     * @brief 根据会话类型清除会话未读数
      * @param conversationTypes 会话类型列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.clearUnreadCountByTypes([1, 2])
+     * ```
      */
     clearUnreadCountByTypes(conversationTypes: V2NIMConversationType[]): Promise<void>;
-    /** @brief 根据会话分组清除会话未读数
+    /**
+     * @brief 根据会话分组清除会话未读数
      * @param groupId 会话分组ID
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.conversationService.clearUnreadCountByGroupId('groupId')
+     * ```
      */
     clearUnreadCountByGroupId(groupId: string): Promise<void>;
-    /** @brief 标记会话已读时间戳 */
-    /** @param conversationId 要标记的会话 ID */
-    /** @return void */
+    /**
+     * @brief 标记会话已读时间戳
+     * @param conversationId 要标记的会话 ID
+     * @returns number
+     * @example
+     * ```javascript
+     * const time = await v2.conversationService.markConversationRead('conversation1')
+     * ```
+     */
     markConversationRead(conversationId: string): Promise<number>;
-    /** 获取会话已读时间戳 */
-    /** @param conversationId 会话 ID */
-    /** @return Promise<number> 时间戳 */
+    /**
+     * @brief 获取会话已读时间戳
+     * @param conversationId 会话 ID
+     * @returns Promise<number> 时间戳
+     * @example
+     * ```javascript
+     * const time = await v2.conversationService.getConversationReadTime('conversation1')
+     * ```
+     */
     getConversationReadTime(conversationId: string): Promise<number>;
-    /** @brief 订阅指定过滤条件的会话未读数
+    /**
+     * @brief 订阅指定过滤条件的会话未读数
      * @param filter 过滤条件
-     * @return void
+     * @returns null | V2NIMError
+     * @example
+     * ```javascript
+     * await v2.conversationService.subscribeUnreadCountByFilter({ conversationTypes: [1, 2] })
+     * ```
      */
     subscribeUnreadCountByFilter(filter: V2NIMConversationFilter): null | V2NIMError;
-    /** @brief 取消订阅指定过滤条件的会话未读数
+    /**
+     * @brief 取消订阅指定过滤条件的会话未读数
      * @param filter 过滤条件
-     * @return void
+     * @returns null | V2NIMError
+     * @example
+     * ```javascript
+     * await v2.conversationService.unsubscribeUnreadCountByFilter({ conversationTypes: [1, 2] })
+     * ```
      */
     unsubscribeUnreadCountByFilter(filter: V2NIMConversationFilter): null | V2NIMError;
 }

package/types/v2/v2_nim_friend_service.d.ts

@@ -1,7 +1,7 @@
-import { V2NIMFriend, V2NIMFriendAddApplication, V2NIMFriendAddParams, V2NIMFriendDeleteParams, V2NIMFriendSetParams, V2NIMFriendAddApplicationQueryOption, V2NIMFriendAddApplicationResult, V2NIMFriendSearchOption } from 'ts/v2_def/v2_nim_struct_def';
+import { V2NIMFriend, V2NIMFriendAddApplication, V2NIMFriendAddApplicationQueryOption, V2NIMFriendAddApplicationResult, V2NIMFriendAddParams, V2NIMFriendDeleteParams, V2NIMFriendSearchOption, V2NIMFriendSetParams } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
 import { V2NIMFriendDeletionType } from 'ts/v2_def/v2_nim_enum_def';
-export declare interface V2NIMFriendServiceEvents {
+export declare interface V2NIMFriendListener {
     /** 添加好友 */
     friendAdded: [V2NIMFriend];
     /** 删除好友 */
@@ -14,58 +14,158 @@ export declare interface V2NIMFriendServiceEvents {
     friendInfoChanged: [V2NIMFriend];
 }
 /** @brief 好友服务 */
-export declare class V2NIMFriendService extends EventEmitter<V2NIMFriendServiceEvents> {
+export declare class V2NIMFriendService extends EventEmitter<V2NIMFriendListener> {
     instance: any;
     constructor();
-    /** @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: string, params: V2NIMFriendAddParams): Promise<void>;
-    /** @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: string, params: V2NIMFriendDeleteParams): Promise<void>;
-    /** @brief 接受好友申请 */
-    /** @param application 好友申请 */
-    /** @return void */
+    /**
+     * @brief 接受好友申请
+     * @param application 好友申请
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.acceptAddApplication(application)
+     * ```
+     */
     acceptAddApplication(application: V2NIMFriendAddApplication): Promise<void>;
-    /** @brief 拒绝好友申请 */
-    /** @param application 好友申请 */
-    /** @param postscript 拒绝理由 */
-    /** @return void */
+    /**
+     * @brief 拒绝好友申请
+     * @param application 好友申请
+     * @param postscript 拒绝理由
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.rejectAddApplication(application, 'reason')
+     * ```
+     */
     rejectAddApplication(application: V2NIMFriendAddApplication, postscript: String): Promise<void>;
-    /** @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: string, params: V2NIMFriendSetParams): Promise<void>;
-    /** @brief 获取好友列表 */
-    /** @return void */
+    /**
+     * @brief 获取好友列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getFriendList()
+     * ```
+     */
     getFriendList(): Promise<Array<V2NIMFriend>>;
-    /** @brief 根据账号 ID 获取好友信息 */
-    /** @param accountIds 账号 ID 列表 */
-    /** @return void */
+    /**
+     * @brief 根据账号 ID 获取好友信息
+     * @param accountIds 账号 ID 列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getFriendByIds(['accountId1', 'accountId2'])
+     * ```
+     */
     getFriendByIds(accountIds: Array<string>): Promise<Array<V2NIMFriend>>;
-    /** @brief 根据账号 ID 检查好友状态 */
-    /** @param accountIds 账号 ID 列表 */
-    /** @return void */
+    /**
+     * @brief 根据账号 ID 检查好友状态
+     * @param accountIds 账号 ID 列表
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.checkFriend(['accountId1', 'accountId2'])
+     * ```
+     */
     checkFriend(accountIds: Array<string>): Promise<Map<string, boolean>>;
-    /** @brief 获取申请添加好友信息列表 */
-    /** @param option 查询申请添加好友相关信息参数 */
-    /** @return void */
+    /**
+     * @brief 获取申请添加好友信息列表
+     * @param option 查询申请添加好友相关信息参数
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getAddApplicationList({
+     *     offset: 0,
+     *     limit: 10
+     * })
+     * ```
+     */
     getAddApplicationList(option: V2NIMFriendAddApplicationQueryOption): Promise<V2NIMFriendAddApplicationResult>;
-    /** @brief 获取申请添加好友未读数量 */
-    /** @return void */
+    /**
+     * @brief 获取申请添加好友未读数量
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.getAddApplicationUnreadCount()
+     * ```
+     */
     getAddApplicationUnreadCount(): Promise<number>;
-    /** @brief 设置申请添加好友已读 */
-    /** @return void */
+    /**
+     * @brief 设置申请添加好友已读
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.friendService.setAddApplicationRead()
+     * ```
+     */
     setAddApplicationRead(): Promise<void>;
     /**
-     * 根据关键字搜索用户信息
+     * @brief 根据关键字搜索用户信息
      * @param option 搜索选项 @see V2NIMFriendSearchOption
-     * @return Promise<Array<V2NIMFriend>>
+     * @returns Promise<Array<V2NIMFriend>>
+     * @example
+     * ```javascript
+     * await v2.friendService.searchFriendByOption({
+     *     keyword: 'keyword'
+     * })
+     * ```
      */
     searchFriendByOption(option: V2NIMFriendSearchOption): Promise<Array<V2NIMFriend>>;
+    /**
+     * @brief 清空所有添加好友申请
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.friendService.clearAllAddApplication()
+     * ```
+     */
+    clearAllAddApplication(): Promise<void>;
+    /**
+     * @brief 删除添加好友申请
+     * @param application 添加好友申请
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.friendService.deleteAddApplication(application)
+     * ```
+     */
+    deleteAddApplication(application: V2NIMFriendAddApplication): Promise<void>;
 }

package/types/v2/v2_nim_login_service.d.ts

@@ -2,7 +2,7 @@ import { V2NIMDataSyncDetail, V2NIMError, V2NIMKickedOfflineDetail, V2NIMLoginCl
 import { EventEmitter } from 'eventemitter3';
 import { V2NIMReconnectDelayProvider } from 'ts/v2_def/v2_nim_callback_def';
 import { V2NIMConnectStatus, V2NIMDataSyncState, V2NIMDataSyncType, V2NIMLoginClientChange, V2NIMLoginStatus } from 'ts/v2_def/v2_nim_enum_def';
-export declare interface V2NIMLoginServiceEvents {
+export declare interface V2NIMLoginListener {
     /** 登录状态变更回调 */
     loginStatus: [V2NIMLoginStatus];
     /** 登录失败回调 */
@@ -20,67 +20,122 @@ export declare interface V2NIMLoginServiceEvents {
     /** 数据同步回调 */
     dataSync: [V2NIMDataSyncType, V2NIMDataSyncState, V2NIMError | null];
 }
-export declare class V2NIMLoginService extends EventEmitter<V2NIMLoginServiceEvents> {
+export declare class V2NIMLoginService extends EventEmitter<V2NIMLoginListener> {
     instance: any;
     constructor();
     /**
-     * 登录接口
+     * @brief 登录接口
      * @param accountId 账号
      * @param token 密码
      * @param option 登录选项
      * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.loginService.login('accountId', 'token', {})
+     * ```
      */
     login(accountId: string, token: string, option: V2NIMLoginOption): Promise<void>;
     /**
-     * 登出接口
+     * @brief 登出接口
      * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.loginService.logout()
+     * ```
      */
     logout(): Promise<void>;
     /**
-     * 获取当前登录用户
+     * @brief 获取当前登录用户
      * @returns string 当前登录用户
+     * @example
+     * ```javascript
+     * const user = v2.loginService.getLoginUser()
+     * ```
      */
     getLoginUser(): string;
     /**
-     * 获取登录状态
+     * @brief 获取登录状态
      * @returns V2NIMLoginStatus 登录状态
+     * @example
+     * ```javascript
+     * const status = v2.loginService.getLoginStatus()
+     * ```
      */
     getLoginStatus(): V2NIMLoginStatus;
     /**
-     * 获取登录客户端列表
+     * @brief 获取登录客户端列表
      * @returns V2NIMLoginClient[] 登录客户端列表
+     * @example
+     * ```javascript
+     * const clients = v2.loginService.getLoginClients()
+     * ```
      */
     getLoginClients(): V2NIMLoginClient[];
     /**
-     * 获取当前登录客户端
+     * @brief 获取当前登录客户端
      * @returns V2NIMLoginClient 当前登录客户端
+     * @example
+     * ```javascript
+     * const client = v2.loginService.getCurrentLoginClient()
+     * ```
      */
     getCurrentLoginClient(): V2NIMLoginClient;
     /**
-     * 踢掉登录客户端下线
+     * @brief 踢掉登录客户端下线
      * @param client 登录客户端
      * @returns Promise<void>
+     * @example
+     * ```javascript
+     * const otherClients = v2.loginService.getLoginClients()
+     * await v2.loginService.kickOffline(otherClients[0])
+     * ```
      */
     kickOffline(client: V2NIMLoginClient): Promise<void>;
     /**
-     * 获取被踢下线原因
+     * @brief 获取被踢下线原因
      * @returns V2NIMKickedOfflineDetail 被踢下线原因
+     * @example
+     * ```javascript
+     * const detail = v2.loginService.getKickedOfflineDetail()
+     * ```
      */
     getKickedOfflineDetail(): V2NIMKickedOfflineDetail;
+    /**
+     * @brief 获取连接状态
+     * @returns V2NIMConnectStatus 连接状态
+     * @example
+     * ```javascript
+     * const status = v2.loginService.getConnectStatus()
+     * ```
+     */
     getConnectStatus(): V2NIMConnectStatus;
     /**
-     * 获取数据同步状态
+     * @brief 获取数据同步状态
      * @returns V2NIMDataSyncDetail[]  数据同步状态列表
+     * @example
+     * ```javascript
+     * const details = v2.loginService.getDataSync()
+     * ```
      */
     getDataSync(): V2NIMDataSyncDetail[];
-    /** @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: string): Promise<Array<string>>;
     /**
-     * 设置获取重连延时回调
+     * @brief 设置获取重连延时回调
      * @param provider 获取重连延时回调
      * @returns void
+     * @example
+     * ```javascript
+     * v2.loginService.setReconnectDelayProvider(provider)
+     * ```
      */
     setReconnectDelayProvider(provider: V2NIMReconnectDelayProvider): void;
 }