node-nim 9.2.8-rc.1 → 9.3.0-rc.2

package/types/qchat/message.d.ts

@@ -0,0 +1,110 @@
+import { EventEmitter } from 'eventemitter3';
+import { QChatSendMessageParam, QChatUpdateMessageParam, QChatRevokeMessageParam, QChatDeleteMessageParam, QChatGetMessagesParam, QChatGetMessagesCacheParam, QChatGetLastMessagesParam, QChatMarkMessageReadParam, QChatReplyMessageParam, QChatGetMessageHistoryByIdsParam, QChatGetReferMessagesParam, QChatGetThreadMessagesParam, QChatGetThreadRootMessagesMetaParam, QChatAddQuickCommentParam, QChatRemoveQuickCommentParam, QChatGetQuickCommentsParam, QChatAddQuickCommentResp, QChatGetLastMessagesResp, QChatGetMessageHistoryByIdsResp, QChatGetMessagesCacheResp, QChatGetMessagesResp, QChatGetQuickCommentsResp, QChatGetReferMessagesResp, QChatGetThreadMessagesResp, QChatGetThreadRootMessagesMetaResp, QChatMarkMessageReadResp, QChatRemoveQuickCommentResp, QChatReplyMessageResp, QChatSendMessageResp, QChatUpdateMessageResp, QChatMsgUpdatedResp, QChatRecvMsgResp } from '../qchat_def/message_def';
+export declare interface QChatMessageEvents {
+    /** 新消息通知 */
+    message: [QChatRecvMsgResp];
+    /** 消息变更通知 */
+    update: [QChatMsgUpdatedResp];
+}
+export declare class QChatMessageModule extends EventEmitter<QChatMessageEvents> {
+    instance: any;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** @fn send(param: QChatSendMessageParam)
+     * 发送消息
+     * @param[in] param 接口参数 @see QChatSendMessageParam
+     * @return void
+     */
+    send(param: QChatSendMessageParam): Promise<QChatSendMessageResp>;
+    /** @fn update(param: QChatUpdateMessageParam)
+     * 更新消息
+     * @param[in] param 接口参数 @see QChatUpdateMessageParam
+     */
+    update(param: QChatUpdateMessageParam): Promise<QChatUpdateMessageResp>;
+    /** @fn revoke(param: QChatRevokeMessageParam)
+     * 撤回消息，撤回未读消息不影响未读数
+     * @param[in] param 接口参数 @see QChatRevokeMessageParam
+     * @return void
+     */
+    revoke(param: QChatRevokeMessageParam): Promise<QChatUpdateMessageResp>;
+    /** @fn delete(param: QChatDeleteMessageParam)
+     * 删除消息，删除未读消息影响未读数
+     * @param[in] param 接口参数 @see QChatDeleteMessageParam
+     * @return void
+     */
+    delete(param: QChatDeleteMessageParam): Promise<QChatUpdateMessageResp>;
+    /** @fn getMessages(param: QChatGetMessagesParam)
+     * 查询历史消息
+     * @param[in] param 接口参数 @see QChatGetMessagesParam
+     * @return void
+     */
+    getMessages(param: QChatGetMessagesParam): Promise<QChatGetMessagesResp>;
+    /** @fn getMessagesCache(param: QChatGetMessagesCacheParam)
+     * @brief 查询本地消息历史缓存, 仅用于无网络情况或加速页面显示时使用，恢复通信后应使用GetMessages的结果进行覆盖
+     *
+     * @param param 要查询的服务器、频道信息 @see QChatGetMessagesCacheParam
+     * @return void
+     */
+    getMessagesCache(param: QChatGetMessagesCacheParam): Promise<QChatGetMessagesCacheResp>;
+    /** @fn getLastMessages(param: QChatGetLastMessagesParam)
+     * 查询频道最后一条消息
+     * @param[in] param 接口参数 @see QChatGetLastMessagesParam
+     * @return void
+     */
+    getLastMessages(param: QChatGetLastMessagesParam): Promise<QChatGetLastMessagesResp>;
+    /** @fn markRead(param: QChatMarkMessageReadParam)
+     * 标记消息已读
+     * @param[in] param 接口参数 @see QChatMarkMessageReadParam
+     * @return void
+     */
+    markRead(param: QChatMarkMessageReadParam): Promise<QChatMarkMessageReadResp>;
+    /** @fn reply(param: QChatReplyMessageParam)
+     * @brief 回复指定消息
+     * @since v9.1.0
+     * @param[in] param 接口参数 @see QChatReplyMessageParam
+     */
+    reply(param: QChatReplyMessageParam): Promise<QChatReplyMessageResp>;
+    /** @fn getMessageHistoryByIds(param: QChatGetMessageHistoryByIdsParam)
+     * @brief 通过一组消息 ID 查询消息详情
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatGetMessageHistoryByIdsParam
+     */
+    getMessageHistoryByIds(param: QChatGetMessageHistoryByIdsParam): Promise<QChatGetMessageHistoryByIdsResp>;
+    /** @fn getReferMessages(param: QChatGetReferMessagesParam)
+     * @brief 获取指定消息的引用消息内容
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatGetReferMessagesParam
+     */
+    getReferMessages(param: QChatGetReferMessagesParam): Promise<QChatGetReferMessagesResp>;
+    /** @fn getThreadMessages(param: QChatGetThreadMessagesParam)
+     * @brief 分页获取一个 thread 消息得详细回复消息列表
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatGetThreadMessagesParam
+     */
+    getThreadMessages(param: QChatGetThreadMessagesParam): Promise<QChatGetThreadMessagesResp>;
+    /** @fn getThreadRootMessagesMeta(param: QChatGetThreadRootMessagesMetaParam)
+     * @brief 获取一批 thread root 消息的基本信息（回复次数，最后回复时间）
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatGetThreadRootMessagesMetaParam
+     */
+    getThreadRootMessagesMeta(param: QChatGetThreadRootMessagesMetaParam): Promise<QChatGetThreadRootMessagesMetaResp>;
+    /** @fn addQuickComment(param: QChatAddQuickCommentParam)
+     * @brief 对指定消息添加快捷评论
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatAddQuickCommentParam
+     */
+    addQuickComment(param: QChatAddQuickCommentParam): Promise<QChatAddQuickCommentResp>;
+    /** @fn removeQuickComment(param: QChatRemoveQuickCommentParam)
+     * @brief 从某个消息上移除快捷评论
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatRemoveQuickComm entParam
+     */
+    removeQuickComment(param: QChatRemoveQuickCommentParam): Promise<QChatRemoveQuickCommentResp>;
+    /** @fn getQuickComments(param: QChatGetQuickCommentsParam)
+     * @brief 获取指定消息包含的快捷评论列表
+     * @since v9.1.0
+     * @param param 接口参数 @see QChatGetQuickCommentsParam
+     */
+    getQuickComments(param: QChatGetQuickCommentsParam): Promise<QChatGetQuickCommentsResp>;
+}

package/types/qchat/role.d.ts

@@ -0,0 +1,161 @@
+import { EventEmitter } from 'eventemitter3';
+import { QChatCreateServerRoleParam, QChatUpdateServerRoleParam, QChatUpdateServerRolePrioritiesParam, QChatDeleteServerRoleParam, QChatGetServerRolesParam, QChatAddMembersToServerRoleParam, QChatRemoveMembersFromServerRoleParam, QChatGetMembersFromServerRoleParam, QChatAddChannelRoleParam, QChatUpdateChannelRoleParam, QChatRemoveChannelRoleParam, QChatGetChannelRolesParam, QChatAddMemberRoleParam, QChatUpdateMemberRoleParam, QChatRemoveMemberRoleParam, QChatGetMemberRolesParam, QChatGetRolesByAccidParam, QChatGetExistingServerRolesByAccidsParam, QChatGetExistingChannelRolesByServerRoleIdsParam, QChatGetExistingAccidsOfMemberRolesParam, QChatGetExistingAccidsInServerRoleParam, QChatCheckPermissionParam, QChatAddChannelCategoryRoleParam, QChatRemoveChannelCategoryRoleParam, QChatUpdateChannelCategoryRoleParam, QChatGetChannelCategoryRolesPageParam, QChatAddChannelCategoryMemberRoleParam, QChatRemoveChannelCategoryMemberRoleParam, QChatUpdateChannelCategoryMemberRoleParam, QChatGetChannelCategoryMemberRolesPageParam, QChatAddChannelCategoryMemberRoleResp, QChatAddChannelCategoryRoleResp, QChatAddChannelRoleResp, QChatAddMemberRoleResp, QChatAddMembersToServerRoleResp, QChatCheckPermissionResp, QChatCreateServerRoleResp, QChatDeleteServerRoleResp, QChatGetChannelCategoryMemberRolesPageResp, QChatGetChannelCategoryRolesPageResp, QChatGetChannelRolesResp, QChatGetExistingAccidsInServerRoleResp, QChatGetExistingAccidsOfMemberRolesResp, QChatGetExistingChannelRolesByServerRoleIdsResp, QChatGetExistingServerRolesByAccidsResp, QChatGetMemberRolesResp, QChatGetMembersFromServerRoleResp, QChatGetRolesByAccidResp, QChatGetServerRolesResp, QChatRemoveChannelCategoryMemberRoleResp, QChatRemoveChannelCategoryRoleResp, QChatRemoveChannelRoleResp, QChatRemoveMemberRoleResp, QChatRemoveMembersFromServerRoleResp, QChatUpdateChannelCategoryMemberRoleResp, QChatUpdateChannelCategoryRoleResp, QChatUpdateChannelRoleResp, QChatUpdateMemberRoleResp, QChatUpdateServerRolePrioritiesResp, QChatUpdateServerRoleResp } from '../qchat_def/role_def';
+export declare interface QChatRoleEvents {
+}
+export declare class QChatRoleModule extends EventEmitter<QChatRoleEvents> {
+    instance: any;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** @fn createServerRole(param: QChatCreateServerRoleParam)
+     * @brief 在服务器中创建一个身份组
+     * @param param 参数见 @see QChatCreateServerRoleParam
+     */
+    createServerRole(param: QChatCreateServerRoleParam): Promise<QChatCreateServerRoleResp>;
+    /** @fn updateServerRole(param: QChatUpdateServerRoleParam)
+     * @brief 更新服务器中指定身份组
+     * @param param 参数见 @see QChatUpdateServerRoleParam
+     */
+    updateServerRole(param: QChatUpdateServerRoleParam): Promise<QChatUpdateServerRoleResp>;
+    /** @fn updateServerRolePriorities(param: QChatUpdateServerRolePrioritiesParam)
+     * @brief 批量更新服务器身份组优先级，如果具备修改身份组优先级权限，则服务器会应用您传递的参数中身份组优先级列表所有的内容
+     * 如在 UI 展示中，允许拖拽对身份组优先级进行排序，则在排序完成后将最终的排序列表传递到参数中即可。
+     * @param param 参数见 @see QChatUpdateServerRolePrioritiesParam
+     */
+    updateServerRolePriorities(param: QChatUpdateServerRolePrioritiesParam): Promise<QChatUpdateServerRolePrioritiesResp>;
+    /** @fn deleteServerRole(param: QChatDeleteServerRoleParam)
+     * @brief 从服务器中删除指定身份组
+     * @param param 参数见 @see QChatDeleteServerRoleParam
+     */
+    deleteServerRole(param: QChatDeleteServerRoleParam): Promise<QChatDeleteServerRoleResp>;
+    /** @fn getServerRoles(param: QChatGetServerRolesParam)
+     * @brief 获取指定服务器下已创建的身份组列表
+     * @param param 参数见 @see QChatGetServerRolesParam
+     */
+    getServerRoles(param: QChatGetServerRolesParam): Promise<QChatGetServerRolesResp>;
+    /** @fn addMembersToServerRole(param: QChatAddMembersToServerRoleParam)
+     * @brief 添加部分成员到服务器指定的身份组中
+     * @param param 参数见 @see QChatAddMembersToServerRoleParam
+     */
+    addMembersToServerRole(param: QChatAddMembersToServerRoleParam): Promise<QChatAddMembersToServerRoleResp>;
+    /** @fn removeMembersFromServerRole(param: QChatRemoveMembersFromServerRoleParam)
+     * @brief 从服务器指定身份组移除部分成员
+     * @param param 参数见 @see QChatRemoveMembersFromServerRoleParam
+     */
+    removeMembersFromServerRole(param: QChatRemoveMembersFromServerRoleParam): Promise<QChatRemoveMembersFromServerRoleResp>;
+    /** @fn getMembersFromServerRole(param: QChatGetMembersFromServerRoleParam)
+     * @brief 分页从服务器指定身份组中查询成员列表
+     * @param param 参数见 @see QChatGetMembersFromServerRoleParam
+     */
+    getMembersFromServerRole(param: QChatGetMembersFromServerRoleParam): Promise<QChatGetMembersFromServerRoleResp>;
+    /** @fn addChannelRole(param: QChatAddChannelRoleParam)
+     * @brief 添加一个身份组到频道
+     * @param param 参数见 @see QChatAddChannelRoleParam
+     */
+    addChannelRole(param: QChatAddChannelRoleParam): Promise<QChatAddChannelRoleResp>;
+    /** @fn updateChannelRole(param: QChatUpdateChannelRoleParam)
+     * @brief 更新频道中指定身份组的信息
+     * @param param 参数见 @see QChatUpdateChannelRoleParam
+     */
+    updateChannelRole(param: QChatUpdateChannelRoleParam): Promise<QChatUpdateChannelRoleResp>;
+    /** @fn removeChannelRole(param: QChatRemoveChannelRoleParam)
+     * @brief 从频道中移除指定身份组
+     * @param param 参数见 @see QChatRemoveChannelRoleParam
+     */
+    removeChannelRole(param: QChatRemoveChannelRoleParam): Promise<QChatRemoveChannelRoleResp>;
+    /** @fn getChannelRoles(param: QChatGetChannelRolesParam)
+     * @brief 获取频道下所有已分配的身份组信息
+     * @param param 参数见 @see QChatGetChannelRolesParam
+     */
+    getChannelRoles(param: QChatGetChannelRolesParam): Promise<QChatGetChannelRolesResp>;
+    /** @fn addMemberRole(param: QChatAddMemberRoleParam)
+     * @brief 在频道中添加针对指定人的特殊权限配置
+     * @param param 参数见 @see QChatAddMemberRoleParam
+     */
+    addMemberRole(param: QChatAddMemberRoleParam): Promise<QChatAddMemberRoleResp>;
+    /** @fn updateMemberRole(param: QChatUpdateMemberRoleParam)
+     * @brief 更新频道中指定人的特殊权限配置
+     * @param param 参数见 @see QChatUpdateMemberRoleParam
+     */
+    updateMemberRole(param: QChatUpdateMemberRoleParam): Promise<QChatUpdateMemberRoleResp>;
+    /** @fn removeMemberRole(param: QChatRemoveMemberRoleParam)
+     * @brief 从频道中移除指定人的特殊权限配置
+     * @param param 参数见 @see QChatRemoveMemberRoleParam
+     */
+    removeMemberRole(param: QChatRemoveMemberRoleParam): Promise<QChatRemoveMemberRoleResp>;
+    /** @fn getMemberRoles(param: QChatGetMemberRolesParam)
+     * @brief 分页获取频道下所有针对人的特殊权限配置列表
+     * @param param 参数见 @see QChatGetMemberRolesParam
+     */
+    getMemberRoles(param: QChatGetMemberRolesParam): Promise<QChatGetMemberRolesResp>;
+    /** @fn getRolesByAccid(param: QChatGetRolesByAccidParam)
+     * @brief 根据用户 ID 获取其已经分配的身份组列表
+     * @param param 参数见 @see QChatGetRolesByAccidParam
+     */
+    getRolesByAccid(param: QChatGetRolesByAccidParam): Promise<QChatGetRolesByAccidResp>;
+    /** @fn getExistingServerRolesByAccids(param: QChatGetExistingServerRolesByAccidsParam)
+     * @brief 根据一组用户列表查询该列表下所有用户的身份组列表信息
+     * @param param 参数见 @see QChatGetExistingServerRolesByAccidsParam
+     */
+    getExistingServerRolesByAccids(param: QChatGetExistingServerRolesByAccidsParam): Promise<QChatGetExistingServerRolesByAccidsResp>;
+    /** @fn getExistingChannelRolesByServerRoleIds(param: QChatGetExistingChannelRolesByServerRoleIdsParam)
+     * @brief 根据一组身份组列表查询频道中已经存在的身份组
+     * @param param 参数见 @see QChatGetExistingChannelRolesByServerRoleIdsParam
+     */
+    getExistingChannelRolesByServerRoleIds(param: QChatGetExistingChannelRolesByServerRoleIdsParam): Promise<QChatGetExistingChannelRolesByServerRoleIdsResp>;
+    /** @fn getExistingAccidsOfMemberRoles(param: QChatGetExistingAccidsOfMemberRolesParam)
+     * @brief 根据一组用户 ID 查询指定频道下的定制权限信息
+     * @param param 参数见 @see QChatGetExistingAccidsOfMemberRolesParam
+     */
+    getExistingAccidsOfMemberRoles(param: QChatGetExistingAccidsOfMemberRolesParam): Promise<QChatGetExistingAccidsOfMemberRolesResp>;
+    /** void GetExistingAccidsInServerRole(const QChatGetExistingAccidsInServerRoleParam& param)
+     * @brief 查询服务器某身份组是否包含指定成员
+     * @param param 参数见 @see QChatGetExistingAccidsInServerRoleParam
+     */
+    getExistingAccidsInServerRole(param: QChatGetExistingAccidsInServerRoleParam): Promise<QChatGetExistingAccidsInServerRoleResp>;
+    /** @fn checkPermission(param: QChatCheckPermissionParam)
+     * @brief 查询当前登录用户是否拥有特定权限
+     * @param param 参数见 @see QChatGetRolesByAccidParam
+     */
+    checkPermission(param: QChatCheckPermissionParam): Promise<QChatCheckPermissionResp>;
+    /** @fn addChannelCategoryRole(param: QChatAddChannelCategoryRoleParam)
+     * @brief 添加一个身份组到频道分组
+     * @param param 参数见 @see QChatAddChannelCategoryRoleParam
+     */
+    addChannelCategoryRole(param: QChatAddChannelCategoryRoleParam): Promise<QChatAddChannelCategoryRoleResp>;
+    /** @fn removeChannelCategoryRole(param: QChatRemoveChannelCategoryRoleParam)
+     * @brief 从频道分组中移除身份组
+     * @param param 参数见 @see QChatRemoveChannelCategoryRoleParam
+     */
+    removeChannelCategoryRole(param: QChatRemoveChannelCategoryRoleParam): Promise<QChatRemoveChannelCategoryRoleResp>;
+    /** @fn updateChannelCategoryRole(param: QChatUpdateChannelCategoryRoleParam)
+     * @brief 更新频道分组中的身份组
+     * @param param 参数见 @see QChatUpdateChannelCategoryRoleParam
+     */
+    updateChannelCategoryRole(param: QChatUpdateChannelCategoryRoleParam): Promise<QChatUpdateChannelCategoryRoleResp>;
+    /** @fn getChannelCategoryRolesPage(param: QChatGetChannelCategoryRolesPageParam)
+     * @brief 分页获取频道分组下的身份组列表
+     * @param param 参数见 @see QChatGetChannelCategoryRolesPageParam
+     */
+    getChannelCategoryRolesPage(param: QChatGetChannelCategoryRolesPageParam): Promise<QChatGetChannelCategoryRolesPageResp>;
+    /** @fn addChannelCategoryMemberRole(param: QChatAddChannelCategoryMemberRoleParam)
+     * @brief 定制指定成员在频道分组中的权限
+     * @param param 参数见 @see QChatAddChannelCategoryMemberRoleParam
+     */
+    addChannelCategoryMemberRole(param: QChatAddChannelCategoryMemberRoleParam): Promise<QChatAddChannelCategoryMemberRoleResp>;
+    /** @fn removeChannelCategoryMemberRole(param: QChatRemoveChannelCategoryMemberRoleParam)
+     * @brief 取消指定成员在频道分组中的权限
+     * @param param 参数见 @see QChatRemoveChannelCategoryMemberRoleParam
+     */
+    removeChannelCategoryMemberRole(param: QChatRemoveChannelCategoryMemberRoleParam): Promise<QChatRemoveChannelCategoryMemberRoleResp>;
+    /** @fn updateChannelCategoryMemberRole(param: QChatUpdateChannelCategoryMemberRoleParam)
+     * @brief 更新指定成员在频道分组中的权限
+     * @param param 参数见 @see QChatUpdateChannelCategoryMemberRoleParam
+     */
+    updateChannelCategoryMemberRole(param: QChatUpdateChannelCategoryMemberRoleParam): Promise<QChatUpdateChannelCategoryMemberRoleResp>;
+    /** @fn getChannelCategoryMemberRolesPage(param: QChatGetChannelCategoryMemberRolesPageParam)
+     * @brief 分页获取频道分组下的成员权限列表
+     * @param param 参数见 @see QChatGetChannelCategoryMemberRolesPageParam
+     */
+    getChannelCategoryMemberRolesPage(param: QChatGetChannelCategoryMemberRolesPageParam): Promise<QChatGetChannelCategoryMemberRolesPageResp>;
+}

package/types/qchat/server.d.ts

@@ -0,0 +1,168 @@
+import { EventEmitter } from 'eventemitter3';
+import { QChatServerAcceptApplyParam, QChatServerAcceptApplyResp, QChatServerAcceptInviteParam, QChatServerAcceptInviteResp, QChatServerApplyParam, QChatServerApplyResp, QChatServerBanMemberParam, QChatServerBanMemberResp, QChatServerCreateParam, QChatServerCreateResp, QChatServerDeleteParam, QChatServerDeleteResp, QChatServerGenerateInviteCodeParam, QChatServerGenerateInviteCodeResp, QChatServerGetBannedMembersPageParam, QChatServerGetBannedMembersPageResp, QChatServerGetInviteApplyRecordOfSelfParam, QChatServerGetInviteApplyRecordOfSelfResp, QChatServerGetInviteApplyRecordOfServerParam, QChatServerGetInviteApplyRecordOfServerResp, QChatServerGetMembersPageParam, QChatServerGetMembersPageResp, QChatServerGetMembersParam, QChatServerGetMembersResp, QChatServerGetServersPageParam, QChatServerGetServersPageResp, QChatServerGetServersParam, QChatServerGetServersResp, QChatServerInviteParam, QChatServerInviteResp, QChatServerJoinByInviteCodeParam, QChatServerJoinByInviteCodeResp, QChatServerKickParam, QChatServerKickResp, QChatServerLeaveParam, QChatServerLeaveResp, QChatServerMemberSearchParam, QChatServerMemberSearchResp, QChatServerRejectApplyParam, QChatServerRejectApplyResp, QChatServerRejectInviteParam, QChatServerRejectInviteResp, QChatServerSearchPageParam, QChatServerSearchPageResp, QChatServerSubscribeParam, QChatServerSubscribeResp, QChatServerUnbanMemberParam, QChatServerUnbanMemberResp, QChatServerUnreadResp, QChatServerUpdateMemberInfoParam, QChatServerUpdateMemberInfoResp, QChatServerUpdateParam, QChatServerUpdateResp } from '../qchat_def/server_def';
+export declare interface QChatServerEvents {
+    /** 服务器未读数 */
+    unread: [QChatServerUnreadResp];
+}
+export declare class QChatServerModule extends EventEmitter<QChatServerEvents> {
+    instance: any;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** @fn createServer(param: QChatServerCreateParam)
+     * 创建服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    createServer(param: QChatServerCreateParam): Promise<QChatServerCreateResp>;
+    /** @fn deleteServer(param: QChatServerDeleteParam)
+     * 删除服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    deleteServer(param: QChatServerDeleteParam): Promise<QChatServerDeleteResp>;
+    /** @fn updateServer(param: QChatServerUpdateParam)
+     * 更新服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    updateServer(param: QChatServerUpdateParam): Promise<QChatServerUpdateResp>;
+    /** @fn subscribe(param: QChatServerSubscribeParam)
+     * 订阅指定服务器下的系统通知消息
+     * @param[in] param 接口参数
+     * @return void
+     */
+    subscribe(param: QChatServerSubscribeParam): Promise<QChatServerSubscribeResp>;
+    /** @fn getServers(param: QChatServerGetServersParam)
+     * 查询服务器列表
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getServers(param: QChatServerGetServersParam): Promise<QChatServerGetServersResp>;
+    /** @fn getServersByPage(param: QChatServerGetServersPageParam)
+     * 查询服务器列表(分页)
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getServersByPage(param: QChatServerGetServersPageParam): Promise<QChatServerGetServersPageResp>;
+    /** @fn invite(param: QChatServerInviteParam)
+     * 邀请用户加入服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    invite(param: QChatServerInviteParam): Promise<QChatServerInviteResp>;
+    /** @fn acceptInvite(param: QChatServerAcceptInviteParam)
+     * 接受加入服务器邀请
+     * @param[in] param 接口参数
+     * @return void
+     */
+    acceptInvite(param: QChatServerAcceptInviteParam): Promise<QChatServerAcceptInviteResp>;
+    /** @fn rejectInvite(param: QChatServerRejectInviteParam)
+     * 拒绝加入服务器邀请
+     * @param[in] param 接口参数
+     * @return void
+     */
+    rejectInvite(param: QChatServerRejectInviteParam): Promise<QChatServerRejectInviteResp>;
+    /** @fn apply(param: QChatServerApplyParam)
+     * 申请加入服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    apply(param: QChatServerApplyParam): Promise<QChatServerApplyResp>;
+    /** @fn acceptApply(param: QChatServerAcceptApplyParam)
+     * 同意加入服务器申请
+     * @param[in] param 接口参数
+     * @return void
+     */
+    acceptApply(param: QChatServerAcceptApplyParam): Promise<QChatServerAcceptApplyResp>;
+    /** @fn rejectApply(param: QChatServerRejectApplyParam)
+     * 拒绝加入服务器申请
+     * @param[in] param 接口参数
+     * @return void
+     */
+    rejectApply(param: QChatServerRejectApplyParam): Promise<QChatServerRejectApplyResp>;
+    /** @fn kick(param: QChatServerKickParam)
+     * 将指定用户踢出服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    kick(param: QChatServerKickParam): Promise<QChatServerKickResp>;
+    /** @fn leave(param: QChatServerLeaveParam)
+     * 离开指定服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    leave(param: QChatServerLeaveParam): Promise<QChatServerLeaveResp>;
+    /** @fn updateMemberInfo(param: QChatServerUpdateMemberInfoParam)
+     * 更新服务器成员信息
+     * @param[in] param 接口参数
+     * @return void
+     */
+    updateMemberInfo(param: QChatServerUpdateMemberInfoParam): Promise<QChatServerUpdateMemberInfoResp>;
+    /** @fn getServerMembers(param: QChatServerGetMembersParam)
+     * 查询服务器成员列表
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getServerMembers(param: QChatServerGetMembersParam): Promise<QChatServerGetMembersResp>;
+    /** @fn getServerMembersByPage(param: QChatServerGetMembersPageParam)
+     * 查询服务器成员列表(分页)
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getServerMembersByPage(param: QChatServerGetMembersPageParam): Promise<QChatServerGetMembersPageResp>;
+    /** @fn banMember(param: QChatServerBanMemberParam)
+     * 封禁服务器成员
+     * @param[in] param 接口参数
+     * @return void
+     */
+    banMember(param: QChatServerBanMemberParam): Promise<QChatServerBanMemberResp>;
+    /** @fn unbanMember(param: QChatServerUnbanMemberParam)
+     * 解封服务器成员
+     * @param[in] param 接口参数
+     * @return void
+     */
+    unbanMember(param: QChatServerUnbanMemberParam): Promise<QChatServerUnbanMemberResp>;
+    /** @fn getBannedMembersByPage(param: QChatServerGetBannedMembersPageParam)
+     * 查询服务器封禁成员列表(分页)
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getBannedMembersByPage(param: QChatServerGetBannedMembersPageParam): Promise<QChatServerGetBannedMembersPageResp>;
+    /** @fn serverSearchByPage(param: QChatServerSearchPageParam)
+     * 根据关键字搜索服务器(分页)
+     * @param[in] param 接口参数
+     * @return void
+     */
+    serverSearchByPage(param: QChatServerSearchPageParam): Promise<QChatServerSearchPageResp>;
+    /** @fn serverMemberSearch(param: QChatServerMemberSearchParam)
+     * 根据关键字搜索服务器成员
+     * @param[in] param 接口参数
+     * @return void
+     */
+    serverMemberSearch(param: QChatServerMemberSearchParam): Promise<QChatServerMemberSearchResp>;
+    /** @fn generateInviteCode(param: QChatServerGenerateInviteCodeParam)
+     * 生成服务器邀请码
+     * @param[in] param 接口参数
+     * @return void
+     */
+    generateInviteCode(param: QChatServerGenerateInviteCodeParam): Promise<QChatServerGenerateInviteCodeResp>;
+    /** @fn joinByInviteCode(param: QChatServerJoinByInviteCodeParam)
+     * 通过邀请码加入服务器
+     * @param[in] param 接口参数
+     * @return void
+     */
+    joinByInviteCode(param: QChatServerJoinByInviteCodeParam): Promise<QChatServerJoinByInviteCodeResp>;
+    /** @fn getInviteApplyRecordOfServer(param: QChatServerGetInviteApplyRecordOfServerParam)
+     * 查询服务器下邀请申请历史
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getInviteApplyRecordOfServer(param: QChatServerGetInviteApplyRecordOfServerParam): Promise<QChatServerGetInviteApplyRecordOfServerResp>;
+    /** @fn getInviteApplyRecordOfSelf(param: QChatServerGetInviteApplyRecordOfSelfParam)
+     * 查询自己邀请申请历史
+     * @param[in] param 接口参数
+     * @return void
+     */
+    getInviteApplyRecordOfSelf(param: QChatServerGetInviteApplyRecordOfSelfParam): Promise<QChatServerGetInviteApplyRecordOfSelfResp>;
+}

package/types/qchat/system_notification.d.ts

@@ -0,0 +1,39 @@
+import { EventEmitter } from 'eventemitter3';
+import { QChatSendSystemNotificationParam, QChatUpdateSystemNotificationParam, QChatMarkSystemNotificationsReadParam, QChatSendTypingEventParam, QChatMarkSystemNotificationsReadResp, QChatSendSystemNotificationResp, QChatSendTypingEventResp, QChatUpdateSystemNotificationResp, QChatRecvSystemNotificationResp, QChatRecvTypingEventResp, QChatSystemNotificationUpdatedResp } from '../qchat_def/system_notification_def';
+export declare interface QChatSystemNotificationEvents {
+    /** 接受系统通知 */
+    notification: [QChatRecvSystemNotificationResp];
+    /** 正在输入事件 */
+    typingEvent: [QChatRecvTypingEventResp];
+    /** 系统通知更新 */
+    update: [QChatSystemNotificationUpdatedResp];
+}
+export declare class QChatSystemNotificationModule extends EventEmitter<QChatSystemNotificationEvents> {
+    instance: any;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** @fn send(param: QChatSendSystemNotificationParam)
+     * 发送系统消息
+     * @param[in] param 接口参数
+     * @return void
+     */
+    send(param: QChatSendSystemNotificationParam): Promise<QChatSendSystemNotificationResp>;
+    /** @fn update(param: QChatUpdateSystemNotificationParam)
+     * @brief 更新系统消息
+     * @param[in] param 接口参数
+     */
+    update(param: QChatUpdateSystemNotificationParam): Promise<QChatUpdateSystemNotificationResp>;
+    /** @fn markSystemNotificationsRead(param: QChatMarkSystemNotificationsReadParam)
+     * @brief 标记系统通知消息已读
+     * @param param 接口参数
+     * @return void
+     */
+    markSystemNotificationsRead(param: QChatMarkSystemNotificationsReadParam): Promise<QChatMarkSystemNotificationsReadResp>;
+    /** @fn sendTypingEvent(param: QChatSendTypingEventParam)
+     * @brief 发送正在输入事件
+     * @param param 接口参数
+     * @return void
+     */
+    sendTypingEvent(param: QChatSendTypingEventParam): Promise<QChatSendTypingEventResp>;
+}

package/types/qchat_def/attachment_def.d.ts

@@ -0,0 +1,71 @@
+import { NIMQChatDownloadResType, NIMResCode } from './public_def';
+export interface QChatAttachmentCustomTokenResp {
+    /** 上传后的url */
+    url?: string;
+    /** 自定义token */
+    token?: string;
+}
+export interface QChatAttachmentUploadResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: NIMResCode;
+    /** 任务id */
+    task_id?: string;
+    /** 上传后的url */
+    url?: string;
+}
+export interface QChatAttachmentDownloadResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: NIMResCode;
+    /** 下载资源类型 */
+    res_type?: NIMQChatDownloadResType;
+    /** 任务id, 自动下载的任务则为消息id */
+    task_id?: string;
+    /** 下载后的文件路径 */
+    file_path?: string;
+}
+export interface QChatAttachmentProgressResp {
+    /** 操作结果, 参考NIMResCode */
+    res_code?: NIMResCode;
+    /** 任务id */
+    task_id?: string;
+    /** 文件总大小 */
+    total_size?: number;
+    /** 当前已经上传/下载的大小 */
+    cur_size?: number;
+}
+/** 获取附件自定义token回调 */
+export declare type AttachmentCustomTokenCallback = (resp: QChatAttachmentCustomTokenResp) => QChatAttachmentCustomTokenResp;
+/** 上传附件回调 */
+export declare type AttachmentUploadCallback = (resp: QChatAttachmentUploadResp) => void;
+/** 下载附件回调 */
+export declare type AttachmentDownloadCallback = (resp: QChatAttachmentDownloadResp) => void;
+/** 上传/下载附件进度回调 */
+export declare type AttachmentProgressCallback = (resp: QChatAttachmentProgressResp) => void;
+export interface QChatAttachmentUploadParam {
+    /** 进度回调 */
+    progress_cb?: AttachmentProgressCallback;
+    /** 任务id, 为空时自动生成 */
+    task_id?: string;
+    /** 文件路径 */
+    file_path?: string;
+}
+export interface QChatAttachmentStopUploadParam {
+    /** 任务id */
+    task_id?: string;
+}
+export interface QChatAttachmentDownloadParam {
+    /** 进度回调 */
+    progress_cb?: AttachmentProgressCallback;
+    /** 下载资源类型 */
+    res_type?: NIMQChatDownloadResType;
+    /** 任务id, 为空时自动生成 */
+    task_id?: string;
+    /** 下载地址 */
+    url?: string;
+    /** 文件路径 */
+    file_path?: string;
+}
+export interface QChatAttachmentStopDownloadParam {
+    /** 任务id */
+    task_id?: string;
+}