Class Friend

好友

Hierarchy

User
- Friend

Constructors

`Protected` constructor

new Friend(c, uid, _info?): Friend
Parameters
- c: Client
- uid: number
- Optional _info: FriendInfo
Returns Friend
Overrides User.constructor
- Defined in lib/friend.ts:486

Properties

`Private` `Optional` _info

_info?: FriendInfo

`Protected` `Readonly` c

c: Client

`Protected` `Optional` gid

gid?: number

对方群号

`Readonly` uid

uid: number

Accessors

[unscopables]

get [unscopables](): {
c: boolean;
}
Returns {
c: boolean;
}
- c: boolean
Inherited from User.[unscopables]
- Defined in lib/internal/contactable.ts:73

class_id

get class_id(): undefined | number
分组id

Returns undefined | number
- Defined in lib/friend.ts:478

class_name

get class_name(): undefined | string
分组名

Returns undefined | string
- Defined in lib/friend.ts:482

client

get client(): Client
返回所属的客户端对象

Returns Client
Inherited from User.client
- Defined in lib/internal/contactable.ts:65

dm

get dm(): boolean
Returns boolean
Inherited from User.dm
- Defined in lib/internal/contactable.ts:60

info

get info(): undefined | FriendInfo
好友资料

Returns undefined | FriendInfo
- Defined in lib/friend.ts:461

nickname

get nickname(): undefined | string
昵称

Returns undefined | string
- Defined in lib/friend.ts:466

remark

get remark(): undefined | string
备注

Returns undefined | string
- Defined in lib/friend.ts:474

sex

get sex(): undefined | Gender
性别

Returns undefined | Gender
- Defined in lib/friend.ts:470

target

get target(): number
Returns number
Inherited from User.target
- Defined in lib/internal/contactable.ts:55

user_id

get user_id(): number
this.uid的别名

Returns number
Inherited from User.user_id
- Defined in lib/friend.ts:33

Methods

`Protected` _preprocess

_preprocess(content, source?): Promise<Converter>
发消息预处理
Parameters
- content: Sendable
- Optional source: Quotable
Returns Promise<Converter>
Inherited from User._preprocess
- Defined in lib/internal/contactable.ts:222

`Protected` _sendMsg

_sendMsg(proto3, brief, file?): Promise<MessageRet>
Parameters
- proto3: Encodable
- brief: string
- file: boolean = false
Returns Promise<MessageRet>
Inherited from User._sendMsg
- Defined in lib/friend.ts:236

addFriendBack

addFriendBack(seq, remark?): Promise<boolean>
回添双向好友
Parameters
- seq: number
  
  申请消息序号
- remark: string = ""
  
  好友备注
Returns Promise<boolean>
Inherited from User.addFriendBack
- Defined in lib/friend.ts:267

asFriend

asFriend(strict?): Friend
返回作为好友的实例
Parameters
- strict: boolean = false
Returns Friend
Inherited from User.asFriend
- Defined in lib/friend.ts:47

asMember

asMember(gid, strict?): Member
返回作为某群群员的实例
Parameters
- gid: number
- strict: boolean = false
Returns Member
Inherited from User.asMember
- Defined in lib/friend.ts:52

delete

delete(block?): Promise<boolean>
删除好友
Parameters
- block: boolean = true
  
  屏蔽此好友的申请，默认为true
Returns Promise<boolean>
- Defined in lib/friend.ts:526

forwardFile

forwardFile(fid): Promise<string>
转发离线文件
Parameters
- fid: string
  
  文件id
Returns Promise<string>
转发成功后新文件的id
- Defined in lib/friend.ts:683

getAddFriendSetting

getAddFriendSetting(): Promise<number>
Returns Promise<number>
Inherited from User.getAddFriendSetting
- Defined in lib/friend.ts:65

getAvatarUrl

getAvatarUrl(size?): string
获取头像url
Parameters
- size: 0 | 100 | 40 | 140 = 0
  
  头像大小，默认0
Returns string
头像的url地址
Inherited from User.getAvatarUrl
- Defined in lib/friend.ts:61

getChatHistory

getChatHistory(time?, cnt?): Promise<PrivateMessage[]>
获取time往前的cnt条聊天记录
Parameters
- time: number = ...
  
  默认当前时间，为时间戳的分钟数（Date.now() / 1000）
- cnt: number = 20
  
  聊天记录条数，默认20，超过20按20处理
Returns Promise<PrivateMessage[]>
私聊消息列表，服务器记录不足cnt条则返回能获取到的最多消息记录
Inherited from User.getChatHistory
- Defined in lib/friend.ts:136

getFileInfo

getFileInfo(fid): Promise<Omit<FileElem, "type"> & Record<"url", string>>
获取文件信息
Parameters
- fid: string
  
  文件id
Returns Promise<Omit<FileElem, "type"> & Record<"url", string>>
Inherited from User.getFileInfo
- Defined in lib/friend.ts:368

getFileUrl

getFileUrl(fid): Promise<string>
获取离线文件下载地址
Parameters
- fid: string
  
  文件id
Returns Promise<string>
Inherited from User.getFileUrl
- Defined in lib/friend.ts:402

getForwardMsg

getForwardMsg(resid, fileName?): Promise<ForwardMessage[]>
下载并解析合并转发
Parameters
- resid: string
- fileName: string = "MultiMsg"
Returns Promise<ForwardMessage[]>
Inherited from User.getForwardMsg
- Defined in lib/internal/contactable.ts:629

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;
}>
Inherited from User.getSimpleInfo
- Defined in lib/friend.ts:102

getVideoUrl

getVideoUrl(fid, md5): Promise<string>
获取视频下载地址
Parameters
- fid: string
- md5: string | Buffer
Returns Promise<string>
Inherited from User.getVideoUrl
- Defined in lib/internal/contactable.ts:688

makeForwardMsg

makeForwardMsg(msglist): Promise<XmlElem>
制作一条合并转发消息以备发送（制作一次可以到处发）需要注意的是，好友图片和群图片的内部格式不一样，对着群制作的转发消息中的图片，发给好友可能会裂图，反过来也一样支持4层套娃转发（PC仅显示3层）
Parameters
- msglist: Forwardable | Forwardable[]
Returns Promise<XmlElem>
Inherited from User.makeForwardMsg
- Defined in lib/internal/contactable.ts:496

markRead

markRead(time?): Promise<void>
标记time之前为已读
Parameters
- time: number = ...
  
  默认当前时间，为时间戳的分钟数（Date.now() / 1000）
Returns Promise<void>
Inherited from User.markRead
- Defined in lib/friend.ts:161

poke

poke(self?): Promise<boolean>
戳一戳
Parameters
- self: boolean = false
Returns Promise<boolean>
- Defined in lib/friend.ts:513

recallFile

recallFile(fid): Promise<boolean>
撤回离线文件
Parameters
- fid: string
  
  文件id
Returns Promise<boolean>
- Defined in lib/friend.ts:661

recallMsg

recallMsg(msg): Promise<boolean>
撤回消息
Parameters
- msg: PrivateMessage
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in lib/friend.ts:25
recallMsg(msgid): Promise<boolean>
Parameters
- msgid: string
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in lib/friend.ts:26
recallMsg(seq, rand, time): Promise<boolean>
Parameters
- seq: number
- rand: number
- time: number
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in lib/friend.ts:27
recallMsg(param, rand, time): Promise<boolean>
撤回消息，cqhttp方法用
Parameters
- param: number
- rand: number
- time: number
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in lib/friend.ts:176
recallMsg(message_id): Promise<boolean>
撤回消息
Parameters
- message_id: string
  
  消息id
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in lib/friend.ts:181
recallMsg(message): Promise<boolean>
撤回消息
Parameters
- message: PrivateMessage
  
  私聊消息对象
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in lib/friend.ts:186

sendFile

sendFile(file, filename?, callback?): Promise<string>
发送离线文件
Parameters
- file: string | Buffer | Uint8Array
  
  string表示从该本地文件路径获取，Buffer表示直接发送这段内容
- Optional filename: string
  
  对方看到的文件名，file为Buffer时，若留空则自动以md5命名
- Optional callback: ((percentage) => void)
  
  监控上传进度的回调函数，拥有一个"百分比进度"的参数
  - - (percentage): void
    - Parameters
      
      percentage: string
      
      Returns void
Returns Promise<string>
文件id(撤回时使用)
- Defined in lib/friend.ts:544

sendMsg

sendMsg(content, source?): Promise<MessageRet>
发送一条消息
Parameters
- content: Sendable
  
  消息内容
- Optional source: Quotable
  
  引用回复的消息
Returns Promise<MessageRet>
Inherited from User.sendMsg
- Defined in lib/friend.ts:231

setClass

setClass(id): Promise<void>
设置分组(注意：如果分组id不存在也会成功)
Parameters
- id: number
Returns Promise<void>
- Defined in lib/friend.ts:499

setFriendReq

setFriendReq(seq, yes?, remark?, block?): Promise<boolean>
处理好友申请
Parameters
- seq: number
  
  申请消息序号
- yes: boolean = true
  
  是否同意
- remark: string = ""
  
  好友备注
- block: boolean = false
  
  是否屏蔽来自此用户的申请
Returns Promise<boolean>
Inherited from User.setFriendReq
- Defined in lib/friend.ts:292

setGroupInvite

setGroupInvite(gid, seq, yes?, block?): Promise<boolean>
处理群邀请
Parameters
- gid: number
  
  群号
- seq: number
  
  申请消息序号
- yes: boolean = true
  
  是否同意
- block: boolean = false
  
  是否屏蔽来自此群的邀请
Returns Promise<boolean>
Inherited from User.setGroupInvite
- Defined in lib/friend.ts:345

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>
Inherited from User.setGroupReq
- Defined in lib/friend.ts:318

setRemark

setRemark(remark): Promise<void>
设置备注
Parameters
- remark: string
Returns Promise<void>
- Defined in lib/friend.ts:492

shareMusic

shareMusic(platform, id): Promise<void>
发送音乐分享
Parameters
- platform: MusicPlatform
- id: string
Returns Promise<void>
Inherited from User.shareMusic
- Defined in lib/internal/contactable.ts:217

shareUrl

shareUrl(content, config?): Promise<void>
发送网址分享
Parameters
- content: ShareContent
- Optional config: ShareConfig
Returns Promise<void>
Inherited from User.shareUrl
- Defined in lib/internal/contactable.ts:212

thumbUp

thumbUp(times?): Promise<boolean>
点赞，支持陌生人点赞
Parameters
- times: number = 1
  
  点赞次数，默认1次
Returns Promise<boolean>
Inherited from User.thumbUp
- Defined in lib/friend.ts:78

uploadImages

uploadImages(imgs): Promise<PromiseRejectedResult[]>
上传一批图片以备发送(无数量限制)，理论上传一次所有群和好友都能发
Parameters
- imgs: Image[] | ImageElem[]
Returns Promise<PromiseRejectedResult[]>
Inherited from User.uploadImages
- Defined in lib/internal/contactable.ts:148

uploadPtt

uploadPtt(elem): Promise<PttElem>
上传一个语音以备发送(理论上传一次所有群和好友都能发)
Parameters
- elem: PttElem
Returns Promise<PttElem>
Inherited from User.uploadPtt
- Defined in lib/internal/contactable.ts:383

uploadVideo

uploadVideo(elem): Promise<VideoElem>
上传一个视频以备发送(理论上传一次所有群和好友都能发)
Parameters
- elem: VideoElem
Returns Promise<VideoElem>
Inherited from User.uploadVideo
- Defined in lib/internal/contactable.ts:274

`Static` as

as(this, uid, strict?): Friend
Parameters
- this: Client
- uid: number
- strict: boolean = false
Returns Friend
Overrides User.as
- Defined in lib/friend.ts:448

Class Friend

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

c: Client

uid: number

Optional _info: FriendInfo

Returns Friend

Properties

Private Optional _info

Protected Readonly c

Protected Optional gid

Readonly uid

Accessors

[unscopables]

Returns { c: boolean; }

c: boolean

class_id

Returns undefined | number

class_name

Returns undefined | string

client

Returns Client

dm

Returns boolean

info

Returns undefined | FriendInfo

nickname

Returns undefined | string

remark

Returns undefined | string

sex

Returns undefined | Gender

target

Returns number

user_id

Returns number

Methods

Protected _preprocess

Parameters

content: Sendable

Optional source: Quotable

Returns Promise<Converter>

Protected _sendMsg

Parameters

proto3: Encodable

brief: string

file: boolean = false

Returns Promise<MessageRet>

addFriendBack

Parameters

seq: number

remark: string = ""

Returns Promise<boolean>

asFriend

Parameters

strict: boolean = false

Returns Friend

asMember

Parameters

gid: number

strict: boolean = false

Returns Member

delete

Parameters

block: boolean = true

Returns Promise<boolean>

forwardFile

Parameters

fid: string

Returns Promise<string>

getAddFriendSetting

Returns Promise<number>

getAvatarUrl

`Protected` constructor

`Optional` _info: FriendInfo

`Private` `Optional` _info

`Protected` `Readonly` c

`Protected` `Optional` gid

`Readonly` uid

Returns {
c: boolean;
}

`Protected` _preprocess

`Optional` source: Quotable

`Protected` _sendMsg

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