node-nim 9.14.3 → 10.2.0

package/types/qchat_def/system_notification_def.d.ts

@@ -1,172 +1,172 @@
-import { QChatMessageUpdateInfo } from './message_def';
-import { NIMQChatSystemNotificationType, NIMQChatSystemNotificationStatus, QChatBaseResp, NIMQChatSystemNotificationToType } from './public_def';
-/** @interface QChatSystemNotification */
-export interface QChatSystemNotification {
-    /** 消息通知目标 */
-    to_type: NIMQChatSystemNotificationToType;
-    /** 消息所属的server id */
-    server_id?: string;
-    /** 消息所属的channel id */
-    channel_id?: string;
-    /** 消息id */
-    msg_id?: string;
-    /** 系统消息类型 */
-    msg_type?: NIMQChatSystemNotificationType;
-    /** 消息内容 */
-    msg_body?: string;
-    /** 消息附件 */
-    msg_attach?: string;
-    /** 消息扩展字段 */
-    msg_ext?: string;
-    /** 重发标记，false:不是重发，true:是重发 */
-    resend_flag?: boolean;
-    /** 通知接受者账号列表 */
-    to_accids?: Array<string>;
-    /** false 或者 true, 是否存离线，只有 to_accids 不为空，才能设置为存离线，默认 false */
-    history_enable?: boolean;
-    /** 自定义的推送属性，限制json */
-    push_payload?: string;
-    /** 自定义的推送内容 */
-    push_content?: string;
-    /** 是否需要推送, false: 不需要, true: 需要, 默认 false */
-    push_enable?: boolean;
-    /** 是否需要消息计数, false: 不需要, true: 需要, 默认 true */
-    need_badge?: boolean;
-    /** 是否需要推送昵称, false: 不需要, true: 需要, 默认 true */
-    need_push_nick?: boolean;
-    /** 是否需要抄送, false: 不需要, true: 需要, 默认 true */
-    route_enable?: boolean;
-    /** 环境变量，用于指向不同的抄送、第三方回调等配置 */
-    env?: string;
-    /** 消息状态 */
-    status?: NIMQChatSystemNotificationStatus;
-    /** 消息服务器端id */
-    msg_server_id?: string;
-    /** 消息发送者的accid */
-    from_accid?: string;
-    /** 消息发送者的客户端类型 */
-    from_client_type?: number;
-    /** 消息发送者的设备id */
-    from_device_id?: string;
-    /** 消息发送者的昵称 */
-    from_nick?: string;
-    /** 消息发送时间戳 */
-    timestamp?: number;
-    /** 消息更新时间戳 */
-    update_timestamp?: number;
-    /** 回调扩展字段 */
-    callback_ext?: string;
-}
-/** @interface QChatTypingEvent */
-export interface QChatTypingEvent {
-    /** 事件所属的server id */
-    server_id?: string;
-    /** 事件所属的channel id */
-    channel_id?: string;
-    /** 事件扩展字段 */
-    extension?: string;
-    /** 事件发送者的accid */
-    from_accid?: string;
-    /** 事件发送者的昵称 */
-    from_nick?: string;
-    /** 事件发送时间戳 */
-    timestamp?: number;
-}
-/** @interface QChatRecvSystemNotificationResp */
-export interface QChatRecvSystemNotificationResp {
-    /** 系统消息 */
-    notification?: QChatSystemNotification;
-}
-/** @interface QChatSystemNotificationUpdatedResp */
-export interface QChatSystemNotificationUpdatedResp {
-    /** 操作结果, 参考NIMResCode */
-    res_code?: number;
-    /** 消息更新信息 */
-    update_info?: QChatMessageUpdateInfo;
-    /** 消息体 */
-    notification?: QChatSystemNotification;
-}
-/** @interface QChatSendSystemNotificationResp */
-export interface QChatSendSystemNotificationResp {
-    /** 操作结果, 参考NIMResCode */
-    res_code?: number;
-    /** 系统消息 */
-    notification?: QChatSystemNotification;
-}
-/** @interface QChatUpdateSystemNotificationResp */
-export interface QChatUpdateSystemNotificationResp {
-    /** 操作结果, 参考NIMResCode */
-    res_code?: number;
-    /** 系统消息 */
-    notification?: QChatSystemNotification;
-}
-/** @interface QChatMarkReadSystemNotificationResp */
-export type QChatMarkReadSystemNotificationResp = QChatBaseResp;
-/** @interface QChatMarkSystemNotificationsReadResp */
-export type QChatMarkSystemNotificationsReadResp = QChatBaseResp;
-/** @interface QChatRecvTypingEventResp */
-export interface QChatRecvTypingEventResp {
-    /** 圈组正在输入事件 */
-    typing_event?: QChatTypingEvent;
-}
-/** @interface QChatSendTypingEventResp */
-export interface QChatSendTypingEventResp {
-    /** 操作结果, 参考NIMResCode */
-    res_code?: number;
-    /** 圈组正在输入事件 */
-    typing_event?: QChatTypingEvent;
-}
-/** 接收系统消息回调 */
-export type RecvSystemNotificationCallback = (resp: QChatRecvSystemNotificationResp) => void;
-/** 发送系统消息回调 */
-export type SendSystemNotificationCallback = (resp: QChatSendSystemNotificationResp) => void;
-/** 消息更新回调 */
-export type SystemNotificationUpdatedCallback = (resp: QChatSystemNotificationUpdatedResp) => void;
-/** 更新系统通知回调 */
-export type UpdateSystemNotificationCallback = (resp: QChatUpdateSystemNotificationResp) => void;
-/** 标记系统通知消息已读回调函数 */
-export type MarkReadSystemNotificationCallback = (resp: QChatMarkSystemNotificationsReadResp) => void;
-/** 接收圈组正在输入事件回调 */
-export type RecvTypingEventCallback = (resp: QChatRecvTypingEventResp) => void;
-/** 发送圈组正在输入事件回调 */
-export type SendTypingEventCallback = (resp: QChatSendTypingEventResp) => void;
-/** @interface QChatSendSystemNotificationParam */
-export interface QChatSendSystemNotificationParam {
-    /** 系统消息体 */
-    notification?: QChatSystemNotification;
-}
-/** @interface QChatUpdateSystemNotificationParam */
-export interface QChatUpdateSystemNotificationParam {
-    /** 系统通知服务器ID */
-    msg_server_id?: string;
-    /** 系统通知类型 */
-    msg_type?: NIMQChatSystemNotificationType;
-    /** 消息状态 */
-    status?: NIMQChatSystemNotificationStatus;
-    /** 消息内容 */
-    msg_body?: string;
-    /** 消息扩展字段 */
-    msg_ext?: string;
-    /** 更新信息 */
-    update_info?: QChatMessageUpdateInfo;
-}
-/** @interface NIMQChatSystemNotificationMarkReadInfo */
-export interface NIMQChatSystemNotificationMarkReadInfo {
-    /** 消息服务器 id */
-    msg_server_id?: string;
-    /** 系统通知类型 */
-    msg_type?: NIMQChatSystemNotificationType;
-}
-/** @interface QChatMarkSystemNotificationsReadParam */
-export interface QChatMarkSystemNotificationsReadParam {
-    cb?: MarkReadSystemNotificationCallback;
-    mark_read_infos?: Array<NIMQChatSystemNotificationMarkReadInfo>;
-}
-/** @interface QChatRegRecvTypingEventCbParam */
-export interface QChatRegRecvTypingEventCbParam {
-}
-/** @interface QChatSendTypingEventParam */
-export interface QChatSendTypingEventParam {
-    /** 圈组正在输入事件 */
-    typing_event?: QChatTypingEvent;
-}
+import { QChatMessageUpdateInfo } from './message_def';
+import { NIMQChatSystemNotificationType, NIMQChatSystemNotificationStatus, QChatBaseResp, NIMQChatSystemNotificationToType } from './public_def';
+/** @interface QChatSystemNotification */
+export interface QChatSystemNotification {
+    /** 消息通知目标 */
+    to_type: NIMQChatSystemNotificationToType;
+    /** 消息所属的server id */
+    server_id?: string;
+    /** 消息所属的channel id */
+    channel_id?: string;
+    /** 消息id */
+    msg_id?: string;
+    /** 系统消息类型 */
+    msg_type?: NIMQChatSystemNotificationType;
+    /** 消息内容 */
+    msg_body?: string;
+    /** 消息附件 */
+    msg_attach?: string;
+    /** 消息扩展字段 */
+    msg_ext?: string;
+    /** 重发标记，false:不是重发，true:是重发 */
+    resend_flag?: boolean;
+    /** 通知接受者账号列表 */
+    to_accids?: Array<string>;
+    /** false 或者 true, 是否存离线，只有 to_accids 不为空，才能设置为存离线，默认 false */
+    history_enable?: boolean;
+    /** 自定义的推送属性，限制json */
+    push_payload?: string;
+    /** 自定义的推送内容 */
+    push_content?: string;
+    /** 是否需要推送, false: 不需要, true: 需要, 默认 false */
+    push_enable?: boolean;
+    /** 是否需要消息计数, false: 不需要, true: 需要, 默认 true */
+    need_badge?: boolean;
+    /** 是否需要推送昵称, false: 不需要, true: 需要, 默认 true */
+    need_push_nick?: boolean;
+    /** 是否需要抄送, false: 不需要, true: 需要, 默认 true */
+    route_enable?: boolean;
+    /** 环境变量，用于指向不同的抄送、第三方回调等配置 */
+    env?: string;
+    /** 消息状态 */
+    status?: NIMQChatSystemNotificationStatus;
+    /** 消息服务器端id */
+    msg_server_id?: string;
+    /** 消息发送者的accid */
+    from_accid?: string;
+    /** 消息发送者的客户端类型 */
+    from_client_type?: number;
+    /** 消息发送者的设备id */
+    from_device_id?: string;
+    /** 消息发送者的昵称 */
+    from_nick?: string;
+    /** 消息发送时间戳 */
+    timestamp?: number;
+    /** 消息更新时间戳 */
+    update_timestamp?: number;
+    /** 回调扩展字段 */
+    callback_ext?: string;
+}
+/** @interface QChatTypingEvent */
+export interface QChatTypingEvent {
+    /** 事件所属的server id */
+    server_id?: string;
+    /** 事件所属的channel id */
+    channel_id?: string;
+    /** 事件扩展字段 */
+    extension?: string;
+    /** 事件发送者的accid */
+    from_accid?: string;
+    /** 事件发送者的昵称 */
+    from_nick?: string;
+    /** 事件发送时间戳 */
+    timestamp?: number;
+}
+/** @interface QChatRecvSystemNotificationResp */
+export interface QChatRecvSystemNotificationResp {
+    /** 系统消息 */
+    notification?: QChatSystemNotification;
+}
+/** @interface QChatSystemNotificationUpdatedResp */
+export interface QChatSystemNotificationUpdatedResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: number;
+    /** 消息更新信息 */
+    update_info?: QChatMessageUpdateInfo;
+    /** 消息体 */
+    notification?: QChatSystemNotification;
+}
+/** @interface QChatSendSystemNotificationResp */
+export interface QChatSendSystemNotificationResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: number;
+    /** 系统消息 */
+    notification?: QChatSystemNotification;
+}
+/** @interface QChatUpdateSystemNotificationResp */
+export interface QChatUpdateSystemNotificationResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: number;
+    /** 系统消息 */
+    notification?: QChatSystemNotification;
+}
+/** @interface QChatMarkReadSystemNotificationResp */
+export type QChatMarkReadSystemNotificationResp = QChatBaseResp;
+/** @interface QChatMarkSystemNotificationsReadResp */
+export type QChatMarkSystemNotificationsReadResp = QChatBaseResp;
+/** @interface QChatRecvTypingEventResp */
+export interface QChatRecvTypingEventResp {
+    /** 圈组正在输入事件 */
+    typing_event?: QChatTypingEvent;
+}
+/** @interface QChatSendTypingEventResp */
+export interface QChatSendTypingEventResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: number;
+    /** 圈组正在输入事件 */
+    typing_event?: QChatTypingEvent;
+}
+/** 接收系统消息回调 */
+export type RecvSystemNotificationCallback = (resp: QChatRecvSystemNotificationResp) => void;
+/** 发送系统消息回调 */
+export type SendSystemNotificationCallback = (resp: QChatSendSystemNotificationResp) => void;
+/** 消息更新回调 */
+export type SystemNotificationUpdatedCallback = (resp: QChatSystemNotificationUpdatedResp) => void;
+/** 更新系统通知回调 */
+export type UpdateSystemNotificationCallback = (resp: QChatUpdateSystemNotificationResp) => void;
+/** 标记系统通知消息已读回调函数 */
+export type MarkReadSystemNotificationCallback = (resp: QChatMarkSystemNotificationsReadResp) => void;
+/** 接收圈组正在输入事件回调 */
+export type RecvTypingEventCallback = (resp: QChatRecvTypingEventResp) => void;
+/** 发送圈组正在输入事件回调 */
+export type SendTypingEventCallback = (resp: QChatSendTypingEventResp) => void;
+/** @interface QChatSendSystemNotificationParam */
+export interface QChatSendSystemNotificationParam {
+    /** 系统消息体 */
+    notification?: QChatSystemNotification;
+}
+/** @interface QChatUpdateSystemNotificationParam */
+export interface QChatUpdateSystemNotificationParam {
+    /** 系统通知服务器ID */
+    msg_server_id?: string;
+    /** 系统通知类型 */
+    msg_type?: NIMQChatSystemNotificationType;
+    /** 消息状态 */
+    status?: NIMQChatSystemNotificationStatus;
+    /** 消息内容 */
+    msg_body?: string;
+    /** 消息扩展字段 */
+    msg_ext?: string;
+    /** 更新信息 */
+    update_info?: QChatMessageUpdateInfo;
+}
+/** @interface NIMQChatSystemNotificationMarkReadInfo */
+export interface NIMQChatSystemNotificationMarkReadInfo {
+    /** 消息服务器 id */
+    msg_server_id?: string;
+    /** 系统通知类型 */
+    msg_type?: NIMQChatSystemNotificationType;
+}
+/** @interface QChatMarkSystemNotificationsReadParam */
+export interface QChatMarkSystemNotificationsReadParam {
+    cb?: MarkReadSystemNotificationCallback;
+    mark_read_infos?: Array<NIMQChatSystemNotificationMarkReadInfo>;
+}
+/** @interface QChatRegRecvTypingEventCbParam */
+export interface QChatRegRecvTypingEventCbParam {
+}
+/** @interface QChatSendTypingEventParam */
+export interface QChatSendTypingEventParam {
+    /** 圈组正在输入事件 */
+    typing_event?: QChatTypingEvent;
+}

package/types/v2/v2_nim_chatroom_client.d.ts

@@ -0,0 +1,73 @@
+import { V2NIMInitOption, V2NIMError, V2NIMChatroomEnterParams, V2NIMChatroomEnterResult, V2NIMChatroomInfo, V2NIMChatroomKickedInfo } from 'ts/v2_def/v2_nim_struct_def';
+import { EventEmitter } from 'eventemitter3';
+import { V2NIMChatroomService } from './v2_nim_chatroom_service';
+import { V2NIMStorageService } from './v2_nim_storage_service';
+export declare interface V2NIMChatroomClientEvents {
+    /** @brief 聊天室状态 */
+    chatroomStatus: (status: number, error: V2NIMError) => void;
+    /** @brief 进入聊天室 */
+    chatroomEntered: () => void;
+    /** @brief 退出聊天室 */
+    chatroomExited: (error: V2NIMError) => void;
+    /** @brief 自己被踢出聊天室 */
+    chatroomKicked: (kickedInfo: V2NIMChatroomKickedInfo) => void;
+}
+export declare class V2NIMChatroomClient extends EventEmitter<V2NIMChatroomClientEvents> {
+    instance: any;
+    chatroomService: V2NIMChatroomService;
+    storageService: V2NIMStorageService;
+    static chatroomSdk: any;
+    constructor(instanceId?: number);
+    /** @brief 初始化 */
+    /** @param option 初始化选项 */
+    /** @return V2NIMError */
+    static init(option: V2NIMInitOption): V2NIMError | null;
+    /** @brief 反初始化 */
+    /** @return void */
+    /** @warning 请在退出程序前调用此方法 */
+    static uninit(): void;
+    /** @brief 创建聊天室客户端实例 */
+    /** @return V2NIMChatroomClient */
+    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    /** @note 建议保存持有实例 ID 而不是实例本身 */
+    static newInstance(): V2NIMChatroomClient;
+    /** @brief 销毁聊天室客户端实例 */
+    /** @param instanceId 聊天室客户端实例 ID */
+    /** @return void */
+    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    /** @warning 严禁在调用此方法后访问对应的聊天室客户端实例 */
+    static destroyInstance(instanceId: number): void;
+    /** @brief 获取聊天室客户端实例 */
+    /** @return V2NIMChatroomClient */
+    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    static getInstance(instanceId: number): V2NIMChatroomClient | null;
+    /** @brief 获取聊天室实例列表 */
+    /** @return Array<V2NIMChatroomClient> */
+    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    static getInstanceList(): Array<V2NIMChatroomClient>;
+    /** @brief 销毁所有聊天室客户端实例 */
+    /** @return void */
+    /** @pre 必须在调用此方法前调用 V2NIMChatroomClient::init */
+    /** @warning 严禁在调用此方法后访问任何聊天室客户端实例, 此方法会退出聊天室, 耗时可能较长 */
+    static destroyAll(): void;
+    /** @brief 获取聊天室客户端实例 ID */
+    /** @return size_t */
+    getInstanceId(): number;
+    /** @brief 进入聊天室 */
+    /** @param roomId 聊天室 ID */
+    /** @param enterParams 进入聊天室相关参数 */
+    /** @return void */
+    enter(roomId: string, enterParams: V2NIMChatroomEnterParams): Promise<V2NIMChatroomEnterResult>;
+    /** @brief 退出聊天室 */
+    /** @return void */
+    exit(): void;
+    /** @brief 查询聊天室信息 */
+    /** @return V2NIMChatroomInfo */
+    getChatroomInfo(): V2NIMChatroomInfo;
+    /** @brief 获取聊天室服务 */
+    /** @return V2NIMChatroomService */
+    getChatroomService(): V2NIMChatroomService;
+    /** @brief 获取存储服务 */
+    /** @return V2NIMStorageService */
+    getStorageService(): V2NIMStorageService;
+}

package/types/v2/v2_nim_chatroom_service.d.ts

@@ -0,0 +1,114 @@
+import EventEmitter from 'eventemitter3';
+import { V2NIMChatroomMessage, V2NIMChatroomMember, V2NIMChatroomInfo, V2NIMSendChatroomMessageParams, V2NIMSendChatroomMessageResult, V2NIMChatroomMemberQueryOption, V2NIMChatroomMemberListResult, V2NIMChatroomMessageListOption, V2NIMChatroomMemberRoleUpdateParams, V2NIMChatroomUpdateParams, V2NIMAntispamConfig, V2NIMChatroomSelfMemberUpdateParams, V2NIMChatroomTagTempChatBannedParams, V2NIMChatroomTagMemberOption, V2NIMChatroomLocationConfig, V2NIMChatroomTagsUpdateParams, V2NIMChatroomTagMessageOption } from 'ts/v2_def/v2_nim_struct_def';
+export declare interface V2NIMChatroomServiceEvents {
+    /** 收到新消息 */
+    receiveMessages: [V2NIMChatroomMessage[]];
+    /** 聊天室成员进入 */
+    chatroomMemberEnter: [V2NIMChatroomMember];
+    /** 聊天室成员退出 */
+    chatroomMemberExit: [string];
+    /** 聊天室成员角色变更 */
+    chatroomMemberRoleUpdated: [V2NIMChatroomMemberRole, V2NIMChatroomMember];
+    /** 聊天室成员信息更新 */
+    chatroomMemberInfoUpdated: [V2NIMChatroomMember];
+    /** 自己的禁言状态变更 */
+    selfChatBannedUpdated: [boolean];
+    /** 自己的临时禁言状态变更 */
+    selfTempChatBannedUpdated: [boolean, number];
+    /** 聊天室信息更新 */
+    chatroomInfoUpdated: [V2NIMChatroomInfo];
+    /** 聊天室禁言状态更新 */
+    chatroomChatBannedUpdated: [boolean];
+    /** 消息撤回回调 */
+    messageRevokedNotification: [string, number];
+    /** 角色标签更新 */
+    chatroomTagsUpdated: [string[]];
+}
+/** @brief 聊天室服务 */
+export declare class V2NIMChatroomService extends EventEmitter<V2NIMChatroomServiceEvents> {
+    instance: any;
+    constructor(instanceId: number);
+    /** @brief 发送消息 */
+    /** @param message 需要发送的消息体 */
+    /** @param params 发送消息相关配置参数 */
+    /** @return void */
+    sendMessage(message: V2NIMChatroomMessage, params: V2NIMSendChatroomMessageParams): Promise<V2NIMSendChatroomMessageResult>;
+    /** @brief 取消文件消息附件上传 */
+    /** @param message 要取消上传的文件消息 */
+    cancelMessageAttachmentUpload(message: V2NIMChatroomMessage): Promise<void>;
+    /** @brief 分页获取聊天室成员列表 */
+    /** @param queryOption 查询选项 */
+    /** @return void */
+    getMemberListByOption(queryOption: V2NIMChatroomMemberQueryOption): Promise<V2NIMChatroomMemberListResult>;
+    /** @brief 查询历史消息 */
+    /** @param option 查询选项 */
+    /** @return void */
+    getMessageList(option: V2NIMChatroomMessageListOption): Promise<Array<V2NIMChatroomMessage>>;
+    /** @brief 更新聊天室成员角色 */
+    /** @param accountId 聊天室成员 id */
+    /** @param upadateParams 更新参数 */
+    /** @return void */
+    updateMemberRole(accountId: string, upadateParams: V2NIMChatroomMemberRoleUpdateParams): Promise<void>;
+    /** @brief 设置聊天室成员黑名单状态 */
+    /** @param accountId 聊天室成员 id */
+    /** @param blocked 黑名单状态 */
+    /** @param notificationExtension 通知扩展字段 */
+    /** @return void */
+    setMemberBlockedStatus(accountId: string, blocked: boolean, notificationExtension: string): Promise<void>;
+    /** @brief 设置聊天室成员禁言状态 */
+    /** @param accountId 聊天室成员 id */
+    /** @param chatBanned 禁言状态 */
+    /** @param notificationExtension 通知扩展字段 */
+    /** @return void */
+    setMemberChatBannedStatus(accountId: string, chatBanned: boolean, notificationExtension: string): Promise<void>;
+    /** @brief 设置聊天室成员临时禁言状态 */
+    /** @param accountId 聊天室成员 id */
+    /** @param tempChatBannedDuration 临时禁言时长, 单位秒, 0 表示取消临时禁言 */
+    /** @param notificationEnabled 是否发送通知 */
+    /** @param notificationExtension 通知扩展字段 */
+    /** @return void */
+    setMemberTempChatBanned(accountId: string, tempChatBannedDuration: number, notificationEnabled: boolean, notificationExtension: string): Promise<void>;
+    /** @brief 更新聊天室信息 */
+    /** @param updateParams 更新参数 */
+    /** @param antispamConfig 反垃圾配置 */
+    /** @return void */
+    updateChatroomInfo(updateParams: V2NIMChatroomUpdateParams, antispamConfig: V2NIMAntispamConfig): Promise<void>;
+    /** @brief 更新自己在聊天室的成员信息 */
+    /** @param updateParams 更新参数 */
+    /** @param antispamConfig 反垃圾配置 */
+    /** @return void */
+    updateSelfMemberInfo(updateParams: V2NIMChatroomSelfMemberUpdateParams, antispamConfig: V2NIMAntispamConfig): Promise<void>;
+    /** @brief 根据账号列表查询成员信息 */
+    /** @param accountIds 账号列表 */
+    /** @return void */
+    getMemberByIds(accountIds: Array<string>): Promise<Array<V2NIMChatroomMember>>;
+    /** @brief 踢出聊天室成员 */
+    /** @param accountId 聊天室成员 id */
+    /** @param notificationExtension 通知扩展字段 */
+    /** @return void */
+    kickMember(accountId: string, notificationExtension: string): Promise<void>;
+    /** @brief 按聊天室标签临时禁言 */
+    /** @param params 设置标签禁言的参数 */
+    /** @return void */
+    setTempChatBannedByTag(params: V2NIMChatroomTagTempChatBannedParams): Promise<void>;
+    /** @brief 根据标签查询成员列表 */
+    /** @param option 查询成员列表的参数 */
+    /** @return void */
+    getMemberListByTag(option: V2NIMChatroomTagMemberOption): Promise<V2NIMChatroomMemberListResult>;
+    /** @brief 查询某个标签下的成员人数 */
+    /** @param tag 标签 */
+    /** @return void */
+    getMemberCountByTag(tag: string): Promise<number>;
+    /** @brief 更新坐标信息 */
+    /** @param locationConfig 坐标信息 */
+    /** @return void */
+    updateChatroomLocationInfo(locationConfig: V2NIMChatroomLocationConfig): Promise<void>;
+    /** @brief 更新聊天室 tag 信息 */
+    /** @param updateParams tag 更新的参数 */
+    /** @return void */
+    updateChatroomTags(updateParams: V2NIMChatroomTagsUpdateParams): Promise<void>;
+    /** @brief 根据标签查询消息列表 */
+    /** @param messageOption 查询参数 */
+    /** @return void */
+    getMessageListByTag(messageOption: V2NIMChatroomTagMessageOption): Promise<Array<V2NIMChatroomMessage>>;
+}

package/types/v2/v2_nim_client.d.ts

@@ -0,0 +1,75 @@
+import { V2NIMInitOption, V2NIMError } from 'ts/v2_def/v2_nim_struct_def';
+import { EventEmitter } from 'eventemitter3';
+import { V2NIMLoginService } from './v2_nim_login_service';
+import { V2NIMConversationGroupService } from './v2_nim_conversation_group_service';
+import { V2NIMConversationService } from './v2_nim_conversation_service';
+import { V2NIMMessageService } from './v2_nim_message_service';
+import { V2NIMNotificationService } from './v2_nim_notification_service';
+import { V2NIMStorageService } from './v2_nim_storage_service';
+import { V2NIMConversationIdUtil, V2NIMMessageCreator, V2NIMClientAntispamUtil } from './v2_nim_utilities';
+import { V2NIMTeamService } from './v2_nim_team_service';
+import { V2NIMSettingService } from './v2_nim_setting_service';
+import { V2NIMFriendService } from './v2_nim_friend_service';
+import { V2NIMUserService } from './v2_nim_user_service';
+export declare interface V2NIMClientEvents {
+}
+export declare class V2NIMClient extends EventEmitter<V2NIMClientEvents> {
+    instance: any;
+    conversationIdUtil: V2NIMConversationIdUtil | null;
+    messageCreator: V2NIMMessageCreator | null;
+    clientAntispamUtil: V2NIMClientAntispamUtil | null;
+    loginService: V2NIMLoginService | null;
+    conversationService: V2NIMConversationService | null;
+    conversationGroupService: V2NIMConversationGroupService | null;
+    messageService: V2NIMMessageService | null;
+    notificationService: V2NIMNotificationService | null;
+    storageService: V2NIMStorageService | null;
+    teamService: V2NIMTeamService | null;
+    settingService: V2NIMSettingService | null;
+    userService: V2NIMUserService | null;
+    friendService: V2NIMFriendService | null;
+    constructor();
+    /**
+     * 初始化
+     * @param option - 初始化选项
+     * @returns V2NIMError | null
+     * @example
+     */
+    init(option: V2NIMInitOption): V2NIMError | null;
+    /**  @brief 反初始化
+     * @return V2NIMError | null
+     */
+    uninit(): V2NIMError | null;
+    /** @brief 获取登录服务
+     * @return V2NIMLoginService
+     */
+    getLoginService(): V2NIMLoginService | null;
+    /** @brief 获取会话服务
+    /* @return V2NIMConversationService
+    */
+    getConversationService(): V2NIMConversationService | null;
+    /** @brief 获取会话分组服务
+     * @return V2NIMConversationGroupService
+     */
+    getConversationGroupService(): V2NIMConversationGroupService | null;
+    /** @brief 获取消息服务
+     * @return V2NIMMessageService
+     */
+    getMessageService(): V2NIMMessageService | null;
+    /** @brief 获取通知服务
+     * @return V2NIMNotificationService
+     */
+    getNotificationService(): V2NIMNotificationService | null;
+    /** @brief 获取存储服务
+     * @return V2NIMStorageService
+     */
+    getStorageService(): V2NIMStorageService | null;
+    /** @brief 获取群组服务
+     * @return V2NIMTeamService
+     */
+    getTeamService(): V2NIMTeamService | null;
+    /** @brief 获取设置服务
+     * @return V2NIMSettingService
+     */
+    getSettingService(): V2NIMSettingService | null;
+}

package/types/v2/v2_nim_conversation_group_service.d.ts

@@ -0,0 +1,54 @@
+import { V2NIMConversationGroup, V2NIMConversation, V2NIMConversationGroupResult, V2NIMConversationOperationResult } from 'ts/v2_def/v2_nim_struct_def';
+import { EventEmitter } from 'eventemitter3';
+export declare interface V2NIMConversationGroupServiceEvents {
+    /** 会话分组创建通知 */
+    conversationGroupCreated: [V2NIMConversationGroup];
+    /** 会话分组删除通知 */
+    conversationGroupDeleted: [string];
+    /** 会话分组更新通知 */
+    conversationGroupChanged: [V2NIMConversationGroup];
+    /** 会话加入会话分组通知 */
+    conversationsAddedToGroup: [string, Array<V2NIMConversation>];
+    /** 会话移出会话分组通知 */
+    conversationsRemovedFromGroup: [string, string[]];
+}
+export declare class V2NIMConversationGroupService extends EventEmitter<V2NIMConversationGroupServiceEvents> {
+    instance: any;
+    constructor();
+    /** @brief 创建会话分组
+     * @param name 会话分组名称
+     * @param conversationIds 会话 ID 列表
+     */
+    createConversationGroup(name: string, serverExtension?: string, conversationIds?: string[]): Promise<V2NIMConversationGroupResult>;
+    /** @brief 删除会话分组
+     * @param groupId 会话分组 ID
+     */
+    deleteConversationGroup(groupId: string): Promise<void>;
+    /** @brief 更新会话分组
+     * @param groupId 会话分组 ID
+     * @param name 新的会话分组名称
+     * @param serverExtension 扩展字段
+     */
+    updateConversationGroup(groupId: string, name?: string, serverExtension?: string): Promise<void>;
+    /** @brief 添加会话到会话分组
+     * @param groupId 会话分组 ID
+     * @param conversationIds 会话 ID 列表
+     */
+    addConversationsToGroup(groupId: string, conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
+    /** @brief 从会话分组中移除会话
+     * @param groupId 会话分组 ID
+     * @param conversationIds 会话 ID 列表
+     */
+    removeConversationsFromGroup(groupId: string, conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
+    /** @brief 获取会话分组信息
+     * @param groupId 会话分组 ID
+     */
+    getConversationGroup(groupId: string): Promise<V2NIMConversationGroup>;
+    /** @brief 获取会话分组列表
+     */
+    getConversationGroupList(): Promise<Array<V2NIMConversationGroup>>;
+    /** @brief 根据会话分组 ID 获取会话分组
+     * @param groupId 会话分组 ID
+     */
+    getConversationGroupListByIds(groupIds: string[]): Promise<Array<V2NIMConversationGroup>>;
+}