node-nim 9.14.3 → 10.2.0

package/types/v2/v2_nim_team_service.d.ts

@@ -0,0 +1,184 @@
+import { V2NIMCreateTeamParams, V2NIMAntispamConfig, V2NIMCreateTeamResult, V2NIMError, V2NIMUpdateTeamInfoParams, V2NIMTeam, V2NIMUpdateSelfMemberInfoParams, V2NIMTeamMemberQueryOption, V2NIMTeamMemberListResult, V2NIMTeamMember, V2NIMTeamJoinActionInfo, V2NIMTeamJoinActionInfoResult, V2NIMTeamJoinActionInfoQueryOption } from 'ts/v2_def/v2_nim_struct_def';
+import { EventEmitter } from 'eventemitter3';
+export declare interface V2NIMTeamServiceEvents {
+    /** 群组信息同步开始 */
+    syncStarted: [];
+    /** 群组信息同步完成 */
+    syncFinished: [];
+    /** 群组信息同步失败 */
+    syncFailed: [V2NIMError];
+    /** 群组创建 */
+    teamCreated: [V2NIMTeam];
+    /** 加入群组 */
+    teamDismissed: [Array<V2NIMTeam>];
+    /** 群组创建 */
+    teamJoined: [V2NIMTeam];
+    /** 离开群组 */
+    teamLeft: [team: V2NIMTeam, isKicked: boolean];
+    /** 群组信息更新 */
+    teamInfoUpdated: [V2NIMTeam];
+    /** 群组成员加入 */
+    teamMemberJoined: [Array<V2NIMTeamMember>];
+    /** 群组成员被踢 */
+    teamMemberKicked: [operateAccountId: string, teamMembers: Array<V2NIMTeamMember>];
+    /** 群组成员退出群组 */
+    teamMemberLeft: [Array<V2NIMTeamMember>];
+    /** 群组成员信息变更 */
+    teamMemberInfoUpdated: [Array<V2NIMTeamMember>];
+    /** 收到入群信息 */
+    receiveTeamJoinActionInfo: [V2NIMTeamJoinActionInfo];
+}
+/** @brief 存储服务 */
+export declare class V2NIMTeamService extends EventEmitter<V2NIMTeamServiceEvents> {
+    instance: any;
+    constructor();
+    /** @brief 创建群组 */
+    /** @param createTeamParams 创建群组参数 */
+    /** @param inviteeAccountIds 群组创建时, 同时被邀请加入群的成员列表 */
+    /** @param postscript 群组创建时, 邀请入群的附言 */
+    /** @param antispamConfig 反垃圾配置 */
+    /** @return void */
+    createTeam(createTeamParams: V2NIMCreateTeamParams, inviteeAccountIds: Array<string>, postscript: string, antispamConfig: V2NIMAntispamConfig): Promise<V2NIMCreateTeamResult>;
+    /** @brief 修改群组信息 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param updateTeamInfoParams 修改群组信息参数 */
+    /** @param antispamConfig 反垃圾配置 */
+    /** @return void */
+    updateTeamInfo(teamId: string, teamType: V2NIMTeamType, updateTeamInfoParams: V2NIMUpdateTeamInfoParams, antispamConfig: V2NIMAntispamConfig): Promise<void>;
+    /** @brief 退出群组 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @return void */
+    leaveTeam(teamId: string, teamType: V2NIMTeamType): Promise<void>;
+    /** @brief 获取群组信息 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @return void */
+    getTeamInfo(teamId: string, teamType: V2NIMTeamType): Promise<V2NIMTeam>;
+    /** @brief 根据群组 ID 获取群组信息 */
+    /** @param teamIds 群组 id 列表 */
+    /** @param teamType 群组类型 */
+    /** @return void */
+    getTeamInfoByIds(teamIds: Array<string>, teamType: V2NIMTeamType): Promise<Array<V2NIMTeam>>;
+    /** @brief 解散群组 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @return void */
+    dismissTeam(teamId: string, teamType: V2NIMTeamType): Promise<void>;
+    /** @brief 邀请成员加入群组 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param inviteeAccountIds 被邀请人 id 列表 */
+    /** @param postscript 邀请附言 */
+    /** @return void */
+    inviteMember(teamId: string, teamType: V2NIMTeamType, inviteeAccountIds: Array<string>, postscript: string): Promise<Array<string>>;
+    /** @brief 同意邀请入群 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param invitorAccountId 邀请人 id */
+    /** @return void */
+    acceptInvitation(invitationInfo: V2NIMTeamJoinActionInfo): Promise<V2NIMTeam>;
+    /** @brief 拒绝邀请入群 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param invitorAccountId 邀请人 id */
+    /** @param postscript 拒绝邀请的理由附言 */
+    /** @return void */
+    rejectInvitation(invitationInfo: V2NIMTeamJoinActionInfo, postscript: string): Promise<void>;
+    /** @brief 踢出群组成员 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param memberAccountIds 踢出群组的成员账号列表 */
+    /** @return void */
+    kickMember(teamId: string, teamType: V2NIMTeamType, memberAccountIds: Array<string>): Promise<void>;
+    /** @brief 申请加入群组 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param postscript 申请入群的附言 */
+    /** @return void */
+    applyJoinTeam(teamId: string, teamType: V2NIMTeamType, postscript: string): Promise<V2NIMTeam>;
+    /** @brief 接受入群申请 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param applyAccountId 申请人 id */
+    /** @return void */
+    acceptJoinApplication(applicationInfo: V2NIMTeamJoinActionInfo): Promise<void>;
+    /** @brief 拒绝入群申请 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param applyAccountId 申请人 id */
+    /** @param postscript 拒绝入群申请的附言 */
+    /** @return void */
+    rejectJoinApplication(applicationInfo: V2NIMTeamJoinActionInfo, postscript: string): Promise<void>;
+    /** @brief 设置成员角色 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param memberAccountId 成员 id */
+    /** @param memberRole 设置新的角色类型 */
+    /** @return void */
+    updateTeamMemberRole(teamId: string, teamType: V2NIMTeamType, memberAccountIds: Array<string>, memberRole: V2NIMTeamMemberRole): Promise<void>;
+    /** @brief 移交群主 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param accountId 新群主 id */
+    /** @param leave 是否同时退出群组 */
+    /** @return void */
+    transferTeamOwner(teamId: string, teamType: V2NIMTeamType, accountId: string, leave: boolean): Promise<void>;
+    /** @brief 修改自己的群成员信息 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param memberInfoParams 修改群成员信息参数 */
+    /** @return void */
+    updateSelfTeamMemberInfo(teamId: string, teamType: V2NIMTeamType, memberInfoParams: V2NIMUpdateSelfMemberInfoParams): Promise<void>;
+    /** @brief 修改群成员昵称 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param accountId 群成员 id */
+    /** @param nick 群成员昵称 */
+    /** @return void */
+    updateTeamMemberNick(teamId: string, teamType: V2NIMTeamType, accountId: string, teamNick: string): Promise<void>;
+    /** @brief 设置群组禁言模式 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param chatBannedMode 群组禁言模式 */
+    /** @return void */
+    setTeamChatBannedMode(teamId: string, teamType: V2NIMTeamType, chatBannedMode: V2NIMTeamChatBannedMode): Promise<void>;
+    /** @brief 设置群组成员聊天禁言状态 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param accountId 群成员 id */
+    /** @param chatBanned 是否禁言 */
+    /** @return void */
+    setTeamMemberChatBannedStatus(teamId: string, teamType: V2NIMTeamType, accountId: string, chatBanned: boolean): Promise<void>;
+    /** @brief 获取当前已经加入的群组列表 */
+    /** @param teamType 群组类型 */
+    /** @return void */
+    getJoinedTeamList(teamTypes: Array<V2NIMTeamType>): Promise<Array<V2NIMTeam>>;
+    /** @brief 获取当前已经加入的群组数量 */
+    /** @param teamTypes 群组类型列表, 为空表示查询所有群类型 */
+    /** @return number */
+    getJoinedTeamCount(teamTypes: Array<V2NIMTeamType>): number;
+    /** @brief 获取群组成员列表 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param queryOption 群组成员查询选项 */
+    /** @return void */
+    getTeamMemberList(teamId: string, teamType: V2NIMTeamType, queryOption: V2NIMTeamMemberQueryOption): Promise<V2NIMTeamMemberListResult>;
+    /** @brief 根据账号 ID 列表获取群组成员列表 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param accountIds 账号 ID 列表 */
+    /** @return void */
+    getTeamMemberListByIds(teamId: string, teamType: V2NIMTeamType, accountIds: Array<string>): Promise<Array<V2NIMTeamMember>>;
+    /** @brief 根据账号 ID 列表获取群组成员邀请人 */
+    /** @param teamId 群组 id */
+    /** @param teamType 群组类型 */
+    /** @param accountIds 账号 ID 列表 */
+    /** @return void */
+    getTeamMemberInvitor(teamId: string, teamType: V2NIMTeamType, accountIds: Array<string>): Promise<Map<string, string>>;
+    /** @brief 获取群加入相关信息 */
+    /** @param option 查询参数 */
+    /** @return void */
+    getTeamJoinActionInfoList(option: V2NIMTeamJoinActionInfoQueryOption): Promise<V2NIMTeamJoinActionInfoResult>;
+}

package/types/v2/v2_nim_user_service.d.ts

@@ -0,0 +1,34 @@
+import { V2NIMUser, V2NIMUserUpdateParams } from 'ts/v2_def/v2_nim_struct_def';
+import { EventEmitter } from 'eventemitter3';
+export declare interface V2NIMUserServiceEvents {
+    /** 用户资料变更 */
+    userProfileChanged: [Array<V2NIMUser>];
+    /** 添加黑名单 */
+    blockListAdded: [V2NIMUser];
+    /** 移除黑名单 */
+    blockListRemoved: [string];
+}
+/** @brief 用户资料服务 */
+export declare class V2NIMUserService extends EventEmitter<V2NIMUserServiceEvents> {
+    instance: any;
+    constructor();
+    /** @brief 根据用户账号列表获取用户资料 */
+    /** @param accountIds 用户账号列表 */
+    /** @return void */
+    getUserList(accountIds: Array<string>): Promise<Array<V2NIMUser>>;
+    /** @brief 更新自己的用户资料 */
+    /** @param updateParams 更新参数 */
+    /** @return void */
+    updateSelfUserProfile(updateParams: V2NIMUserUpdateParams): Promise<void>;
+    /** @brief 添加用户到黑名单中 */
+    /** @param accountId 用户账号 */
+    /** @return void */
+    addUserToBlockList(accountId: string): Promise<void>;
+    /** @brief 从黑名单中移除用户 */
+    /** @param accountId 用户账号 */
+    /** @return void */
+    removeUserFromBlockList(accountId: string): Promise<void>;
+    /** @brief 获取黑名单列表 */
+    /** @return void */
+    getBlockList(): Promise<Array<string>>;
+}

package/types/v2/v2_nim_utilities.d.ts

@@ -0,0 +1,168 @@
+import { V2NIMMessage, V2NIMClientAntispamResult, V2NIMChatroomMessage } from 'ts/v2_def/v2_nim_struct_def';
+import { EventEmitter } from 'eventemitter3';
+/** @brief 消息创建器 */
+export declare class V2NIMMessageCreator {
+    /** @brief 创建文本消息 */
+    /** @param text 文本内容 */
+    /** @return V2NIMMessage */
+    static createTextMessage(text: string): V2NIMMessage | null;
+    createTextMessage(text: string): V2NIMMessage | null;
+    /** @brief 创建图片消息 */
+    /** @param imagePath 图片路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @param width 图片宽度 */
+    /** @param height 图片高度 */
+    /** @return V2NIMMessage */
+    static createImageMessage(imagePath: string, name: string, sceneName: string, width: number, height: number): V2NIMMessage | null;
+    createImageMessage(imagePath: string, name: string, sceneName: string, width: number, height: number): V2NIMMessage | null;
+    /** @brief 创建音频消息 */
+    /** @param audioPath 音频路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @param duration 音频时长 */
+    /** @return V2NIMMessage */
+    static createAudioMessage(audioPath: string, name: string, sceneName: string, duration: number): V2NIMMessage | null;
+    createAudioMessage(audioPath: string, name: string, sceneName: string, duration: number): V2NIMMessage | null;
+    /** @brief 创建视频消息 */
+    /** @param videoPath 视频路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @param duration 视频时长 */
+    /** @param width 视频宽度 */
+    /** @param height 视频高度 */
+    /** @return V2NIMMessage */
+    static createVideoMessage(videoPath: string, name: string, sceneName: string, duration: number, width: number, height: number): V2NIMMessage | null;
+    createVideoMessage(videoPath: string, name: string, sceneName: string, duration: number, width: number, height: number): V2NIMMessage | null;
+    /** @brief 创建文件消息 */
+    /** @param filePath 文件路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @return V2NIMMessage */
+    static createFileMessage(filePath: string, name: string, sceneName: string): V2NIMMessage | null;
+    createFileMessage(filePath: string, name: string, sceneName: string): V2NIMMessage | null;
+    /** @brief 创建位置消息 */
+    /** @param latitude 纬度 */
+    /** @param longitude 经度 */
+    /** @param address 详细位置信息 */
+    /** @return V2NIMMessage */
+    static createLocationMessage(latitude: number, longitude: number, address: string): V2NIMMessage | null;
+    createLocationMessage(latitude: number, longitude: number, address: string): V2NIMMessage | null;
+    /** @brief 创建自定义消息 */
+    /** @param text 文本内容 */
+    /** @param rawAttachment 附件 */
+    /** @return V2NIMMessage */
+    static createCustomMessage(text: string, rawAttachment: string): V2NIMMessage | null;
+    createCustomMessage(text: string, rawAttachment: string): V2NIMMessage | null;
+    /** @brief 创建提示消息 */
+    /** @param text 文本内容 */
+    /** @return V2NIMMessage */
+    static createTipsMessage(text: string): V2NIMMessage | null;
+    createTipsMessage(text: string): V2NIMMessage | null;
+    /** @brief 创建转发消息 */
+    /** @param message 原消息 */
+    /** @return V2NIMMessage */
+    static createForwardMessage(message: V2NIMMessage): V2NIMMessage | null;
+    createForwardMessage(message: V2NIMMessage): V2NIMMessage | null;
+}
+/** @brief 会话ID工具 */
+export declare class V2NIMConversationIdUtil {
+    /** @brief 获取点对点会话ID */
+    /** @param accountId 账号ID */
+    /** @return string */
+    static p2pConversationId(accountId: string): string;
+    p2pConversationId(accountId: string): string;
+    /** @brief 获取群组会话ID */
+    /** @param teamId 群组ID */
+    /** @return string */
+    static teamConversationId(teamId: string): string;
+    teamConversationId(teamId: string): string;
+    /** @brief 获取超级群会话ID */
+    /** @param superTeamId 超级群ID */
+    /** @return string */
+    static superTeamConversationId(superTeamId: string): string;
+    superTeamConversationId(superTeamId: string): string;
+    /** @brief 获取会话ID对应的会话类型 */
+    /** @param conversationId 会话ID */
+    /** @return V2NIMConversationType */
+    static parseConversationType(conversationId: string): V2NIMConversationType;
+    parseConversationType(conversationId: string): V2NIMConversationType;
+    /** @brief 获取会话ID对应的目标ID */
+    /** @param conversationId 会话ID */
+    /** @return string */
+    static parseConversationTargetId(conversationId: string): string;
+    parseConversationTargetId(conversationId: string): string;
+}
+/** @brief 本地反垃圾工具 */
+export declare class V2NIMClientAntispamUtil {
+    /** @brief 文本本地反垃圾 */
+    /** @param text 需要本地反垃圾check的文本 */
+    /** @param replace 敏感内容替换词 */
+    /** @return V2NIMMessage */
+    static checkTextAntispam(text: string, replace: string): V2NIMClientAntispamResult;
+    checkTextAntispam(text: string, replace: string): V2NIMClientAntispamResult;
+}
+/** @brief 聊天室消息创建器 */
+export declare class V2NIMChatroomMessageCreator extends EventEmitter {
+    /** @brief 创建文本消息 */
+    /** @param text 文本内容 */
+    /** @return V2NIMChatroomMessage */
+    static createTextMessage(text: string): V2NIMChatroomMessage | null;
+    createTextMessage(text: string): V2NIMChatroomMessage | null;
+    /** @brief 创建图片消息 */
+    /** @param imagePath 图片路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @param width 图片宽度 */
+    /** @param height 图片高度 */
+    /** @return V2NIMChatroomMessage */
+    static createImageMessage(imagePath: string, name: string, sceneName: string, width: number, height: number): V2NIMChatroomMessage | null;
+    createImageMessage(imagePath: string, name: string, sceneName: string, width: number, height: number): V2NIMChatroomMessage | null;
+    /** @brief 创建音频消息 */
+    /** @param audioPath 音频路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @param duration 音频时长 */
+    /** @return V2NIMChatroomMessage */
+    static createAudioMessage(audioPath: string, name: string, sceneName: string, duration: number): V2NIMChatroomMessage | null;
+    createAudioMessage(audioPath: string, name: string, sceneName: string, duration: number): V2NIMChatroomMessage | null;
+    /** @brief 创建视频消息 */
+    /** @param videoPath 视频路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @param duration 视频时长 */
+    /** @param width 视频宽度 */
+    /** @param height 视频高度 */
+    /** @return V2NIMChatroomMessage */
+    static createVideoMessage(videoPath: string, name: string, sceneName: string, duration: number, width: number, height: number): V2NIMChatroomMessage | null;
+    createVideoMessage(videoPath: string, name: string, sceneName: string, duration: number, width: number, height: number): V2NIMChatroomMessage | null;
+    /** @brief 创建文件消息 */
+    /** @param filePath 文件路径 */
+    /** @param name 文件显示名称, 为空则使用文件名 */
+    /** @param sceneName 文件存储场景 */
+    /** @return V2NIMChatroomMessage */
+    static createFileMessage(filePath: string, name: string, sceneName: string): V2NIMChatroomMessage | null;
+    createFileMessage(filePath: string, name: string, sceneName: string): V2NIMChatroomMessage | null;
+    /** @brief 创建位置消息 */
+    /** @param latitude 纬度 */
+    /** @param longitude 经度 */
+    /** @param address 详细位置信息 */
+    /** @return V2NIMChatroomMessage */
+    static createLocationMessage(latitude: number, longitude: number, address: string): V2NIMChatroomMessage | null;
+    createLocationMessage(latitude: number, longitude: number, address: string): V2NIMChatroomMessage | null;
+    /** @brief 创建自定义消息 */
+    /** @param rawAttachment 自定义附件 */
+    /** @return V2NIMChatroomMessage */
+    static createCustomMessage(rawAttachment: string): V2NIMChatroomMessage | null;
+    createCustomMessage(rawAttachment: string): V2NIMChatroomMessage | null;
+    /** @brief 创建提示消息 */
+    /** @param text 文本内容 */
+    /** @return V2NIMChatroomMessage */
+    static createTipsMessage(text: string): V2NIMChatroomMessage | null;
+    createTipsMessage(text: string): V2NIMChatroomMessage | null;
+    /** @brief 创建转发消息 */
+    /** @param message 原消息 */
+    /** @return V2NIMChatroomMessage */
+    static createForwardMessage(message: V2NIMChatroomMessage): V2NIMChatroomMessage | null;
+    createForwardMessage(message: V2NIMChatroomMessage): V2NIMChatroomMessage | null;
+}

package/types/v2_def/v2_nim_callback_def.d.ts

@@ -1,20 +1,7 @@
-import { V2NIMError, V2NIMMessage, V2NIMSendMessageResult } from './v2_nim_struct_def';
-/** @brief 通用成功回调 */
-export type V2NIMSuccessCallback = () => void;
-/** @brief 通用失败回调 */
-/** @param error 错误信息 */
-export type V2NIMFailureCallback = (error: V2NIMError) => void;
-/** @brief 通用进度回调 */
-/** @param progress 进度, 0-100 */
-export type V2NIMProgressCallback = (progress: number) => void;
-/** @brief 消息发送成功回调 */
-/** @param message 消息 */
-/** @param result 消息发送结果 */
-export type V2NIMSendMessageSuccessCallback = (message: V2NIMMessage, result: V2NIMSendMessageResult) => void;
-/** @brief 消息数组成功回调 */
-/** @param messages 消息数组 */
-export type V2NIMMessageListSuccessCallback = (messages: Array<V2NIMMessage>) => void;
-/** @brief 获取重连延时回调 */
-/** @param defaultDelay 默认延时, 单位毫秒 */
-/** @return number 延时, 单位毫秒 */
-export type V2NIMReconnectDelayProvider = (defaultDelay: number) => number;
+/** @brief 通用进度回调 */
+/** @param progress 进度, 0-100 */
+export type V2NIMProgressCallback = (progress: number) => void;
+/** @brief 获取重连延时回调 */
+/** @param defaultDelay 默认延时, 单位毫秒 */
+/** @return number 延时, 单位毫秒 */
+export type V2NIMReconnectDelayProvider = (defaultDelay: number) => number;