///
import * as log4js from "log4js";
import { BaseClient, Platform, Domain } from "./core";
import { Gender, OnlineStatus } from "./common";
import { OcrResult } from "./internal";
import { StrangerInfo, FriendInfo, GroupInfo, MemberInfo } from "./entities";
import { EventMap } from "./events";
import { User, Friend } from "./friend";
import { Discuss, Group } from "./group";
import { Member } from "./member";
import { Forwardable, Quotable, Sendable, ImageElem } from "./message";
/** 事件接口 */
export interface Client extends BaseClient {
on(event: T, listener: EventMap[T]): this;
on(event: S & Exclude, listener: (this: this, ...args: any[]) => void): this;
once(event: T, listener: EventMap[T]): this;
once(event: S & Exclude, listener: (this: this, ...args: any[]) => void): this;
prependListener(event: T, listener: EventMap[T]): this;
prependListener(event: string | symbol, listener: (this: this, ...args: any[]) => void): this;
prependOnceListener(event: T, listener: EventMap[T]): this;
prependOnceListener(event: string | symbol, listener: (this: this, ...args: any[]) => void): this;
off(event: T, listener: EventMap[T]): this;
off(event: S & Exclude, listener: (this: this, ...args: any[]) => void): this;
}
/** 一个客户端 */
export declare class Client extends BaseClient {
/**
* 得到一个群对象, 通常不会重复创建,调用
* @param strict 严格模式,若群不存在会抛出异常
*/
readonly pickGroup: (gid: number, strict?: boolean | undefined) => Group;
/** 得到一个好友对象, 通常不会重复创建 */
readonly pickFriend: (uid: number, strict?: boolean | undefined) => Friend;
/** 得到一个群员对象, 通常不会重复创建 */
readonly pickMember: (gid: number, uid: number, strict?: boolean | undefined) => Member;
/** 创建一个用户对象 */
readonly pickUser: (uid: number) => User;
/** 创建一个讨论组对象 */
readonly pickDiscuss: (gid: number) => Discuss;
/** 日志记录器,初始情况下是`log4js.Logger` */
logger: Logger | log4js.Logger;
/** 账号本地数据存储目录 */
readonly dir: string;
/** 配置 */
readonly config: Required;
protected readonly _cache: Map>;
protected _sync_cookie?: Uint8Array;
/** 密码的md5值,调用login后会保存在这里,用于token过期时恢复登录 */
password_md5?: Buffer;
get [Symbol.toStringTag](): string;
/** 好友列表(务必以`ReadonlyMap`方式访问) */
readonly fl: Map;
/** 陌生人列表(务必以`ReadonlyMap`方式访问) */
readonly sl: Map;
/** 群列表(务必以`ReadonlyMap`方式访问) */
readonly gl: Map;
/** 群员列表缓存(务必以`ReadonlyMap`方式访问) */
readonly gml: Map>;
/** 黑名单列表(务必以`ReadonlySet`方式访问) */
readonly blacklist: Set;
/** 好友分组 */
readonly classes: Map;
/** 勿手动修改这些属性 */
status: OnlineStatus;
nickname: string;
sex: Gender;
age: number;
bid: string;
/** 漫游表情缓存 */
stamp: Set;
/** 相当于频道中的qq号 */
tiny_id: string;
/** csrf token */
get bkn(): number;
readonly cookies: {
[domain in Domain]: string;
};
/** 数据统计 */
get stat(): {
start_time: number;
lost_times: number;
recv_pkt_cnt: number;
sent_pkt_cnt: number;
lost_pkt_cnt: number;
recv_msg_cnt: number;
sent_msg_cnt: number;
msg_cnt_per_min: number;
remote_ip: string;
remote_port: number;
};
/** 修改日志级别 */
set log_level(level: LogLevel);
constructor(uin: number, conf?: Config);
/**
* 会优先尝试使用token登录 (token在上次登录成功后存放在`this.dir`下)
*
* 无token或token失效时:
* * 传了`password`则尝试密码登录
* * 不传`password`则尝试扫码登录
*
* 掉线重连时也是自动调用此函数,走相同逻辑
* 你也可以在配置中修改`reconn_interval`,关闭掉线重连并自行处理
*
* @param password 可以为密码原文,或密码的md5值
*/
login(password?: string | Buffer): Promise;
/** 设置在线状态 */
setOnlineStatus(status?: OnlineStatus): Promise;
/** 设置昵称 */
setNickname(nickname: string): Promise;
/** 设置性别(1男2女) */
setGender(gender: 0 | 1 | 2): Promise;
/** 设置生日(20201202) */
setBirthday(birthday: string | number): Promise;
/** 设置个人说明 */
setDescription(description?: string): Promise;
/** 设置个性签名 */
setSignature(signature?: string): Promise;
/** 设置头像 */
setAvatar(file: ImageElem["file"]): Promise;
/** 获取漫游表情 */
getRoamingStamp(no_cache?: boolean): Promise;
/** 删除表情(支持批量) */
deleteStamp(id: string | string[]): Promise;
/** 获取系统消息 */
getSystemMsg(): Promise<(import("./events").FriendRequestEvent | import("./events").GroupRequestEvent | import("./events").GroupInviteEvent)[]>;
/** 添加好友分组 */
addClass(name: string): Promise;
/** 删除好友分组 */
deleteClass(id: number): Promise;
/** 重命名好友分组 */
renameClass(id: number, name: string): Promise;
/** 重载好友列表 */
reloadFriendList(): Promise;
/** 重载陌生人列表 */
reloadStrangerList(): Promise;
/** 重载群列表 */
reloadGroupList(): Promise;
/** 重载黑名单 */
reloadBlackList(): Promise;
/** 清空缓存文件 fs.rm need v14.14 */
cleanCache(): void;
/** 获取视频下载地址 */
getVideoUrl(fid: string, md5: string | Buffer): Promise;
/** 获取转发消息 */
getForwardMsg(resid: string, fileName?: string): Promise;
/** 制作转发消息 */
makeForwardMsg(fake: Forwardable[], dm?: boolean): Promise;
/** Ocr图片转文字 */
imageOcr(file: ImageElem["file"]): Promise;
/** @cqhttp (cqhttp遗留方法) use client.cookies[domain] */
getCookies(domain?: Domain): string;
/** @cqhttp use client.bkn */
getCsrfToken(): number;
/** @cqhttp use client.fl */
getFriendList(): Map;
/** @cqhttp use client.gl */
getGroupList(): Map;
/** @cqhttp use client.sl */
getStrangerList(): Map;
/** @cqhttp use user.getSimpleInfo() */
getStrangerInfo(user_id: number): Promise<{
user_id: number;
nickname: string;
sex: Gender;
age: number;
area: string;
}>;
/** @cqhttp use group.info or group.renew() */
getGroupInfo(group_id: number, no_cache?: boolean): Promise;
/** @cqhttp use group.getMemberList() */
getGroupMemberList(group_id: number, no_cache?: boolean): Promise