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.
31 lines
1.3 KiB
TypeScript
31 lines
1.3 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
export const SetDoubtFriendsAddRequestPayloadSchema = Type.Object({
|
|
flag: Type.String({ description: '请求 flag' }),
|
|
// 注意强制String 非isNumeric 不遵守则不符合设计
|
|
approve: Type.Boolean({ default: true, description: '是否同意 (强制为 true)' }),
|
|
// 该字段没有语义 仅做保留 强制为True
|
|
});
|
|
|
|
export type SetDoubtFriendsAddRequestPayload = Static<typeof SetDoubtFriendsAddRequestPayloadSchema>;
|
|
|
|
export class SetDoubtFriendsAddRequest extends OneBotAction<SetDoubtFriendsAddRequestPayload, any> {
|
|
override actionName = ActionName.SetDoubtFriendsAddRequest;
|
|
override payloadSchema = SetDoubtFriendsAddRequestPayloadSchema;
|
|
override returnSchema = Type.Any();
|
|
override actionSummary = '处理可疑好友申请';
|
|
override actionDescription = '同意或拒绝系统的可疑好友申请';
|
|
override actionTags = ['系统接口'];
|
|
override payloadExample = {
|
|
flag: '12345',
|
|
approve: true
|
|
};
|
|
override returnExample = null;
|
|
|
|
async _handle (payload: SetDoubtFriendsAddRequestPayload) {
|
|
return await this.core.apis.FriendApi.handleDoubtFriendRequest(payload.flag);
|
|
}
|
|
}
|