Class Client

constructor

• new Client(uin, conf?): Client

• 继承原版oicq的构造方式，建议使用另一个构造函数

  Parameters

  • uin: number

    账号
  • Optionalconf: Config

    配置

  Returns Client
• new Client(conf?): Client

• 账号在调用 login 时传入

  Parameters

  • Optionalconf: Config

    配置

  Returns Client

age

bid

Readonlyblacklist

Readonlyclasses

Readonlycookies

Readonlydir

Readonlyfl

Readonlygl

Readonlygml

Readonlyguilds

logger

nickname

Optionalpassword_md5

ReadonlypickDiscuss

ReadonlypickFriend

ReadonlypickGroup

ReadonlypickGuild

ReadonlypickMember

ReadonlypickUser

sex

Readonlysl

stamp

status

tiny_id

[toStringTag]

• get [toStringTag](): string

• Returns string

bkn

• get bkn(): number

• csrf token

  Returns number

log_level

• set log_level(level): void

• 修改日志级别

  Parameters

  • level: LogLevel

  Returns void

online_status

• get online_status(): OnlineStatus

• Returns OnlineStatus

  Deprecated

  use status

stat

• get stat(): {
      lost_pkt_cnt: number;
      lost_times: number;
      msg_cnt_per_min: number;
      recv_msg_cnt: number;
      recv_pkt_cnt: number;
      remote_ip: string;
      remote_port: number;
      sent_msg_cnt: number;
      sent_pkt_cnt: number;
      start_time: number;
      ver: string;
  }

• 数据统计

  Returns {
      lost_pkt_cnt: number;
      lost_times: number;
      msg_cnt_per_min: number;
      recv_msg_cnt: number;
      recv_pkt_cnt: number;
      remote_ip: string;
      remote_port: number;
      sent_msg_cnt: number;
      sent_pkt_cnt: number;
      start_time: number;
      ver: string;
  }

  • lost_pkt_cnt: number

  • lost_times: number

  • msg_cnt_per_min: number

  • recv_msg_cnt: number

  • recv_pkt_cnt: number

  • remote_ip: string

  • remote_port: number

  • sent_msg_cnt: number

  • sent_pkt_cnt: number

  • start_time: number

  • ver: string

acquireGfs

• acquireGfs(group_id): Gfs

• Parameters

  • group_id: number

  Returns Gfs

  Cqhttp

  use Group.fs

addClass

• addClass(name): Promise<void>

• 添加好友分组

  Parameters

  • name: string

  Returns Promise<void>

addFriend

• addFriend(group_id, user_id, comment?): Promise<boolean>

• Parameters

  • group_id: number
  • user_id: number
  • comment: string = ""

  Returns Promise<boolean>

  Cqhttp

  use Member.addFriend

cleanCache

• cleanCache(): void

• 清空缓存文件 fs.rm need v14.14

  Returns void

deleteClass

• deleteClass(id): Promise<void>

• 删除好友分组

  Parameters

  • id: number

  Returns Promise<void>

deleteFriend

• deleteFriend(user_id, block?): Promise<boolean>

• Parameters

  • user_id: number
  • block: boolean = true

  Returns Promise<boolean>

  Cqhttp

  use Friend.delete

deleteMsg

• deleteMsg(message_id): Promise<boolean>

• Parameters

  • message_id: string

  Returns Promise<boolean>

  Cqhttp

  use User.recallMsg or Group.recallMsg

deleteStamp

• deleteStamp(id): Promise<void>

• 删除表情(支持批量)

  Parameters

  • id: string | string[]

  Returns Promise<void>

em

• em(name?, data?): void

• emit an event

  Parameters

  • name: string = ""
  • Optionaldata: any

  Returns void

getChannelInfo

• getChannelInfo(guild_id, channel_id): null | {
      channel_id: string;
      channel_name: string;
      channel_type: ChannelType;
      guild_id: string;
  }

• Parameters

  • guild_id: string
  • channel_id: string

  Returns null | {
      channel_id: string;
      channel_name: string;
      channel_type: ChannelType;
      guild_id: string;
  }

getChannelList

• getChannelList(guild_id): {
      channel_id: string;
      channel_name: string;
      channel_type: ChannelType;
      guild_id: string;
  }[]

• 获取子频道列表 use Guild.channels

  Parameters

  • guild_id: string

  Returns {
      channel_id: string;
      channel_name: string;
      channel_type: ChannelType;
      guild_id: string;
  }[]

getChatHistory

• getChatHistory(message_id, count?): Promise<PrivateMessage[] | GroupMessage[]>

• Parameters

  • message_id: string
  • count: number = 20

  Returns Promise<PrivateMessage[] | GroupMessage[]>

  Cqhttp

  use User.getChatHistory or Group.getChatHistory

getCookies

• getCookies(domain?): string

• Parameters

  • domain: Domain = ""

  Returns string

  Cqhttp

  (cqhttp遗留方法) use [domain]

getCsrfToken

• getCsrfToken(): number

• Returns number

  Cqhttp

  use bkn

getForumUrl

• getForumUrl(guild_id, channel_id, forum_id): Promise<string>

• 生成频道帖子分享url

  Parameters

  • guild_id: string

    {string} 频道id
  • channel_id: string

    {string} 子频道id
  • forum_id: string

    {string} 帖子id

  Returns Promise<string>

  帖子分享url

getForwardMsg

• getForwardMsg(resid, fileName?): Promise<ForwardMessage[]>

• 获取转发消息 use Friend.getForwardMsg

  Parameters

  • resid: string
  • OptionalfileName: string

  Returns Promise<ForwardMessage[]>

getFriendList

• getFriendList(): Map<number, FriendInfo>

• Returns Map<number, FriendInfo>

  Cqhttp

  use fl

getGroupInfo

• getGroupInfo(group_id, no_cache?): Promise<GroupInfo>

• Parameters

  • group_id: number
  • no_cache: boolean = false

  Returns Promise<GroupInfo>

  Cqhttp

  use Group.info or Group.renew

getGroupList

• getGroupList(): Map<number, GroupInfo>

• Returns Map<number, GroupInfo>

  Cqhttp

  use gl

getGroupMemberInfo

• getGroupMemberInfo(group_id, user_id, no_cache?): Promise<MemberInfo>

• Parameters

  • group_id: number
  • user_id: number
  • no_cache: boolean = false

  Returns Promise<MemberInfo>

  Cqhttp

  use Member.info or Member.renew

getGroupMemberList

• getGroupMemberList(group_id, no_cache?): Promise<Map<number, MemberInfo>>

• Parameters

  • group_id: number
  • no_cache: boolean = false

  Returns Promise<Map<number, MemberInfo>>

  Cqhttp

  use Group.getMemberMap

getGroupShareJson

• getGroupShareJson(group_id): Promise<any>

• 获取群分享JSON

  Parameters

  • group_id: number

  Returns Promise<any>

getGuildInfo

• getGuildInfo(guild_id): null | {
      guild_id: string;
      guild_name: string;
  }

• Parameters

  • guild_id: string

  Returns null | {
      guild_id: string;
      guild_name: string;
  }

  Cqhttp

  use Guild.info

getGuildList

• getGuildList(): {
      guild_id: string;
      guild_name: string;
  }[]

• Returns {
      guild_id: string;
      guild_name: string;
  }[]

  Cqhttp

  use guilds

getGuildMemberList

• getGuildMemberList(guild_id): never[] | Promise<GuildMember[]>

• 获取频道成员列表 use Guild.getMemberList

  Parameters

  • guild_id: string

  Returns never[] | Promise<GuildMember[]>

getMsg

• getMsg(message_id): Promise<undefined | PrivateMessage | GroupMessage>

• Parameters

  • message_id: string

  Returns Promise<undefined | PrivateMessage | GroupMessage>

  Cqhttp

  use User.getChatHistory or Group.getChatHistory

getProfile

• getProfile(uin): Promise<UserProfile>

• 获取用户资料卡信息

  Parameters

  • uin: number

  Returns Promise<UserProfile>

getRoamingStamp

• getRoamingStamp(no_cache?): Promise<string[]>

• 获取漫游表情

  Parameters

  • no_cache: boolean = false

  Returns Promise<string[]>

getStrangerInfo

• getStrangerInfo(user_id): Promise<{
      age: number;
      area: string;
      nickname: string;
      sex: Gender;
      user_id: number;
  }>

• Parameters

  • user_id: number

  Returns Promise<{
      age: number;
      area: string;
      nickname: string;
      sex: Gender;
      user_id: number;
  }>

  Cqhttp

  use User.getSimpleInfo

getStrangerList

• getStrangerList(): Map<number, StrangerInfo>

• Returns Map<number, StrangerInfo>

  Cqhttp

  use sl

getSystemMsg

• getSystemMsg(): Promise<(FriendRequestEvent | GroupInviteEvent | GroupRequestEvent)[]>

• 获取系统消息

  Returns Promise<(FriendRequestEvent | GroupInviteEvent | GroupRequestEvent)[]>

getVideoUrl

• getVideoUrl(fid, md5): Promise<null | string>

• 获取视频下载地址 use Friend.getVideoUrl

  Parameters

  • fid: string
  • md5: string | Buffer

  Returns Promise<null | string>

group

• group(...group_ids): ((listener: ((event: GroupInviteEvent | GroupMessageEvent) => void)) => ToDispose<Client>)

• 监听群邀请/消息事件

  Parameters

  • Rest...group_ids: number[]

    监听群的群号

  Returns ((listener: ((event: GroupInviteEvent | GroupMessageEvent) => void)) => ToDispose<Client>)

  事件处理

  • • (listener): ToDispose<Client>

    • Parameters

      • listener: ((event: GroupInviteEvent | GroupMessageEvent) => void)
        • • (event): void

          • Parameters

            • event: GroupInviteEvent | GroupMessageEvent

            Returns void

      Returns ToDispose<Client>

imageOcr

• imageOcr(file): Promise<OcrResult>

• Ocr图片转文字

  Parameters

  • file: string | Buffer | Readable

  Returns Promise<OcrResult>

inviteFriend

• inviteFriend(group_id, user_id): Promise<boolean>

• Parameters

  • group_id: number
  • user_id: number

  Returns Promise<boolean>

  Cqhttp

  use Group.invite

login

• login(password?): Promise<void>

• 只能在初始化Client时传了uin或扫码登录，才能调用

  • 传了password则尝试密码登录
  • 不传password则尝试扫码登录 未传任何参数 则尝试扫码登录 掉线重连时也是自动调用此函数，走相同逻辑 你也可以在配置中修改reconn_interval，关闭掉线重连并自行处理

  Parameters

  • Optionalpassword: string | Buffer

    可以为密码原文，或密码的md5值

  Returns Promise<void>
• login(uin?, password?): Promise<void>

• 传了uin，未传password 会优先尝试使用token登录 (token在上次登录成功后存放在this.dir的${uin}_token中) 传了uin无token或token失效时：

  • 传了password则尝试密码登录
  • 不传password则尝试扫码登录 未传任何参数 则尝试扫码登录 掉线重连时也是自动调用此函数，走相同逻辑 你也可以在配置中修改reconn_interval，关闭掉线重连并自行处理

  Parameters

  • Optionaluin: number

    登录账号
  • Optionalpassword: string | Buffer

    可以为密码原文，或密码的md5值

  Returns Promise<void>

makeForwardMsg

• makeForwardMsg(fake, dm?): Promise<JsonElem>

• 制作转发消息 use Friend.makeForwardMsg or Group.makeForwardMsg

  Parameters

  • fake: Forwardable[]
  • dm: boolean = false

  Returns Promise<JsonElem>

off

• off<T>(event): void

• Type Parameters

  • T extends keyof EventMap

  Parameters

  • event: T

  Returns void

• off<S>(event): void

• Type Parameters

  • S extends Matcher

  Parameters

  • event: S & Exclude<S, keyof EventMap>

  Returns void

on

• on<T>(event, listener): ToDispose<Client>

• 收到二维码

  Type Parameters

  • T extends keyof EventMap

  Parameters

  • event: T
  • listener: EventMap[T]

  Returns ToDispose<Client>
• on<S>(event, listener): ToDispose<Client>

• 收到二维码

  Type Parameters

  • S extends Matcher

  Parameters

  • event: S & Exclude<S, keyof EventMap>
  • listener: Listener

  Returns ToDispose<Client>

once

• once<T>(event, listener): ToDispose<Client>

• Type Parameters

  • T extends keyof EventMap

  Parameters

  • event: T
  • listener: EventMap[T]

  Returns ToDispose<Client>

• once<S>(event, listener): ToDispose<Client>

• Type Parameters

  • S extends Matcher

  Parameters

  • event: S & Exclude<S, keyof EventMap>
  • listener: Listener

  Returns ToDispose<Client>

reloadBlackList

• reloadBlackList(): Promise<void>

• 重载黑名单

  Returns Promise<void>

reloadFriendList

• reloadFriendList(): Promise<void>

• 重载好友列表

  Returns Promise<void>

reloadGroupList

• reloadGroupList(): Promise<void>

• 重载群列表

  Returns Promise<void>

reloadGuilds

• reloadGuilds(): Promise<void>

• 重新加载频道列表

  Returns Promise<void>

reloadStrangerList

• reloadStrangerList(): Promise<void>

• 重载陌生人列表

  Returns Promise<void>

removeEssenceMessage

• removeEssenceMessage(message_id): Promise<string>

• 移除群精华消息 use Group.removeEssence

  Parameters

  • message_id: string

    消息id

  Returns Promise<string>

renameClass

• renameClass(id, name): Promise<void>

• 重命名好友分组

  Parameters

  • id: number
  • name: string

  Returns Promise<void>

reportReaded

• reportReaded(message_id): Promise<void>

• Parameters

  • message_id: string

  Returns Promise<void>

  Cqhttp

  use User.markRead or Group.markRead

sendDiscussMsg

• sendDiscussMsg(discuss_id, message, source?): Promise<MessageRet>

• Parameters

  • discuss_id: number
  • message: Sendable
  • Optionalsource: Quotable

  Returns Promise<MessageRet>

  Cqhttp

  use Discuss.sendMsg

sendGroupMsg

• sendGroupMsg(group_id, message, source?): Promise<MessageRet>

• Parameters

  • group_id: number
  • message: Sendable
  • Optionalsource: Quotable

  Returns Promise<MessageRet>

  Cqhttp

  use Group.sendMsg

sendGroupNotice

• sendGroupNotice(group_id, content): Promise<boolean>

• Parameters

  • group_id: number
  • content: string

  Returns Promise<boolean>

  Cqhttp

  use Group.announce

sendGroupPoke

• sendGroupPoke(group_id, user_id): Promise<boolean>

• Parameters

  • group_id: number
  • user_id: number

  Returns Promise<boolean>

  Cqhttp

  use Group.pokeMember or Member.poke

sendGroupSign

• sendGroupSign(group_id): Promise<{
      result: number;
  }>

• Parameters

  • group_id: number

  Returns Promise<{
      result: number;
  }>

  Cqhttp

  use Group.sign

sendGuildMsg

• sendGuildMsg(guild_id, channel_id, message): Promise<GuildMessageRet>

• Parameters

  • guild_id: string
  • channel_id: string
  • message: Sendable

  Returns Promise<GuildMessageRet>

  Cqhttp

  use Guild.sendMsg

sendLike

• sendLike(user_id, times?): Promise<boolean>

• Parameters

  • user_id: number
  • times: number = 1

  Returns Promise<boolean>

  Cqhttp

  use Friend.thumbUp

sendPrivateMsg

• sendPrivateMsg(user_id, message, source?): Promise<MessageRet>

• Parameters

  • user_id: number
  • message: Sendable
  • Optionalsource: Quotable

  Returns Promise<MessageRet>

  Cqhttp

  use Friend.sendMsg

sendSMSCode

• sendSMSCode(): Promise<void>

• Returns Promise<void>

  Deprecated

  use sendSmsCode

sendTempMsg

• sendTempMsg(group_id, user_id, message): Promise<MessageRet>

• Parameters

  • group_id: number
  • user_id: number
  • message: Sendable

  Returns Promise<MessageRet>

  Cqhttp

  use Member.sendMsg

setAvatar

• setAvatar(file): Promise<void>

• 设置头像

  Parameters

  • file: string | Buffer | Readable

  Returns Promise<void>

setBirthday

• setBirthday(birthday): Promise<boolean>

• 设置生日

  Parameters

  • birthday: string | number

    YYYYMMDD格式的string（会过滤非数字字符）或number

  Returns Promise<boolean>

setDescription

• setDescription(description?): Promise<boolean>

• 设置个人说明

  Parameters

  • description: string = ""

  Returns Promise<boolean>

setEssenceMessage

• setEssenceMessage(message_id): Promise<string>

• 添加群精华消息 use Group.addEssence

  Parameters

  • message_id: string

    消息id

  Returns Promise<string>

setFriendAddRequest

• setFriendAddRequest(flag, approve?, remark?, block?): Promise<boolean>

• Parameters

  • flag: string
  • approve: boolean = true
  • remark: string = ""
  • block: boolean = false

  Returns Promise<boolean>

  Cqhttp

  use User.setFriendReq or User.addFriendBack

setGender

• setGender(gender): Promise<boolean>

• 设置性别

  Parameters

  • gender: 0 | 1 | 2

    0：未知，1：男，2：女

  Returns Promise<boolean>

setGroupAddRequest

• setGroupAddRequest(flag, approve?, reason?, block?): Promise<boolean>

• Parameters

  • flag: string
  • approve: boolean = true
  • reason: string = ""
  • block: boolean = false

  Returns Promise<boolean>

  Cqhttp

  use User.setGroupInvite or User.setGroupReq

setGroupAdmin

• setGroupAdmin(group_id, user_id, enable?): Promise<boolean>

• Parameters

  • group_id: number
  • user_id: number
  • enable: boolean = true

  Returns Promise<boolean>

  Cqhttp

  use Group.setAdmin or Member.setAdmin

setGroupAnonymous

• setGroupAnonymous(group_id, enable?): Promise<boolean>

• Parameters

  • group_id: number
  • enable: boolean = true

  Returns Promise<boolean>

  Cqhttp

  use Group.allowAnony

setGroupAnonymousBan