nim-web-sdk-ng 10.7.2 → 10.8.0

package/dist/esm/nim/src/NIMInterface.d.ts

@@ -316,6 +316,10 @@ export interface NIMOtherOptions {
      * 注: 若初始化第一参数中 apiVersion 是 v2 时, syncConfig 失效, 而 V2NIMSyncServiceConfig 生效.
      */
     V2NIMSyncServiceConfig?: SyncOptions;
+    /**
+     * 本地反垃圾词库的配置
+     */
+    V2NIMClientAntispamUtilConfig?: NIMEModuleParamV2NIMClientAntispamUtil;
     /**
      * @deprecated 这个字段即将废弃，所有的属性被移入 {@link NIMOtherOptions.cloudStorageConfig} 中
      *
@@ -434,6 +438,14 @@ export interface NIMOtherOptions {
         neroom?: any;
     };
 }
+export declare type NIMEModuleParamV2NIMClientAntispamUtil = {
+    /**
+     * 是否打开本地反垃圾. 默认为 false
+     *
+     * 注: 需要在 IM 控制台配置本地反垃圾词库. 本开关打开后将会在登录完成后下载反垃圾词库.
+     */
+    enable?: boolean;
+};
 export declare type NIMOtherOptionsLoggerConfig = {
     /**
      * 日志等级. 默认 off 关闭日志打印.

package/dist/esm/nim/src/SyncServiceInterface.d.ts

@@ -118,7 +118,7 @@ export interface SyncOptions {
     /**
      * @Multi_Lang_Tag
      * @locale cn
-     * 是否同步消息会话 ack，时间戳单位毫秒。默认 false
+     * 是否同步消息会话 ack，时间戳单位毫秒。自 10.7.0+ 默认 true, 之前版本默认 false
      *
      * 会话 ACK 代表本账号在此会话里读过的最新消息的时间戳
      * @locale
@@ -223,7 +223,7 @@ export interface SyncOptions {
     /**
      * @Multi_Lang_Tag
      * @locale cn
-     * 是否同步置顶会话信息，默认 false
+     * 是否同步置顶会话信息，自 10.7.0+ 默认 true, 之前版本默认 false
      * @locale
      *
      * @locale en

package/dist/esm/nim/src/V2NIMConversationService.d.ts

@@ -64,7 +64,7 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
     /**
      * 创建会话
      *
-     * 注: 会话 id 的值可以参见 util service {@link V2NIMUtilService.generateConversationId | generateConversationId}
+     * 注: 会话 id 的值可以参见 {@link V2NIMConversationIdUtil | V2NIMConversationIdUtil}
      *
      * 注: 在操作成功且是有效的操作时, 会抛出事件 {@link V2NIMConversationListener.onConversationCreated | V2NIMConversationListener.onConversationCreated}
      *
@@ -79,7 +79,7 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
     /**
      * 删除会话
      *
-     * 注: 在操作成功且是有效的操作时, 会抛出事件 {@link V2NIMConversationListener.onConversationDeleted | V2NIMConversationListener.onConversationCreated}
+     * 注: 在操作成功且是有效的操作时, 会抛出事件 {@link V2NIMConversationListener.onConversationDeleted | V2NIMConversationListener.onConversationDeleted}
      *
      * @param conversationId 会话 id
      * @param clearMessage 是否删除会话对应的历史消息. 默认为 false
@@ -192,6 +192,11 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
      * 注: web 端中的表现为, 计算内存里缓存的符合条件的会话的未读数.
      *
      * @param filter 过滤条件
+     *
+     * @example
+     * ```ts
+     * const unreadCounts = await nim.V2NIMConversationService.getUnreadCountByFilter({ ignoreMuted: true })
+     * ```
      */
     getUnreadCountByFilter(filter: V2NIMConversationFilter): Promise<number>;
     /**
@@ -202,6 +207,11 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
      * {@link V2NIMConversationListener.onConversationChanged | V2NIMConversationListener.onConversationChanged} <br/>
      * {@link V2NIMConversationListener.onTotalUnreadCountChanged | V2NIMConversationListener.onTotalUnreadCountChanged} <br/>
      * {@link V2NIMConversationListener.onUnreadCountChangedByFilter | V2NIMConversationListener.onUnreadCountChangedByFilter}
+     *
+     * @example
+     * ```ts
+     * await nim.V2NIMConversationService.clearTotalUnreadCount()
+     * ```
      */
     clearTotalUnreadCount(): Promise<void>;
     /**
@@ -215,6 +225,11 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
      *
      * @param conversationIds 会话 id 列表
      * @returns 返回操作失败结果的列表
+     *
+     * @example
+     * ```ts
+     * const results = await nim.V2NIMConversationService.clearUnreadCountByIds(["CONVERSATION_ID1", "CONVERSATION_ID2"])
+     * ```
      */
     clearUnreadCountByIds(conversationIds: string[]): Promise<V2NIMConversationOperationResult[]>;
     /**
@@ -227,6 +242,10 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
      * {@link V2NIMConversationListener.onUnreadCountChangedByFilter | V2NIMConversationListener.onUnreadCountChangedByFilter}
      *
      * @param groupId 指定的会话分组 id
+     * @example
+     * ```ts
+     * await nim.V2NIMConversationService.clearUnreadCountByGroupId("GROUP_ID")
+     * ```
      */
     clearUnreadCountByGroupId(groupId: string): Promise<void>;
     /**
@@ -239,6 +258,10 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
      * {@link V2NIMConversationListener.onUnreadCountChangedByFilter | V2NIMConversationListener.onUnreadCountChangedByFilter}
      *
      * @param types 指定的会话类型列表
+     * @example
+     * ```ts
+     * await nim.V2NIMConversationService.clearUnreadCountByTypes([V2NIMConst.V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P])
+     * ```
      */
     clearUnreadCountByTypes(types: V2NIMConversationType[]): Promise<void>;
     /**
@@ -249,27 +272,57 @@ export declare class V2NIMConversationService extends NIMEBaseServiceClass<V2NIM
      * 注2: 同一种 filter 只能被订阅一次, 第二次的调用不会有任何效果
      *
      * @param filter 过滤条件
+     * @example
+     * ```ts
+     * // Eg. Subscribe to P2P conversation and ignore those muted conversation
+     * nim.V2NIMConversationService.subscribeUnreadCountByFilter({
+     *   conversationTypes: [V2NIMConst.V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P];
+     *   ignoreMuted: true;
+     * })
+     * ```
      */
     subscribeUnreadCountByFilter(filter: V2NIMConversationFilter): void;
     /**
      * 取消订阅指定过滤条件的会话未读变化
      *
      * @param filter 过滤条件
+     * @example
+     * ```ts
+     * // Eg. Subscribe to P2P conversation and ignore those muted conversation
+     * const filter = {
+     *   conversationTypes: [V2NIMConst.V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P];
+     *   ignoreMuted: true;
+     * }
+     * nim.V2NIMConversationService.subscribeUnreadCountByFilter(filter)
+     * nim.V2NIMConversationService.unsubscribeUnreadCountByFilter(filter)
+     * ```
      */
     unsubscribeUnreadCountByFilter(filter: V2NIMConversationFilter): void;
     /**
-     * 标记会话已读时间戳
+     * 获取会话已读时间戳。自 10.3.0 版本开始支持
+     *
+     * @param conversationId 会话id
+     * @return 返回会话已读时间戳, 代表这个会话中本账号已读过在这个时间戳之前的所有消息
+     * @example
+     * ```ts
+     * const readTime = await nim.V2NIMConversationService.getConversationReadTime("CONVERSATION_ID")
+     * ```
+     */
+    getConversationReadTime(conversationId: string): Promise<number>;
+    /**
+     * 标记会话已读时间戳. 自 10.3.0 版本开始支持
      *
      * 注: 当该方法调用后，SDK 可能给多端账户抛出以下的事件
      *
      * {@link V2NIMConversationListener.onConversationReadTimeUpdated | V2NIMConversationListener.onConversationReadTimeUpdated} <br/>
-     *
+     * @param conversationId 会话id
+     * @return 返回会话已读时间戳, 代表这个会话中本账号已读过在这个时间戳之前的所有消息
+     * @example
+     * ```ts
+     * const readTime = await nim.V2NIMConversationService.markConversationRead("CONVERSATION_ID")
+     * ```
      */
     markConversationRead(conversationId: string): Promise<number>;
-    /**
-     * 获取会话已读时间戳。该时间包含多端已读时间戳
-     */
-    getConversationReadTime(conversationId: string): Promise<number>;
 }
 export declare type V2NIMConversationFilter = {
     /**
@@ -649,14 +702,22 @@ export declare type V2NIMLastMessage = {
     senderName?: string;
 };
 export declare const enum V2NIMLastMessageState {
-    /** 正常状态 */
+    /**
+     * 默认状态
+     *
+     * 注: 本地会话只有这个状态, 没有其他的
+     */
     V2NIM_MESSAGE_STATUS_DEFAULT = 0,
-    /** 已撤回 */
+    /**
+     * 已撤回
+     *
+     * 注: 云端消息被撤回时, 会将消息状态置为已撤回.
+     */
     V2NIM_MESSAGE_STATUS_REVOKE = 1,
     /**
      * 被回溯
      *
-     * 注: 当会话的最新消息被删除时, 需要回溯找到此时真正的最新消息
+     * 注: 当云端会话的最新消息被删除时, 需要回溯找到此时真正的最新消息
      */
     V2NIM_MESSAGE_STATUS_BACKFILL = 2
 }

package/dist/esm/nim/src/V2NIMMessageService.d.ts

@@ -392,6 +392,8 @@ export declare class V2NIMMessageCreator {
     /**
      * 构造图片消息
      *
+     * 注: 使用 dist/esm 产物时，需要额外引入 {@link V2NIMStorageService | V2NIMStorageService}, 才能使用上传能力
+     *
      * @param imageObj 图片文件. 浏览器环境请传入 File 对象, 小程序及 uniapp 环境请输入临时文件路径
      * @param name 文件显示名称
      * @param sceneName 场景名
@@ -402,6 +404,8 @@ export declare class V2NIMMessageCreator {
     /**
      * 构造语音消息
      *
+     * 注: 使用 dist/esm 产物时，需要额外引入 {@link V2NIMStorageService | V2NIMStorageService}, 才能使用上传能力
+     *
      * @param audioObj 语音文件. 浏览器环境请传入 File 对象, 小程序及 uniapp 环境请输入临时文件路径
      * @param name 文件显示名称
      * @param sceneName 场景名
@@ -411,6 +415,8 @@ export declare class V2NIMMessageCreator {
     /**
      * 构造视频消息
      *
+     * 注: 使用 dist/esm 产物时，需要额外引入 {@link V2NIMStorageService | V2NIMStorageService}, 才能使用上传能力
+     *
      * @param videoObj 视频文件. 浏览器环境请传入 File 对象, 小程序及 uniapp 环境请输入临时文件路径
      * @param name 文件显示名称
      * @param sceneName 场景名
@@ -422,6 +428,8 @@ export declare class V2NIMMessageCreator {
     /**
      * 构造文件消息
      *
+     * 注: 使用 dist/esm 产物时，需要额外引入 {@link V2NIMStorageService | V2NIMStorageService}, 才能使用上传能力
+     *
      * @param fileObj 文件. 浏览器环境请传入 File 对象, 小程序及 uniapp 环境请输入临时文件路径
      * @param name 文件显示名称
      * @param sceneName 场景名
@@ -708,6 +716,8 @@ export declare type V2NIMMessage = {
     robotConfig?: V2NIMMessageRobotConfig;
     /**
      * Thread 消息引用
+     *
+     * 注: 仅回参时存在, 若作为发送接口的入参使用则无效
      */
     threadRoot?: V2NIMMessageRefer;
     /**
@@ -716,6 +726,8 @@ export declare type V2NIMMessage = {
     threadReply?: V2NIMMessageRefer;
     /**
      * 消息的状态相关
+     *
+     * 注: 仅回参时存在, 若作为发送接口的入参则无效
      */
     messageStatus: V2NIMMessageStatus;
     /**
@@ -962,6 +974,8 @@ export interface V2NIMMessagePushConfig {
     forcePushContent?: string;
     /**
      * 强制推送目标账号列表。该设置仅在群聊时有效
+     *
+     * 注: 不存在则代表着强推给所有人. 空数组代表没有强推目标. 数组有值代表强推给指定的若干个账号
      */
     forcePushAccountIds?: string[];
 }
@@ -1385,6 +1399,12 @@ export interface V2NIMMessageListOption {
      */
     direction?: V2NIMQueryDirection;
 }
+export declare const enum V2NIMClearHistoryMode {
+    /** 同时删除云端和本地 */
+    V2NIM_CLEAR_HISTORY_MODE_ALL = 0,
+    /** 仅删除本地, 云端拉取可以恢复, Web端不支持该值 */
+    V2NIM_CLEAR_HISTORY_MODE_LOCAL = 1
+}
 /**
  * 清空历史消息接口参数
  */
@@ -1405,6 +1425,13 @@ export interface V2NIMClearHistoryMessageOption {
      * 扩展字段。多端同步时会同步到其它端
      */
     serverExtension?: string;
+    /**
+     * 清空历史消息模式
+     * - 0: 同时删除云端和本地
+     * - 1: 仅删除本地, 云端拉取可以恢复
+     * 默认为 0
+     */
+    clearMode?: V2NIMClearHistoryMode;
 }
 export interface V2NIMMessageRevokeParams {
     /**

package/dist/esm/nim/src/V2NIMNotificationService.d.ts

@@ -53,39 +53,43 @@ export interface V2NIMSendCustomNotificationParams {
 }
 export interface V2NIMNotificationConfig {
     /** 是否需要存离线通知 */
-    offlineEnabled: boolean;
+    offlineEnabled?: boolean;
     /** 是否需要计算通知未读 */
-    unreadEnabled: boolean;
+    unreadEnabled?: boolean;
     /** 消息id，用于查询系统通知日志 */
     clientNotificationId?: string;
 }
 export interface V2NIMNotificationPushConfig {
     /** 是否需要推送 */
-    pushEnabled: boolean;
+    pushEnabled?: boolean;
     /** 是否需要推送通知发送者昵称 */
-    pushNickEnabled: boolean;
+    pushNickEnabled?: boolean;
     /** 推送文案 */
-    pushContent: string;
+    pushContent?: string;
     /** 推送数据 */
-    pushPayload: string;
+    pushPayload?: string;
     /** 强制推送 */
-    forcePush: boolean;
+    forcePush?: boolean;
     /** 强制推送文案 */
-    forcePushContent: string;
-    /** 强制推送目标账号 */
-    forcePushAccounts: string[];
+    forcePushContent?: string;
+    /**
+     * 强制推送目标账号
+     *
+     * 注: 不存在则代表着强推给所有人. 空数组代表没有强推目标. 数组有值代表强推给指定的若干个账号
+     */
+    forcePushAccountIds: string[];
 }
 export interface V2NIMNotificationAntispamConfig {
     /** 指定消息是否需要经过安全通 */
-    antispamEnabled: boolean;
+    antispamEnabled?: boolean;
     /** 开发者自定义的反垃圾字段，content必须是json格式 */
-    antispamCustomNotification: string;
+    antispamCustomNotification?: string;
 }
 export interface V2NIMNotificationRouteConfig {
     /** 是否需要抄送 */
-    routeEnabled: boolean;
+    routeEnabled?: boolean;
     /** 环境变量。用于指向不同的抄送，第三方回调设置 */
-    routeEnvironment: string;
+    routeEnvironment?: string;
 }
 /**
  * 通知模块的监听事件

package/dist/esm/nim/src/V2NIMSignallingService.d.ts

@@ -43,7 +43,7 @@ export declare class V2NIMSignallingService extends NIMEBaseServiceClass<V2NIMSi
      * 加入信令房间接口
      * @param params 加入信令房间参数
      */
-    joinRoom(params: V2NIMSignallingJoinParams): Promise<V2NIMSignallingRoomInfo>;
+    joinRoom(params: V2NIMSignallingJoinParams): Promise<V2NIMSignallingJoinResult>;
     /**
      * 离开信令房间接口
      * @param channelId 频道ID
@@ -89,6 +89,16 @@ export declare class V2NIMSignallingService extends NIMEBaseServiceClass<V2NIMSi
      */
     getRoomInfoByChannelName(channelName: string): Promise<V2NIMSignallingRoomInfo>;
 }
+export declare type V2NIMSignallingJoinResult = {
+    /**
+     * 频道房间相关信息
+     */
+    roomInfo: V2NIMSignallingRoomInfo;
+    /**
+     * 音视频房间相关信息
+     */
+    rtcInfo: V2NIMSignallingRtcInfo;
+};
 export declare type V2NIMSignallingAcceptInviteParams = {
     /**
      * 信令频道ID
@@ -420,6 +430,10 @@ export declare type V2NIMSignallingChannelInfo = {
      * 频道类型. 房间创建后跟频道类型绑定
      */
     channelType: V2NIMSignallingChannelType;
+    /**
+     * 频道是否有效. 自 10.8.0+ 支持
+     */
+    channelValid: boolean;
     /**
      * 频道相关扩展字段， 长度限制4096
      */

package/dist/esm/nim/src/index.d.ts

@@ -32,6 +32,7 @@ import { V2NIMSignallingService } from './V2NIMSignallingService';
 import { V2NIMSubscriptionService } from './V2NIMSubscriptionService';
 import { V2NIMPassthroughService } from './V2NIMPassthroughService';
 import { YSFService } from './YSFService';
+import { V2NIMLocalConversationService } from './V2NIMLocalConversationService';
 export declare class V2NIM {
     /**
      * @deprecated
@@ -165,6 +166,7 @@ export declare class V2NIM {
     V2NIMStorageService: V2NIMStorageService;
     /** ---------- 模块服务 ----------- */
     V2NIMLoginService: V2NIMLoginService;
+    V2NIMLocalConversationService: V2NIMLocalConversationService;
     V2NIMConversationService: V2NIMConversationService;
     V2NIMConversationGroupService: V2NIMConversationGroupService;
     V2NIMMessageService: V2NIMMessageService;

package/dist/esm/nim/src/types.d.ts

@@ -14,7 +14,7 @@ export declare type NIMEStrAnyObj = {
     [key: string]: any;
 };
 export declare type AnyArr = any[];
-export declare type NIMServiceName = 'auth' | 'V1NIMLoginService' | 'V2NIMLoginService' | 'V2NIMConversationService' | 'V2NIMConversationIdUtil' | 'V2NIMConversationGroupService' | 'V2NIMMessageService' | 'V2NIMClientAntispamUtil' | 'V2NIMMessageLogUtil' | 'V2NIMMessageExtendUtil' | 'V2NIMNotificationService' | 'V2NIMStorageService' | 'V2NIMStorageUtil' | 'V2NIMTeamService' | 'V2NIMUserService' | 'V2NIMFriendService' | 'V2NIMSettingService' | 'V2NIMSyncService' | 'V2NIMAIService' | 'V2NIMSignallingService' | 'V2NIMSubscriptionService' | 'DataStructureConverter' | 'V2NIMMessageConverter' | 'V2NIMMessageCreator' | 'V2NIMMessageAttachmentCreator' | 'V2NIMPassthroughService' | 'YSFService' | 'msg' | 'msgLog' | 'team' | 'superTeam' | 'misc' | 'sync' | 'user' | 'session' | 'systemMessage' | 'friend' | 'event' | 'msgExtend' | 'passThrough' | 'plugin' | 'cloudSession' | 'signaling' | 'cloudStorage' | 'offlinePush' | 'qchatChannel' | 'qchatMedia' | 'qchatMsg' | 'qchatRole' | 'qchatServer';
+export declare type NIMServiceName = 'auth' | 'V1NIMLoginService' | 'V2NIMLoginService' | 'V2NIMLocalConversationService' | 'V2NIMConversationService' | 'V2NIMConversationIdUtil' | 'V2NIMConversationGroupService' | 'V2NIMMessageService' | 'V2NIMClientAntispamUtil' | 'V2NIMMessageLogUtil' | 'V2NIMMessageExtendUtil' | 'V2NIMNotificationService' | 'V2NIMStorageService' | 'V2NIMStorageUtil' | 'V2NIMTeamService' | 'V2NIMUserService' | 'V2NIMFriendService' | 'V2NIMSettingService' | 'V2NIMSyncService' | 'V2NIMAIService' | 'V2NIMSignallingService' | 'V2NIMSubscriptionService' | 'DataStructureConverter' | 'V2NIMMessageConverter' | 'V2NIMMessageCreator' | 'V2NIMMessageAttachmentCreator' | 'V2NIMPassthroughService' | 'YSFService' | 'msg' | 'msgLog' | 'team' | 'superTeam' | 'misc' | 'sync' | 'user' | 'session' | 'systemMessage' | 'friend' | 'event' | 'msgExtend' | 'passThrough' | 'plugin' | 'cloudSession' | 'signaling' | 'cloudStorage' | 'offlinePush' | 'qchatChannel' | 'qchatMedia' | 'qchatMsg' | 'qchatRole' | 'qchatServer';
 export declare class NIMEBaseServiceClass<I extends object> {
     on<T extends keyof I>(eventName: T, fn: (...args: ArgumentMap<I>[Extract<T, keyof I>]) => void): void;
     once<T extends keyof I>(eventName: T, fn: (...args: ArgumentMap<I>[Extract<T, keyof I>]) => void): void;

package/dist/esm/nim.d.ts

@@ -11,6 +11,7 @@ declare let baiduAdapters: GetAdapterType;
 declare let ttAdapters: GetAdapterType;
 export { uniAppAdapters, browserAdapters, wxAdapters, aliAdapters, baiduAdapters, ttAdapters };
 export { setAdapters } from './adapters';
+export { V2NIMLocalConversationService } from './nim/src/V2NIMLocalConversationService';
 export { V2NIMConversationService } from './nim/src/V2NIMConversationService';
 export { V2NIMConversationGroupService } from './nim/src/V2NIMConversationGroupService';
 export { V2NIMMessageService, V2NIMMessageConverter, V2NIMMessageLogUtil, V2NIMMessageExtendUtil } from './nim/src/V2NIMMessageService';