NapCatQQ/packages/napcat-onebot/action/packet/GetRkeyEx.ts
手瓜一十雪 60a9114495 Add action metadata to OneBot action classes
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.
2026-01-25 19:19:03 +08:00

42 lines
1.4 KiB
TypeScript

import { ActionName } from '@/napcat-onebot/action/router';
import { GetPacketStatusDepends } from '@/napcat-onebot/action/packet/GetPacketStatus';
import { Type, Static } from '@sinclair/typebox';
export const GetRkeyExReturnSchema = Type.Array(Type.Object({
type: Type.String({ description: '类型 (private/group)' }),
rkey: Type.String({ description: 'RKey' }),
created_at: Type.Number({ description: '创建时间' }),
ttl: Type.Number({ description: '有效期' }),
}), { description: 'RKey 列表' });
export type GetRkeyExReturn = Static<typeof GetRkeyExReturnSchema>;
export class GetRkeyEx extends GetPacketStatusDepends<void, GetRkeyExReturn> {
override actionName = ActionName.GetRkeyEx;
override payloadSchema = Type.Object({});
override returnSchema = GetRkeyExReturnSchema;
override actionSummary = '获取扩展 RKey';
override actionTags = ['系统扩展'];
override payloadExample = {};
override returnExample = [
{
type: 'private',
rkey: 'rkey_123',
created_at: 1734567890,
ttl: 3600
}
];
async _handle () {
const rkeys = await this.core.apis.PacketApi.pkt.operation.FetchRkey();
return rkeys.map(rkey => {
return {
type: rkey.type === 10 ? 'private' : 'group',
rkey: rkey.rkey,
created_at: Number(rkey.time),
ttl: Number(rkey.ttl),
};
});
}
}