Northern_Lights/NapCatQQ
0
0
Fork 0
mirror of https://github.com/NapNeko/NapCatQQ.git synced 2026-03-01 16:20:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add action metadata to OneBot action classes

Browse Source 
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.
This commit is contained in:
手瓜一十雪
2026-01-25 19:19:03 +08:00
parent 5b80a8576f
commit 60a9114495
86 changed files with 809 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
packages/napcat-onebot/action/file/online/CancelOnlineFile.ts
View File

@@ -14,6 +14,13 @@ 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());

6
packages/napcat-onebot/action/file/online/GetOnlineFileMessages.ts
View File

@@ -13,6 +13,12 @@ export class GetOnlineFileMessages extends OneBotAction<GetOnlineFileMessagesPay
override actionName = ActionName.GetOnlineFileMessages;
override payloadSchema = GetOnlineFileMessagesPayloadSchema;
override returnSchema = Type.Any({ description: '在线文件消息列表' });
override actionSummary = '获取在线文件消息';
override actionTags = ['文件扩展'];
override payloadExample = {
user_id: '123456789'
};
override returnExample = [];
async _handle (payload: GetOnlineFileMessagesPayload) {
const uid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString());

8
packages/napcat-onebot/action/file/online/ReceiveOnlineFile.ts
View File

@@ -15,6 +15,14 @@ export class ReceiveOnlineFile extends OneBotAction<ReceiveOnlineFilePayload, an
override actionName = ActionName.ReceiveOnlineFile;
override payloadSchema = ReceiveOnlineFilePayloadSchema;
override returnSchema = Type.Any({ description: '接收结果' });
override actionSummary = '接收在线文件';
override actionTags = ['文件扩展'];
override payloadExample = {
user_id: '123456789',
msg_id: '123',
save_path: 'C:\\save'
};
override returnExample = null;
async _handle (payload: ReceiveOnlineFilePayload) {
// 默认下载路径

7
packages/napcat-onebot/action/file/online/RefuseOnlineFile.ts
View File

@@ -15,6 +15,13 @@ export class RefuseOnlineFile extends OneBotAction<RefuseOnlineFilePayload, any>
override actionName = ActionName.RefuseOnlineFile;
override payloadSchema = RefuseOnlineFilePayloadSchema;
override returnSchema = Type.Any({ description: '拒绝结果' });
override actionSummary = '拒绝在线文件';
override actionTags = ['文件扩展'];
override payloadExample = {
user_id: '123456789',
msg_id: '123'
};
override returnExample = null;
async _handle (payload: RefuseOnlineFilePayload) {
const uid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString());

8
packages/napcat-onebot/action/file/online/SendOnlineFile.ts
View File

@@ -15,6 +15,14 @@ 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());

7
packages/napcat-onebot/action/file/online/SendOnlineFolder.ts
View File

@@ -15,6 +15,13 @@ export class SendOnlineFolder extends OneBotAction<SendOnlineFolderPayload, any>
override actionName = ActionName.SendOnlineFolder;
override payloadSchema = SendOnlineFolderPayloadSchema;
override returnSchema = Type.Any({ description: '发送结果' });
override actionSummary = '发送在线文件夹';
override actionTags = ['文件扩展'];
override payloadExample = {
user_id: '123456789',
folder_path: 'C:\\path\\to\\folder'
};
override returnExample = null;
async _handle (payload: SendOnlineFolderPayload) {
const uid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString());