Class Member

Readonlygid

Readonlyuid

[unscopables]

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

  Returns { c: boolean }

class_id

• get class_id(): undefined | number

  分组id

  Returns undefined | number

class_name

• get class_name(): undefined | string

  分组名

  Returns undefined | string

client

• get client(): Client

  返回所属的客户端对象

  Returns Client

dm

• get dm(): boolean

  Returns boolean

nickname

• get nickname(): undefined | string

  昵称

  Returns undefined | string

remark

• get remark(): undefined | string

  备注

  Returns undefined | string

scene

• get scene(): "user" | "group"

  Returns "user" | "group"

sex

• get sex(): undefined | Gender

  性别

  Returns undefined | Gender

target

• get target(): string

  Returns string

user_id

• get user_id(): string

  this.uid的别名

  Returns string

addFriendBack

• addFriendBack(seq: number, remark?: string): Promise<void>

  回添双向好友

  Parameters

  • seq: number

    申请消息序号
  • remark: string = ""

  Returns Promise<void>

asFriend

• asFriend(strict?: boolean): User

  返回作为好友的实例

  Parameters

  • strict: boolean = false

  Returns User

asMember

• asMember(gid: string, strict?: boolean): Member

  返回作为某群群员的实例

  Parameters

  • gid: string
  • strict: boolean = false

  Returns Member

delete

• delete(block?: boolean): Promise<void>

  删除好友

  Parameters

  • block: boolean = true

    屏蔽此好友的申请，默认为true

  Returns Promise<void>

forwardFile

• forwardFile(fid: string): Promise<MessageRet>

  转发离线文件

  Parameters

  • fid: string

    文件消息ID

  Returns Promise<MessageRet>

  转发成功后新文件的消息ID

forwardMsg

• forwardMsg(mid: string): Promise<RSendMsg>

  转发消息

  Parameters

  • mid: string

  Returns Promise<RSendMsg>

getAvatarUrl

• getAvatarUrl(size?: 0 | 40 | 100 | 140): string

  获取头像url

  Parameters

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

    头像大小，默认0

  Returns string

  头像的url地址

getChatHistory

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

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

  Parameters

  • time: number = ...

    默认当前时间，为时间戳的分钟数（Date.now() / 1000）
  • count: number = 20

  Returns Promise<PrivateMessage[]>

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

getFileInfo

• getFileInfo(id: string): Promise<BinaryFile | URLFile>

  获取文件信息

  Parameters

  • id: string

    文件消息ID

  Returns Promise<BinaryFile | URLFile>

getFileUrl

• getFileUrl(fid: string): Promise<undefined | string>

  获取离线文件下载地址

  Parameters

  • fid: string

    文件消息ID

  Returns Promise<undefined | string>

getForwardMsg

• getForwardMsg(id: string): Promise<GroupMessage[]>

  下载并解析合并转发

  Parameters

  • id: string

  Returns Promise<GroupMessage[]>

getSimpleInfo

• getSimpleInfo(): Promise<undefined | FriendInfo>

  查看资料

  Returns Promise<undefined | FriendInfo>

getVideoUrl

• getVideoUrl(fid: string): Promise<undefined | string>

  获取视频下载地址

  Parameters

  • fid: string

  Returns Promise<undefined | string>

makeForwardMsg

• makeForwardMsg(msglist: Forwardable | Forwardable[]): ForwardNode

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

  Parameters

  • msglist: Forwardable | Forwardable[]

  Returns ForwardNode

markRead

• markRead(time?: number): Promise<void>

  标记time之前为已读

  Parameters

  • time: number = ...

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

  Returns Promise<void>

recallFile

• recallFile(fid: string): Promise<boolean>

  撤回离线文件

  Parameters

  • fid: string

    文件消息ID

  Returns Promise<boolean>

recallMsg

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

  撤回消息

  Parameters

  • message_id: string

    消息id

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

  撤回消息

  Parameters

  • message: Message

    私聊消息对象

  Returns Promise<boolean>

searchSameGroup

• searchSameGroup(): Promise<
      {
          avatar?: string;
          Group_Id: string;
          groupName: string;
          id: string;
          name: string;
          remark?: string;
          whole_mute?: boolean;
      }[],
  >

  查找机器人与这个人的共群

  Returns Promise<
      {
          avatar?: string;
          Group_Id: string;
          groupName: string;
          id: string;
          name: string;
          remark?: string;
          whole_mute?: boolean;
      }[],
  >

sendFile

• sendFile(file: string | Buffer<ArrayBufferLike>, name?: string): Promise<string>

  发送离线文件

  Parameters

  • file: string | Buffer<ArrayBufferLike>

    string表示从该本地文件路径获取，Buffer表示直接发送这段内容
  • Optionalname: string

    对方看到的文件名，file为Buffer时，若留空则自动以md5命名

  Returns Promise<string>

  文件ID

sendForwardMsg

• sendForwardMsg(node: Forwardable | Forwardable[]): Promise<MessageRet>

  Parameters

  • node: Forwardable | Forwardable[]

  Returns Promise<MessageRet>

sendMsg

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

  发送一条消息

  Parameters

  • content: Sendable

    消息内容
  • Optionalsource: Quotable

    引用回复的消息

  Returns Promise<MessageRet>

setAvatar

• setAvatar(avatar: string | Buffer<ArrayBufferLike>): Promise<void>

  设置群头像

  Parameters

  • avatar: string | Buffer<ArrayBufferLike>

  Returns Promise<void>

setClass

• setClass(name: number): Promise<void>

  设置分组(注意：如果分组id不存在也会成功)

  Parameters

  • name: number

  Returns Promise<void>

setFriendReq

• setFriendReq(
      seq: number,
      result?: boolean,
      remark?: string,
      block?: boolean,
  ): Promise<void>

  处理好友申请

  Parameters

  • seq: number

    申请消息序号
  • result: boolean = true

    是否同意
  • remark: string = ""

    好友备注
  • block: boolean = false

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

  Returns Promise<void>

setGroupInvite

• setGroupInvite(
      gid: string,
      seq: number,
      result?: boolean,
      block?: boolean,
  ): Promise<void>

  处理群邀请

  Parameters

  • gid: string

    群号
  • seq: number

    申请消息序号
  • result: boolean = true

    是否同意
  • block: boolean = false

    是否屏蔽来自此群的邀请

  Returns Promise<void>

setGroupReq

• setGroupReq(
      gid: string,
      seq: number,
      result?: boolean,
      reason?: string,
      block?: boolean,
  ): Promise<void>

  处理入群申请

  Parameters

  • gid: string

    群号
  • seq: number

    申请消息序号
  • result: boolean = true

    是否同意
  • reason: string = ""

    若拒绝，拒绝的原因
  • block: boolean = false

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

  Returns Promise<void>

setName

• setName(name: string): Promise<void>

  设置群名

  Parameters

  • name: string

  Returns Promise<void>

setRemark

• setRemark(remark: string): Promise<void>

  设置备注

  Parameters

  • remark: string

  Returns Promise<void>

shareMusic

• shareMusic(platform: string, id: string): Promise<MessageRet>

  发送音乐分享

  Parameters

  • platform: string
  • id: string

  Returns Promise<MessageRet>

shareUrl

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

  发送网址分享

  Parameters

  • content: any
  • Optionalconfig: any

  Returns Promise<MessageRet>

thumbUp

• thumbUp(times?: number): Promise<void>

  点赞，支持陌生人点赞

  Parameters

  • times: number = 1

    点赞次数，默认1次

  Returns Promise<void>

uploadImage

• uploadImage(elem: ImageElem): Promise<FileIDElem>

  Parameters

  • elem: ImageElem

  Returns Promise<FileIDElem>

uploadImages

• uploadImages(images: ImageElem[]): Promise<FileIDElem[]>

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

  Parameters

  • images: ImageElem[]

  Returns Promise<FileIDElem[]>

uploadPtt

• uploadPtt(
      elem: PttElem,
      transcoding?: boolean,
      brief?: string,
  ): Promise<FileIDElem>

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

  Parameters

  • elem: PttElem
  • transcoding: boolean = true
  • brief: string = ""

  Returns Promise<FileIDElem>

uploadVideo

• uploadVideo(elem: VideoElem): Promise<FileIDElem>

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

  Parameters

  • elem: VideoElem

  Returns Promise<FileIDElem>