Class Member

Readonly gid

Readonly uid

[unscopables]

• get [unscopables](): {
      c: boolean;
  }

• Returns {
      c: boolean;
  }

  • c: boolean

client

• get client(): Client

• 返回所属的客户端对象

  Returns Client

dm

• get dm(): boolean

• Returns boolean

target

• get target(): number

• Returns number

user_id

• get user_id(): number

• this.uid的别名

  Returns number

addFriendBack

• addFriendBack(seq, remark?): Promise<boolean>

• 回添双向好友

  Parameters

  • seq: number

    申请消息序号

  • remark: string = ""

    好友备注

  Returns Promise<boolean>

asFriend

• asFriend(strict?): Friend

• 返回作为好友的实例

  Parameters

  • strict: boolean = false

  Returns Friend

asMember

• asMember(gid, strict?): Member

• 返回作为某群群员的实例

  Parameters

  • gid: number

  • strict: boolean = false

  Returns Member

getAddFriendSetting

• getAddFriendSetting(): Promise<number>

• Returns Promise<number>

getAvatarUrl

• getAvatarUrl(size?): string

• 获取头像url

  Parameters

  • size: 0 | 100 | 40 | 140 = 0

    头像大小，默认0

  Returns string

  头像的url地址

getChatHistory

• getChatHistory(time?, cnt?): Promise<PrivateMessage[]>

• 获取time往前的cnt条聊天记录

  Parameters

  • time: number = ...

    默认当前时间，为时间戳的分钟数（Date.now() / 1000）

  • cnt: number = 20

    聊天记录条数，默认20，超过20按20处理

  Returns Promise<PrivateMessage[]>

  私聊消息列表，服务器记录不足cnt条则返回能获取到的最多消息记录

getFileInfo

• getFileInfo(fid): Promise<Omit<FileElem, "type"> & Record<"url", string>>

• 获取文件信息

  Parameters

  • fid: string

    文件id

  Returns Promise<Omit<FileElem, "type"> & Record<"url", string>>

getFileUrl

• getFileUrl(fid): Promise<string>

• 获取离线文件下载地址

  Parameters

  • fid: string

    文件id

  Returns Promise<string>

getForwardMsg

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

• 下载并解析合并转发

  Parameters

  • resid: string

  • fileName: string = "MultiMsg"

  Returns Promise<ForwardMessage[]>

getSimpleInfo

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

• 查看资料

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

getVideoUrl

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

• 获取视频下载地址

  Parameters

  • fid: string

  • md5: string | Buffer

  Returns Promise<string>

makeForwardMsg

• makeForwardMsg(msglist): Promise<XmlElem>

• 制作一条合并转发消息以备发送（制作一次可以到处发） 需要注意的是，好友图片和群图片的内部格式不一样，对着群制作的转发消息中的图片，发给好友可能会裂图，反过来也一样 支持4层套娃转发（PC仅显示3层）

  Parameters

  • msglist: Forwardable | Forwardable[]

  Returns Promise<XmlElem>

markRead

• markRead(time?): Promise<void>

• 标记time之前为已读

  Parameters

  • time: number = ...

    默认当前时间，为时间戳的分钟数（Date.now() / 1000）

  Returns Promise<void>

recallMsg

• recallMsg(msg): Promise<boolean>

• 撤回消息

  Parameters

  • msg: PrivateMessage

  Returns Promise<boolean>
• recallMsg(msgid): Promise<boolean>

• Parameters

  • msgid: string

  Returns Promise<boolean>

• recallMsg(seq, rand, time): Promise<boolean>

• Parameters

  • seq: number

  • rand: number

  • time: number

  Returns Promise<boolean>

• recallMsg(param, rand, time): Promise<boolean>

• 撤回消息，cqhttp方法用

  Parameters

  • param: number

  • rand: number

  • time: number

  Returns Promise<boolean>
• recallMsg(message_id): Promise<boolean>

• 撤回消息

  Parameters

  • message_id: string

    消息id

  Returns Promise<boolean>
• recallMsg(message): Promise<boolean>

• 撤回消息

  Parameters

  • message: PrivateMessage

    私聊消息对象

  Returns Promise<boolean>

sendMsg

• sendMsg(content, source?): Promise<MessageRet>

• 发送一条消息

  Parameters

  • content: Sendable

    消息内容

  • Optional source: Quotable

    引用回复的消息

  Returns Promise<MessageRet>

setFriendReq

• setFriendReq(seq, yes?, remark?, block?): Promise<boolean>

• 处理好友申请

  Parameters

  • seq: number

    申请消息序号

  • yes: boolean = true

    是否同意

  • remark: string = ""

    好友备注

  • block: boolean = false

    是否屏蔽来自此用户的申请

  Returns Promise<boolean>

setGroupInvite

• setGroupInvite(gid, seq, yes?, block?): Promise<boolean>

• 处理群邀请

  Parameters

  • gid: number

    群号

  • seq: number

    申请消息序号

  • yes: boolean = true

    是否同意

  • block: boolean = false

    是否屏蔽来自此群的邀请

  Returns Promise<boolean>

setGroupReq

• setGroupReq(gid, seq, yes?, reason?, block?): Promise<boolean>

• 处理入群申请

  Parameters

  • gid: number

    群号

  • seq: number

    申请消息序号

  • yes: boolean = true

    是否同意

  • reason: string = ""

    若拒绝，拒绝的原因

  • block: boolean = false

    是否屏蔽来自此用户的申请

  Returns Promise<boolean>

shareMusic

• shareMusic(platform, id): Promise<void>

• 发送音乐分享

  Parameters

  • platform: MusicPlatform

  • id: string

  Returns Promise<void>

shareUrl

• shareUrl(content, config?): Promise<void>

• 发送网址分享

  Parameters

  • content: ShareContent

  • Optional config: ShareConfig

  Returns Promise<void>

thumbUp

• thumbUp(times?): Promise<boolean>

• 点赞，支持陌生人点赞

  Parameters

  • times: number = 1

    点赞次数，默认1次

  Returns Promise<boolean>

uploadImages

• uploadImages(imgs): Promise<PromiseRejectedResult[]>

• 上传一批图片以备发送(无数量限制)，理论上传一次所有群和好友都能发

  Parameters

  • imgs: Image[] | ImageElem[]

  Returns Promise<PromiseRejectedResult[]>

uploadPtt

• uploadPtt(elem): Promise<PttElem>

• 上传一个语音以备发送(理论上传一次所有群和好友都能发)

  Parameters

  • elem: PttElem

  Returns Promise<PttElem>

uploadVideo

• uploadVideo(elem): Promise<VideoElem>

• 上传一个视频以备发送(理论上传一次所有群和好友都能发)

  Parameters

  • elem: VideoElem

  Returns Promise<VideoElem>