NapCatQQ/packages/napcat-onebot/action/user/GetFriendList.ts
手瓜一十雪 fd1808e36a Add action examples and enhance action metadata
Introduced a centralized examples.ts file providing payload and return examples for all actions. Updated numerous action classes to include actionDescription, actionTags, payloadExample, and returnExample fields, improving API documentation and discoverability.
2026-01-25 17:45:46 +08:00

47 lines
1.9 KiB
TypeScript

import { OB11Construct } from '@/napcat-onebot/helper/data';
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
import { ActionName } from '@/napcat-onebot/action/router';
import { Static, Type } from '@sinclair/typebox';
import { OB11UserSchema } from '../schemas';
import { ActionExamples } from '../examples';
const PayloadSchema = Type.Object({
no_cache: Type.Optional(Type.Union([Type.Boolean(), Type.String()], { description: '是否不使用缓存' })),
});
type PayloadType = Static<typeof PayloadSchema>;
const ReturnSchema = Type.Array(OB11UserSchema, { description: '好友列表' });
type ReturnType = Static<typeof ReturnSchema>;
export default class GetFriendList extends OneBotAction<PayloadType, ReturnType> {
override actionName = ActionName.GetFriendList;
override payloadSchema = PayloadSchema;
override returnSchema = ReturnSchema;
override actionDescription = '获取好友列表';
override actionTags = ['用户接口'];
override payloadExample = ActionExamples.GetFriendList.payload;
override returnExample = ActionExamples.GetFriendList.return;
async _handle (_payload: PayloadType) {
const buddyMap = await this.core.apis.FriendApi.getBuddyV2SimpleInfoMap();
const isNocache = typeof _payload.no_cache === 'string' ? _payload.no_cache === 'true' : !!_payload.no_cache;
await Promise.all(
Array.from(buddyMap.values()).map(async (buddyInfo) => {
try {
const userDetail = await this.core.apis.UserApi.getUserDetailInfo(buddyInfo.coreInfo.uid, isNocache);
const data = buddyMap.get(buddyInfo.coreInfo.uid);
if (data) {
data.qqLevel = userDetail.qqLevel;
}
} catch (error) {
this.core.context.logger.logError('获取好友详细信息失败', error);
}
})
);
return OB11Construct.friends(Array.from(buddyMap.values()));
}
}