mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-04 14:41:14 +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.
43 lines
1.5 KiB
TypeScript
43 lines
1.5 KiB
TypeScript
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { OneBotAction } from '../OneBotAction';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
const PayloadSchema = Type.Object({
|
|
group_id: Type.String({ description: '群号' }),
|
|
bot_appid: Type.String({ description: '机器人AppID' }),
|
|
button_id: Type.String({ default: '', description: '按钮ID' }),
|
|
callback_data: Type.String({ default: '', description: '回调数据' }),
|
|
msg_seq: Type.String({ default: '10086', description: '消息序列号' }),
|
|
});
|
|
|
|
type PayloadType = Static<typeof PayloadSchema>;
|
|
|
|
const ReturnSchema = Type.Any({ description: '点击结果' });
|
|
|
|
type ReturnType = Static<typeof ReturnSchema>;
|
|
|
|
export class ClickInlineKeyboardButton extends OneBotAction<PayloadType, ReturnType> {
|
|
override actionName = ActionName.ClickInlineKeyboardButton;
|
|
override payloadSchema = PayloadSchema;
|
|
override returnSchema = ReturnSchema; override actionSummary = '点击内联键盘按钮';
|
|
override actionTags = ['消息扩展'];
|
|
override payloadExample = {
|
|
message_id: 12345,
|
|
button_id: 'btn_1'
|
|
};
|
|
override returnExample = {
|
|
result: true
|
|
};
|
|
async _handle (payload: PayloadType) {
|
|
return await this.core.apis.MsgApi.clickInlineKeyboardButton({
|
|
buttonId: payload.button_id,
|
|
peerId: payload.group_id.toString(),
|
|
botAppid: payload.bot_appid,
|
|
msgSeq: payload.msg_seq,
|
|
callback_data: payload.callback_data,
|
|
dmFlag: 0,
|
|
chatType: 2,
|
|
});
|
|
}
|
|
}
|