mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 23:19:37 +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.
38 lines
1.5 KiB
TypeScript
38 lines
1.5 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 SendOnlineFilePayloadSchema = Type.Object({
|
|
user_id: Type.String({ description: '用户 QQ' }),
|
|
file_path: Type.String({ description: '本地文件路径' }),
|
|
file_name: Type.Optional(Type.String({ description: '文件名 (可选)' })),
|
|
});
|
|
|
|
export type SendOnlineFilePayload = Static<typeof SendOnlineFilePayloadSchema>;
|
|
|
|
export class SendOnlineFile extends OneBotAction<SendOnlineFilePayload, any> {
|
|
override actionName = ActionName.SendOnlineFile;
|
|
override payloadSchema = SendOnlineFilePayloadSchema;
|
|
override returnSchema = Type.Any({ description: '发送结果' });
|
|
override actionSummary = '发送在线文件';
|
|
override actionTags = ['文件扩展'];
|
|
override payloadExample = {
|
|
user_id: '123456789',
|
|
file_path: 'C:\\path\\to\\file.txt',
|
|
file_name: 'test.txt'
|
|
};
|
|
override returnExample = null;
|
|
|
|
async _handle (payload: SendOnlineFilePayload) {
|
|
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 };
|
|
const fileName = payload.file_name || '';
|
|
|
|
return await this.core.apis.OnlineApi.sendOnlineFile(peer, payload.file_path, fileName);
|
|
}
|
|
}
|