node-nim 10.5.2 → 10.6.0

package/types/v2/v2_nim_setting_service.d.ts

@@ -1,54 +1,106 @@
 import { V2NIMDndConfig } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
 import { V2NIMP2PMessageMuteMode, V2NIMTeamMessageMuteMode, V2NIMTeamType } from 'ts/v2_def/v2_nim_enum_def';
-export declare interface V2NIMSettingServiceEvents {
+export declare interface V2NIMSettingListener {
     /** 群组消息免打扰回调 */
     teamMessageMuteModeChanged: [string, V2NIMTeamType, V2NIMTeamMessageMuteMode];
     /** 点对点消息免打扰回调 */
     p2pMessageMuteModeChanged: [string, V2NIMP2PMessageMuteMode];
 }
 /** @brief 设置服务 */
-export declare class V2NIMSettingService extends EventEmitter<V2NIMSettingServiceEvents> {
+export declare class V2NIMSettingService extends EventEmitter<V2NIMSettingListener> {
     instance: any;
     constructor();
-    /** @brief 获取会话消息免打扰状态 */
-    /** @param conversationId 会话 ID */
-    /** @return boolean 会话消息免打扰状态 */
+    /**
+     * @brief 获取会话消息免打扰状态
+     * @param conversationId 会话 ID
+     * @returns boolean 会话消息免打扰状态
+     * @example
+     * ```javascript
+     * const status = v2.settingService.getConversationMuteStatus(conversationId)
+     * ```
+     */
     getConversationMuteStatus(conversationId: string): boolean;
-    /** @brief 设置群消息免打扰模式 */
-    /** @param teamId 群组 ID */
-    /** @param teamType 群组类型 */
-    /** @param muteMode 免打扰模式 */
-    /** @return void */
+    /**
+     * @brief 设置群消息免打扰模式
+     * @param teamId 群组 ID
+     * @param teamType 群组类型
+     * @param muteMode 免打扰模式
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.settingService.setTeamMessageMuteMode(teamId, teamType, muteMode)
+     * ```
+     */
     setTeamMessageMuteMode(teamId: string, teamType: V2NIMTeamType, muteMode: V2NIMTeamMessageMuteMode): Promise<void>;
-    /** @brief 获取群消息免打扰模式 */
-    /** @param teamId 群组 ID */
-    /** @param teamType 群组类型 */
-    /** @return V2NIMTeamMessageMuteMode 群消息免打扰模式 */
+    /**
+     * @brief 获取群消息免打扰模式
+     * @param teamId 群组 ID
+     * @param teamType 群组类型
+     * @returns V2NIMTeamMessageMuteMode 群消息免打扰模式
+     * @example
+     * ```javascript
+     * const muteMode = v2.settingService.getTeamMessageMuteMode(teamId, teamType)
+     * ```
+     */
     getTeamMessageMuteMode(teamId: string, teamType: V2NIMTeamType): V2NIMTeamMessageMuteMode;
-    /** @brief 设置点对点消息免打扰模式 */
-    /** @param accountId 账号 */
-    /** @param muteMode 免打扰模式 */
-    /** @return void */
+    /**
+     * @brief 设置点对点消息免打扰模式
+     * @param accountId 账号
+     * @param muteMode 免打扰模式
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.settingService.setP2PMessageMuteMode(accountId, muteMode)
+     * ```
+     */
     setP2PMessageMuteMode(accountId: string, muteMode: V2NIMP2PMessageMuteMode): Promise<void>;
-    /** @brief 获取点对点消息免打扰模式 */
-    /** @param accountId 账号 */
-    /** @return V2NIMP2PMessageMuteMode 点对点消息免打扰模式 */
+    /**
+     * @brief 获取点对点消息免打扰模式
+     * @param accountId 账号
+     * @returns V2NIMP2PMessageMuteMode 点对点消息免打扰模式
+     * @example
+     * ```javascript
+     * const muteMode = v2.settingService.getP2PMessageMuteMode(accountId)
+     * ```
+     */
     getP2PMessageMuteMode(accountId: string): V2NIMP2PMessageMuteMode;
-    /** @brief 获取点对点消息免打扰列表 */
-    /** @return Array<string> 点对点消息免打扰列表 */
+    /**
+     * @brief 获取点对点消息免打扰列表
+     * @returns Array<string> 点对点消息免打扰列表
+     * @example
+     * ```javascript
+     * const muteList = await v2.settingService.getP2PMessageMuteList()
+     * ```
+     */
     getP2PMessageMuteList(): Promise<Array<string>>;
-    /** @brief 设置当桌面端在线时, 移动端是否需要推送 */
-    /** @param need 是否需要推送 */
-    /** @return void */
+    /**
+     * @brief 设置当桌面端在线时, 移动端是否需要推送
+     * @param need 是否需要推送
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.settingService.setPushMobileOnDesktopOnline(need)
+     * ```
+     */
     setPushMobileOnDesktopOnline(need: boolean): Promise<void>;
-    /** @brief 设置免打扰与详情显示 */
-    /** @param config 是否需要推送 */
-    /** @return void */
+    /**
+     * @brief 设置免打扰与详情显示
+     * @param config 免打扰配置
+     * @returns void
+     * @example
+     * ```javascript
+     * await v2.settingService.setDndConfig(config)
+     * ```
+     */
     setDndConfig(config: V2NIMDndConfig): Promise<void>;
     /**
-     * 读取免打扰与详情显示接口
-     * @returns V2NIMDndConfig 设置免打扰配置
+     * @brief 读取免打扰与详情显示接口
+     * @returns V2NIMDndConfig 免打扰配置
+     * @example
+     * ```javascript
+     * const config = v2.settingService.getDndConfig()
+     * ```
      */
     getDndConfig(): V2NIMDndConfig;
 }

package/types/v2/v2_nim_signalling_service.d.ts

@@ -1,68 +1,196 @@
 import { V2NIMSignallingCallParams, V2NIMSignallingChannelInfo, V2NIMSignallingRoomInfo, V2NIMSignallingCallResult, V2NIMSignallingCallSetupParams, V2NIMSignallingCallSetupResult, V2NIMSignallingJoinParams, V2NIMSignallingInviteParams, V2NIMSignallingCancelInviteParams, V2NIMSignallingRejectInviteParams, V2NIMSignallingAcceptInviteParams, V2NIMSignallingEvent } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
-export declare interface V2NIMSignallingServiceEvents {
+export declare interface V2NIMSignallingListener {
     onlineEvent: [V2NIMSignallingEvent];
     offlineEvent: [V2NIMSignallingEvent[]];
     multiClientEvent: [V2NIMSignallingEvent];
     syncRoomInfoList: [V2NIMSignallingRoomInfo[]];
 }
-export declare class V2NIMSignallingService extends EventEmitter<V2NIMSignallingServiceEvents> {
+export declare class V2NIMSignallingService extends EventEmitter<V2NIMSignallingListener> {
     instance: any;
     constructor();
-    /** @brief 直接呼叫对方加入房间 */
-    /** @param params 呼叫参数 */
-    /** @return Promise<V2NIMSignallingCallResult> */
+    /**
+     * @brief 直接呼叫对方加入房间
+     * @param params 呼叫参数
+     * @returns Promise<V2NIMSignallingCallResult>
+     * @example
+     * ```javascript
+     * const result = await v2.signallingService.call({
+     *     calleeAccountId: 'calleeAccountId',
+     *     requestId: 'requestId',
+     *     channelType: 1,
+     *     channelName: 'channelName',
+     *     channelExtension: 'channelExtension',
+     *     serverExtension: 'serverExtension',
+     *     signallingConfig: {
+     *         // ...
+     *     },
+     *     rtcConfig: {
+     *         // ...
+     *     }
+     * })
+     * ```
+     */
     call(params: V2NIMSignallingCallParams): Promise<V2NIMSignallingCallResult>;
-    /** @brief 呼叫建立，包括加入信令频道房间，同时接受对方呼叫 */
-    /** @param params 建立呼叫参数 */
-    /** @return Promise<V2NIMSignallingCallSetupResult> */
+    /**
+     * @brief 呼叫建立，包括加入信令频道房间，同时接受对方呼叫
+     * @param params 建立呼叫参数
+     * @returns Promise<V2NIMSignallingCallSetupResult>
+     * @example
+     * ```javascript
+     * const result = await v2.signallingService.callSetup({
+     *     channelId: 'channelId',
+     *     callerAccountId: 'callerAccountId',
+     *     requestId: 'requestId',
+     *     serverExtension: 'serverExtension',
+     *     signallingConfig: {
+     *         // ...
+     *     },
+     *     rtcConfig: {
+     *         // ...
+     *     }
+     * })
+     * ```
+     */
     callSetup(params: V2NIMSignallingCallSetupParams): Promise<V2NIMSignallingCallSetupResult>;
-    /** @brief 创建信令房间 */
-    /** @param channelType 频道类型 */
-    /** @param channelName 频道名称 */
-    /** @param channelExtension 频道相关扩展字段 */
-    /** @return Promise<V2NIMSignallingChannelInfo> */
+    /**
+     * @brief 创建信令房间
+     * @param channelType 频道类型
+     * @param channelName 频道名称
+     * @param channelExtension 频道相关扩展字段
+     * @returns Promise<V2NIMSignallingChannelInfo>
+     * @example
+     * ```javascript
+     * const result = await v2.signallingService.createRoom(channelType, channelName, channelExtension)
+     * ```
+     */
     createRoom(channelType: number, channelName: string, channelExtension: string): Promise<V2NIMSignallingChannelInfo>;
-    /** @brief 关闭信令房间接口 */
-    /** @param channelId 频道 ID */
-    /** @param offlineEnabled 是否支持离线推送 */
-    /** @param serverExtension 服务器扩展字段 */
-    /** @return Promise<void> */
+    /**
+     * @brief 关闭信令房间接口
+     * @param channelId 频道 ID
+     * @param offlineEnabled 是否支持离线推送
+     * @param serverExtension 服务器扩展字段
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.closeRoom(channelId, offlineEnabled, serverExtension)
+     * ```
+     */
     closeRoom(channelId: string, offlineEnabled: boolean, serverExtension: string): Promise<void>;
-    /** @brief 加入信令房间接口 */
-    /** @param params 加入房间参数 */
-    /** @return Promise<V2NIMSignallingChannelInfo> */
+    /**
+     * @brief 加入信令房间接口
+     * @param params 加入房间参数
+     * @returns Promise<V2NIMSignallingRoomInfo>
+     * @example
+     * ```javascript
+     * const result = await v2.signallingService.joinRoom({
+     *     channelId: 'channelId',
+     *     serverExtension: 'serverExtension',
+     *     signallingConfig: {
+     *         // ...
+     *     },
+     *     rtcConfig: {
+     *         // ...
+     *     }
+     * })
+     * ```
+     */
     joinRoom(params: V2NIMSignallingJoinParams): Promise<V2NIMSignallingRoomInfo>;
-    /** @brief 离开信令房间接口 */
-    /** @param channelId 频道 ID */
-    /** @param offlineEnabled 是否支持离线推送 */
-    /** @param serverExtension 服务器扩展字段 */
-    /** @return Promise<void> */
+    /**
+     * @brief 离开信令房间接口
+     * @param channelId 频道 ID
+     * @param offlineEnabled 是否支持离线推送
+     * @param serverExtension 服务器扩展字段
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.leaveRoom(channelId, offlineEnabled, serverExtension)
+     * ```
+     */
     leaveRoom(channelId: string, offlineEnabled: boolean, serverExtension: string): Promise<void>;
-    /** @brief 邀请成员加入信令房间接口 */
-    /** @param params 邀请参数 */
-    /** @return Promise<void> */
+    /**
+     * @brief 邀请成员加入信令房间接口
+     * @param params 邀请参数
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.invite({
+     *     channelId: 'channelId',
+     *     inviteeAccountId: 'inviteeAccountId',
+     *     requestId: 'requestId',
+     *     serverExtension: 'serverExtension',
+     *     signallingConfig: {
+     *         // ...
+     *     },
+     *     pushConfig: {
+     *         // ...
+     *     }
+     * })
+     * ```
+     */
     invite(params: V2NIMSignallingInviteParams): Promise<void>;
-    /** @brief 取消之前的邀请成员加入信令房间接口 */
-    /** @param params 取消邀请参数 */
-    /** @return Promise<void> */
+    /**
+     * @brief 取消之前的邀请成员加入信令房间接口
+     * @param params 取消邀请参数
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.cancelInvite({
+     *     channelId: 'channelId',
+     *     inviteeAccountId: 'inviteeAccountId',
+     *     requestId: 'requestId'
+     * })
+     * ```
+     */
     cancelInvite(params: V2NIMSignallingCancelInviteParams): Promise<void>;
-    /** @brief 拒绝别人的邀请加入信令房间请求 */
-    /** @param params 拒绝邀请参数 */
-    /** @return Promise<void> */
+    /**
+     * @brief 拒绝别人的邀请加入信令房间请求
+     * @param params 拒绝邀请参数
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.rejectInvite({
+     *     channelId: 'channelId',
+     *     inviterAccountId: 'inviterAccountId',
+     *     requestId: 'requestId'
+     * })
+     * ```
+     */
     rejectInvite(params: V2NIMSignallingRejectInviteParams): Promise<void>;
-    /** @brief 接受别人的邀请加入信令房间请求 */
-    /** @param params 接受邀请参数 */
-    /** @return Promise<void> */
+    /**
+     * @brief 接受别人的邀请加入信令房间请求
+     * @param params 接受邀请参数
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.acceptInvite({
+     *     channelId: 'channelId',
+     *     inviterAccountId: 'inviterAccountId',
+     *     requestId: 'requestId'
+     * })
+     * ```
+     */
     acceptInvite(params: V2NIMSignallingAcceptInviteParams): Promise<void>;
-    /** @brief 发送自定义控制指令 */
-    /** @param channelId 频道 ID */
-    /** @param receiverAccountId 接受者账号 ID */
-    /** @param serverExtension 服务器扩展字段 */
-    /** @return Promise<void> */
+    /**
+     * @brief 发送自定义控制指令
+     * @param channelId 频道 ID
+     * @param receiverAccountId 接受者账号 ID
+     * @param serverExtension 服务器扩展字段
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.signallingService.sendControl(channelId, receiverAccountId, serverExtension)
+     * ```
+     */
     sendControl(channelId: string, receiverAccountId: string, serverExtension: string): Promise<void>;
-    /** @brief 根据频道名称查询频道房间信息 */
-    /** @param channelName 频道名称 */
-    /** @return Promise<V2NIMSignallingRoomInfo> */
+    /**
+     * @brief 根据频道名称查询频道房间信息
+     * @param channelName 频道名称
+     * @returns Promise<V2NIMSignallingRoomInfo>
+     * @example
+     * ```javascript
+     * const result = await v2.signallingService.getRoomInfoByChannelName(channelName)
+     * ```
+     */
     getRoomInfoByChannelName(channelName: string): Promise<V2NIMSignallingRoomInfo>;
 }

package/types/v2/v2_nim_storage_service.d.ts

@@ -1,58 +1,137 @@
 import { V2NIMUploadFileParams, V2NIMUploadFileTask, V2NIMStorageScene, V2NIMDownloadMessageAttachmentParams, V2NIMMessageAttachment, V2NIMGetMediaResourceInfoResult, V2NIMSize } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
-import { V2NIMProgressCallback } from "../v2_def/v2_nim_callback_def";
-export declare interface V2NIMStorageServiceEvents {
+import { V2NIMProgressCallback } from '../v2_def/v2_nim_callback_def';
+export declare interface V2NIMStorageListener {
 }
 /** @brief 存储服务 */
-export declare class V2NIMStorageService extends EventEmitter<V2NIMStorageServiceEvents> {
+export declare class V2NIMStorageService extends EventEmitter<V2NIMStorageListener> {
     instance: any;
     constructor(instanceId?: number);
-    /** @brief 添加自定义存储场景, 需在登录前调用 */
-    /** @param sceneName 自定义存储场景 */
-    /** @return void */
+    /**
+     * @brief 添加自定义存储场景, 需在登录前调用
+     * @param sceneName 自定义存储场景
+     * @return void
+     * @example
+     * ```javascript
+     * v2.storageService.addCustomStorageScene(sceneName, expireTime)
+     * ```
+     */
     addCustomStorageScene(sceneName: string, expireTime: number): void;
-    /** @brief 创建文件上传任务 */
-    /** @param fileParams 文件上传的相关参数 */
-    /** @return V2NIMUploadFileTask */
+    /**
+     * @brief 创建文件上传任务
+     * @param fileParams 文件上传的相关参数
+     * @return V2NIMUploadFileTask
+     * @example
+     * ```javascript
+     * const task = v2.storageService.createUploadFileTask({
+     *     filePath: 'file_path'
+     * })
+     * ```
+     */
     createUploadFileTask(fileParams: V2NIMUploadFileParams): V2NIMUploadFileTask;
-    /** @brief 文件上传 */
-    /** @param fileParams 文件上传的相关参数 */
-    /** @return Primise<string> */
+    /**
+     * @brief 文件上传
+     * @param fileTask 文件上传任务
+     * @returns Promise<string>
+     * @example
+     * ```javascript
+     * const url = await v2.storageService.uploadFile({
+     *     taskId: 'task_id',
+     *     uploadParams: {
+     *         filePath: 'file_path'
+     *     }
+     * })
+     * ```
+     */
     uploadFile(fileTask: V2NIMUploadFileTask): Promise<string>;
-    /** @brief 取消文件上传 */
-    /** @param uploadId 文件上传任务 id */
-    /** @return void */
+    /**
+     * @brief 取消文件上传
+     * @param fileTask 文件上传任务
+     * @returns Promise<void>
+     * @example
+     * ```javascript
+     * await v2.storageService.cancelUploadFile({
+     *     taskId: 'task_id'
+     * })
+     * ```
+     */
     cancelUploadFile(fileTask: V2NIMUploadFileTask): Promise<void>;
-    /** @brief 下载文件 */
-    /** @param url 文件下载地址 */
-    /** @param filePath 文件保存路径 */
-    /** @param progressCallback 下载进度回调 */
-    /** @return Promise<void> 下载文件的 Promise 对象 */
+    /**
+     * @brief 下载文件
+     * @param url 文件下载地址
+     * @param filePath 文件保存路径
+     * @param progressCallback 下载进度回调
+     * @returns Promise<string> 下载文件的 Promise 对象
+     * @example
+     * ```javascript
+     * const savePath = await v2.storageService.downloadFile(url, filePath, progressCallback)
+     * ```
+     */
     downloadFile(url: string, filePath: string, progressCallback: V2NIMProgressCallback): Promise<string>;
-    /** @brief 取消下载文件 */
-    /** @param url 文件下载地址 */
-    /** @return Promise<void> 取消下载文件的 Promise 对象 */
+    /**
+     * @brief 取消下载文件
+     * @param url 文件下载地址
+     * @returns Promise<void> 取消下载文件的 Promise 对象
+     * @example
+     * ```javascript
+     * await v2.storageService.cancelDownloadFile(url)
+     * ```
+     */
     cancelDownloadFile(url: string): Promise<void>;
-    /** @brief 查询存储场景列表 */
-    /** @return Array<V2NIMStorageScene> */
+    /**
+     * @brief 查询存储场景列表
+     * @returns Array<V2NIMStorageScene>
+     * @example
+     * ```javascript
+     * const scenes = v2.storageService.getStorageSceneList()
+     * ```
+     */
     getStorageSceneList(): Array<V2NIMStorageScene>;
-    /** @brief 长链接转短链接 */
-    /** @param shortUrl 短链接地址 */
-    /** @return Promise<string> 长链接的 Promise 对象 */
+    /** @brief 长链接转短链接
+     * @param shortUrl 短链接地址
+     * @returns Promise<string> 长链接的 Promise 对象
+     * @example
+     * ```javascript
+     * const longUrl = await v2.storageService.shortUrlToLong(shortUrl)
+     * ```
+     */
     shortUrlToLong(shortUrl: string): Promise<string>;
-    /** @brief 下载消息附件 */
-    /** @param downloadParam 下载参数 */
-    /** @param progress 下载进度回调 */
-    /** @return Promise<string> 下载文件的 Promise 对象 */
+    /**
+     * @brief 下载消息附件
+     * @param downloadParam 下载参数
+     * @param progress 下载进度回调
+     * @returns Promise<string> 下载文件的 Promise 对象
+     * @example
+     * ```javascript
+     * const savePath = await v2.storageService.downloadAttachment({
+     *     attachment,
+     *     type: 0,
+     * }, (progress) => {
+     *     console.log(progress)
+     * })
+     * ```
+     */
     downloadAttachment(downloadParam: V2NIMDownloadMessageAttachmentParams, progress: V2NIMProgressCallback): Promise<string>;
-    /** @brief 获取图片消息中的图片缩略图 */
-    /** @param attachment 消息附件 */
-    /** @param thumbSize 图片缩略图的尺寸，若不指定则使用默认 150x150 */
-    /** @return Promise<V2NIMGetMediaResourceInfoResult> 获取图片缩略图的 Promise 对象 */
+    /**
+     * @brief 获取图片消息中的图片缩略图
+     * @param attachment 消息附件
+     * @param thumbSize 图片缩略图的尺寸，若不指定则使用默认 150x150
+     * @returns Promise<V2NIMGetMediaResourceInfoResult> 获取图片缩略图的 Promise 对象
+     * @example
+     * ```javascript
+     * const result = await v2.storageService.getImageThumbUrl(attachment, thumbSize)
+     * ```
+     */
     getImageThumbUrl(attachment: V2NIMMessageAttachment, thumbSize?: V2NIMSize): Promise<V2NIMGetMediaResourceInfoResult>;
-    /** @brief 获取视频消息中的视频缩略图 */
-    /** @param attachment 消息附件 */
-    /** @param thumbSize 视频缩略图的尺寸，若不指定则使用默认 150x150 */
-    /** @return Promise<V2NIMGetMediaResourceInfoResult> 获取视频缩略图的 Promise 对象 */
+    /**
+     * @brief 获取视频消息中的视频缩略图
+     * @param attachment 消息附件
+     * @param thumbSize 视频缩略图的尺寸，若不指定则使用默认 150x150
+     * @returns Promise<V2NIMGetMediaResourceInfoResult> 获取视频缩略图的 Promise 对象
+     * @example
+     * ```javascript
+     * const result = await v2.storageService.getVideoCoverUrl(attachment, thumbSize)
+     * ```
+     */
     getVideoCoverUrl(attachment: V2NIMMessageAttachment, thumbSize?: V2NIMSize): Promise<V2NIMGetMediaResourceInfoResult>;
 }

package/types/v2/v2_nim_subscription_service.d.ts

@@ -1,26 +1,56 @@
 import { V2NIMSubscribeUserStatusOption, V2NIMUnsubscribeUserStatusOption, V2NIMCustomUserStatusParams, V2NIMCustomUserStatusPublishResult, V2NIMUserStatusSubscribeResult, V2NIMUserStatus } from 'ts/v2_def/v2_nim_struct_def';
 import { EventEmitter } from 'eventemitter3';
-export declare interface V2NIMSubscriptionServiceEvents {
+export declare interface V2NIMSubscriptionListener {
     userStatusChanged: [V2NIMUserStatus];
 }
 /** @brief 订阅服务 */
-export declare class V2NIMSubscriptionService extends EventEmitter<V2NIMSubscriptionServiceEvents> {
+export declare class V2NIMSubscriptionService extends EventEmitter<V2NIMSubscriptionListener> {
     instance: any;
     constructor();
-    /** @brief 订阅用户状态 */
-    /** @param option 订阅用户状态选项 */
-    /** @return Promise<string[]> */
+    /**
+     * @brief 订阅用户状态
+     * @param option 订阅用户状态选项
+     * @returns Promise<string[]>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.subscribeUserStatus({
+     *     accountIds: ['account1', 'account2'],
+     * })
+     * ```
+     */
     subscribeUserStatus(option: V2NIMSubscribeUserStatusOption): Promise<string[]>;
-    /** @brief 取消用户状态订阅 */
-    /** @param option 取消订阅用户状态选项 */
-    /** @return Promise<string[]> */
+    /**
+     * @brief 取消用户状态订阅
+     * @param option 取消订阅用户状态选项
+     * @returns Promise<string[]>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.unsubscribeUserStatus({
+     *     accountIds: ['account1', 'account2'],
+     * })
+     * ```
+     */
     unsubscribeUserStatus(option: V2NIMUnsubscribeUserStatusOption): Promise<string[]>;
-    /** @brief 发布用户自定义状态 */
-    /** @param params 发布自定义用户状态参数 */
-    /** @return Promise<V2NIMCustomUserStatusPublishResult> */
+    /**
+     * @brief 发布用户自定义状态
+     * @param params 发布自定义用户状态参数
+     * @returns Promise<V2NIMCustomUserStatusPublishResult>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.publishCustomUserStatus({
+     *     statusType: 10001,
+     *     duration: 60
+     * })
+     * ```
+     */
     publishCustomUserStatus(params: V2NIMCustomUserStatusParams): Promise<V2NIMCustomUserStatusPublishResult>;
-    /** @brief 查询用户状态订阅关系 */
-    /** @param accountIds 账号列表 */
-    /** @return Promise<V2NIMUserStatusSubscribeResult[]> */
+    /** @brief 查询用户状态订阅关系
+     * @param accountIds 账号列表
+     * @returns Promise<V2NIMUserStatusSubscribeResult[]>
+     * @example
+     * ```javascript
+     * const result = await v2.subscriptionService.queryUserStatusSubscriptions(['account1', 'account2'])
+     * ```
+     */
     queryUserStatusSubscriptions(accountIds: string[]): Promise<V2NIMUserStatusSubscribeResult[]>;
 }