mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 15:11:15 +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.
40 lines
1.2 KiB
TypeScript
40 lines
1.2 KiB
TypeScript
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { GetPacketStatusDepends } from '@/napcat-onebot/action/packet/GetPacketStatus';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
const PayloadSchema = Type.Object({
|
|
user_id: Type.String({ description: 'QQ号' }),
|
|
});
|
|
|
|
type PayloadType = Static<typeof PayloadSchema>;
|
|
|
|
const ReturnSchema = Type.Object({
|
|
status: Type.Number({ description: '在线状态' }),
|
|
ext_status: Type.Number({ description: '扩展状态' }),
|
|
}, { description: '用户状态' });
|
|
|
|
type ReturnType = Static<typeof ReturnSchema>;
|
|
|
|
export class GetUserStatus extends GetPacketStatusDepends<PayloadType, ReturnType> {
|
|
override actionName = ActionName.GetUserStatus;
|
|
override payloadSchema = PayloadSchema;
|
|
override returnSchema = ReturnSchema;
|
|
override actionSummary = '获取用户在线状态';
|
|
override actionTags = ['系统扩展'];
|
|
override payloadExample = {
|
|
user_id: '123456789'
|
|
};
|
|
override returnExample = {
|
|
status: 10,
|
|
ext_status: 0
|
|
};
|
|
|
|
async _handle (payload: PayloadType) {
|
|
const res = await this.core.apis.PacketApi.pkt.operation.GetStrangerStatus(+payload.user_id);
|
|
if (!res) {
|
|
throw new Error('无法获取用户状态');
|
|
}
|
|
return res;
|
|
}
|
|
}
|