mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 07:01:16 +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.4 KiB
TypeScript
43 lines
1.4 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({
|
|
status: Type.Union([Type.Number(), Type.String()], { description: '在线状态' }),
|
|
ext_status: Type.Union([Type.Number(), Type.String()], { description: '扩展状态' }),
|
|
battery_status: Type.Union([Type.Number(), Type.String()], { description: '电量状态' }),
|
|
});
|
|
|
|
type PayloadType = Static<typeof PayloadSchema>;
|
|
|
|
const ReturnSchema = Type.Null({ description: '设置结果' });
|
|
|
|
type ReturnType = Static<typeof ReturnSchema>;
|
|
|
|
export class SetOnlineStatus extends OneBotAction<PayloadType, ReturnType> {
|
|
override actionName = ActionName.SetOnlineStatus;
|
|
override payloadSchema = PayloadSchema;
|
|
override returnSchema = ReturnSchema;
|
|
override actionSummary = '设置在线状态';
|
|
override actionDescription = '设置在线状态';
|
|
override actionTags = ['系统扩展'];
|
|
override payloadExample = {
|
|
status: 11,
|
|
ext_status: 0,
|
|
battery_status: 100
|
|
};
|
|
override returnExample = null;
|
|
|
|
async _handle (payload: PayloadType) {
|
|
const ret = await this.core.apis.UserApi.setSelfOnlineStatus(
|
|
+payload.status,
|
|
+payload.ext_status,
|
|
+payload.battery_status
|
|
);
|
|
if (ret.result !== 0) {
|
|
throw new Error('设置在线状态失败');
|
|
}
|
|
return null;
|
|
}
|
|
}
|