koishi-plugin-best-cave/lib/NameManager.d.ts

功能强大、高度可定制的回声洞插件。支持丰富的媒体类型、内容查重、AI分析、人工审核、用户昵称、数据迁移以及本地/S3 双重文件存储后端。

import { Context } from 'koishi';
/** 数据库 `cave_user` 表的结构。 */
export interface UserName {
    userId: string;
    nickname: string;
}
declare module 'koishi' {
    interface Tables {
        cave_user: UserName;
    }
}
/**
 * @class NameManager
 * @description 负责管理用户在回声洞中的自定义昵称。
 */
export declare class NameManager {
    private ctx;
    /**
     * @constructor
     * @param ctx - Koishi 上下文，用于初始化数据库模型。
     */
    constructor(ctx: Context);
    /**
     * @description 注册 `.name` 子命令，用于管理用户昵称。
     * @param cave - 主 `cave` 命令实例。
     */
    registerCommands(cave: any): void;
    /**
     * @description 设置或更新指定用户的昵称。
     * @param userId - 目标用户的 ID。
     * @param nickname - 要设置的新昵称。
     */
    setNickname(userId: string, nickname: string): Promise<void>;
    /**
     * @description 获取指定用户的昵称。
     * @param userId - 目标用户的 ID。
     * @returns 用户的昵称字符串或 null。
     */
    getNickname(userId: string): Promise<string | null>;
    /**
     * @description 清除指定用户的昵称设置。
     * @param userId - 目标用户的 ID。
     */
    clearNickname(userId: string): Promise<void>;
}