mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-06 13:05:09 +00:00
Added or updated actionSummary, actionTags, payloadExample, and returnExample properties for all OneBot action classes in the napcat-onebot package. This improves API documentation and discoverability by providing concise summaries, categorization tags, and usage examples for each action.
35 lines
1.3 KiB
TypeScript
35 lines
1.3 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
import { ChatType } from 'napcat-core/types';
|
|
|
|
export const CancelOnlineFilePayloadSchema = Type.Object({
|
|
user_id: Type.String({ description: '用户 QQ' }),
|
|
msg_id: Type.String({ description: '消息 ID' }),
|
|
});
|
|
|
|
export type CancelOnlineFilePayload = Static<typeof CancelOnlineFilePayloadSchema>;
|
|
|
|
export class CancelOnlineFile extends OneBotAction<CancelOnlineFilePayload, any> {
|
|
override actionName = ActionName.CancelOnlineFile;
|
|
override payloadSchema = CancelOnlineFilePayloadSchema;
|
|
override returnSchema = Type.Any({ description: '取消结果' });
|
|
override actionSummary = '取消在线文件';
|
|
override actionTags = ['文件扩展'];
|
|
override payloadExample = {
|
|
user_id: '123456789',
|
|
msg_id: '123'
|
|
};
|
|
override returnExample = null;
|
|
|
|
async _handle (payload: CancelOnlineFilePayload) {
|
|
const uid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString());
|
|
if (!uid) throw new Error('User not found');
|
|
|
|
// 仅私聊
|
|
const peer = { chatType: ChatType.KCHATTYPEC2C, peerUid: uid };
|
|
|
|
return await this.core.apis.OnlineApi.cancelMyOnlineFileMsg(peer, payload.msg_id);
|
|
}
|
|
}
|