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.
39 lines
1.2 KiB
TypeScript
39 lines
1.2 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
const PayloadSchema = Type.Object({
|
|
group_id: Type.String({ description: '群号' }),
|
|
album_id: Type.String({ description: '相册ID' }),
|
|
lloc: Type.String({ description: '媒体ID (lloc)' }),
|
|
});
|
|
|
|
type PayloadType = Static<typeof PayloadSchema>;
|
|
|
|
const ReturnSchema = Type.Any({ description: '删除结果' });
|
|
|
|
type ReturnType = Static<typeof ReturnSchema>;
|
|
|
|
export class DelGroupAlbumMedia extends OneBotAction<PayloadType, ReturnType> {
|
|
override actionName = ActionName.DelGroupAlbumMedia;
|
|
override actionSummary = '删除群相册媒体';
|
|
override actionTags = ['群组扩展'];
|
|
override payloadExample = {
|
|
group_code: 123456,
|
|
media_id_list: ['media_id_1', 'media_id_2']
|
|
};
|
|
override returnExample = {
|
|
result: true
|
|
};
|
|
override payloadSchema = PayloadSchema;
|
|
override returnSchema = ReturnSchema;
|
|
|
|
async _handle (payload: PayloadType) {
|
|
return await this.core.apis.WebApi.deleteAlbumMediaByNTQQ(
|
|
payload.group_id,
|
|
payload.album_id,
|
|
payload.lloc
|
|
);
|
|
}
|
|
}
|