Class Friend

好友

Hierarchy (view full)

User
- Friend

Constructors

`Protected`constructor

new Friend(c, uin, _info?): Friend
Parameters
- c: Client
- uin: number
- Optional_info: FriendInfo
Returns Friend
Overrides User.constructor
- Defined in src/friend.ts:579

Properties

`Readonly`_uid

_uid: string

`Protected` `Readonly`c

c: Client

`Protected` `Optional`gid

gid?: number

对方群号

`Readonly`uin

uin: number

Accessors

[unscopables]

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

class_id

get class_id(): undefined | number
分组id

Returns undefined | number
- Defined in src/friend.ts:570

class_name

get class_name(): undefined | string
分组名

Returns undefined | string
- Defined in src/friend.ts:574

client

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

Returns Client
Inherited from User.client
- Defined in src/internal/contactable.ts:86

dm

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

info

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

Returns undefined | FriendInfo
- Defined in src/friend.ts:549

nickname

get nickname(): undefined | string
昵称

Returns undefined | string
- Defined in src/friend.ts:558

remark

get remark(): undefined | string
备注

Returns undefined | string
- Defined in src/friend.ts:566

sex

get sex(): undefined | Gender
性别

Returns undefined | Gender
- Defined in src/friend.ts:562

target

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

uid

get uid(): string
对方uid

Returns string
Overrides User.uid
- Defined in src/friend.ts:553

user_id

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

Returns number
Inherited from User.user_id
- Defined in src/friend.ts:45

Methods

`Protected`_preprocess

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

`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 src/friend.ts:314

addFriendBack

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

asFriend

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

asMember

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

delete

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

forwardFile

forwardFile(fid, group_id?): Promise<string>
转发离线文件
Parameters
- fid: string
  文件fid
- group_id: number = 0
  群号，转发群文件时填写
Returns Promise<string>
转发成功后新文件的id
- Defined in src/friend.ts:798

getAddFriendSetting

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

getAvatarUrl

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

getChatHistory

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

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 src/friend.ts:454

getFileUrl

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

getForwardMsg

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

getGroupNTPicRkey

getGroupNTPicRkey(): Promise<string>
获取QQNT群图rkey

Returns Promise<string>
Deprecated
Inherited from User.getGroupNTPicRkey
- Defined in src/internal/contactable.ts:1269

getGroupNTPicURL

getGroupNTPicURL(imgInfo, gid): Promise<null | string>
获取QQNT群图URL
Parameters
- imgInfo: any
- gid: undefined | number
Returns Promise<null | string>
Inherited from User.getGroupNTPicURL
- Defined in src/internal/contactable.ts:1304

getNTPicInfobyFileid

getNTPicInfobyFileid(fileid): Promise<{
    appid: any;
    expires: any;
    md5: any;
    size: any;
    time: any;
    uin: any;
}>
通过fileid获取图片信息
Parameters
- fileid: string
Returns Promise<{
    appid: any;
    expires: any;
    md5: any;
    size: any;
    time: any;
    uin: any;
}>
Inherited from User.getNTPicInfobyFileid
- Defined in src/internal/contactable.ts:1427

getNTPicRkey

getNTPicRkey(): Promise<any>
获取QQNT图片rkey

Returns Promise<any>
Inherited from User.getNTPicRkey
- Defined in src/internal/contactable.ts:1222

getNTPicURLbyFileid

getNTPicURLbyFileid(fileid): Promise<string>
通过fileid获取QQNT图片URL
Parameters
- fileid: string
Returns Promise<string>
Inherited from User.getNTPicURLbyFileid
- Defined in src/internal/contactable.ts:1397

getNTPicURLbyFileidApi

getNTPicURLbyFileidApi(fileid): Promise<{
data: string;
result: number;
}>
通过fileid获取图片url
Parameters
- fileid: string
Returns Promise<{
data: string;
result: number;
}>
Inherited from User.getNTPicURLbyFileidApi
- Defined in src/internal/contactable.ts:1418

getNTVideoUrl

getNTVideoUrl(elem): Promise<null | string>
Parameters
- elem: VideoElem
Returns Promise<null | string>
Inherited from User.getNTVideoUrl
- Defined in src/internal/contactable.ts:1076

getOffNTPicRkey

getOffNTPicRkey(): Promise<string>
获取QQNT私聊图rkey

Returns Promise<string>
Deprecated
Inherited from User.getOffNTPicRkey
- Defined in src/internal/contactable.ts:1286

getOffNTPicURL

getOffNTPicURL(imgInfo, uid): Promise<null | string>
获取QQNT私聊图URL
Parameters
- imgInfo: any
- uid: any
Returns Promise<null | string>
Inherited from User.getOffNTPicURL
- Defined in src/internal/contactable.ts:1350

getPttUrl

getPttUrl(elem): Promise<undefined | null | string>
Parameters
- elem: PttElem
Returns Promise<undefined | null | string>
Inherited from User.getPttUrl
- Defined in src/internal/contactable.ts:1147

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 src/friend.ts:146

getVideoUrl

getVideoUrl(elem, md5?): Promise<null | string>
获取视频下载地址
Parameters
- elem: string | VideoElem
- md5: string | Buffer = ""
Returns Promise<null | string>
Inherited from User.getVideoUrl
- Defined in src/internal/contactable.ts:1039

makeForwardMsg

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

markRead

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

poke

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

recallFile

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

recallMsg

recallMsg(msg): Promise<boolean>
撤回消息
Parameters
- msg: PrivateMessage
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:37
recallMsg(msgid): Promise<boolean>
Parameters
- msgid: string
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:38
recallMsg(seq, rand, time): Promise<boolean>
Parameters
- seq: number
- rand: number
- time: number
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:39
recallMsg(param, rand, time): Promise<boolean>
撤回消息，cqhttp方法用
Parameters
- param: number
- rand: number
- time: number
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:246
recallMsg(message_id): Promise<boolean>
撤回消息
Parameters
- message_id: string
  消息id
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:251
recallMsg(message): Promise<boolean>
撤回消息
Parameters
- message: PrivateMessage
  私聊消息对象
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:256

searchSameGroup

searchSameGroup(): Promise<any>
查找机器人与这个人的共群

Returns Promise<any>
- Defined in src/friend.ts:873

sendFile

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

sendMsg

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

setClass

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

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 src/friend.ts:378

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 src/friend.ts:431

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 src/friend.ts:404

setRemark

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

shareMusic

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

shareUrl

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

thumbUp

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

uploadImages

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

uploadLongMsg

uploadLongMsg(content, source?, isNT?): Promise<LongMsgElem>
Parameters
- content: Sendable | Converter
- Optionalsource: Quotable
- isNT: undefined | boolean = ...
Returns Promise<LongMsgElem>
Inherited from User.uploadLongMsg
- Defined in src/internal/contactable.ts:642

uploadPtt

uploadPtt(elem, transcoding?, brief?): Promise<PttElem>
上传一个语音以备发送(理论上传一次所有群和好友都能发)
Parameters
- elem: PttElem
- transcoding: boolean = true
- brief: string = ""
Returns Promise<PttElem>
Inherited from User.uploadPtt
- Defined in src/internal/contactable.ts:460

uploadVideo

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

`Static`as

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

Class Friend

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns Friend

Properties

Readonly_uid

Protected Readonlyc

Protected Optionalgid

Readonlyuin

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

uid

Returns string

user_id

Returns number

Methods

Protected_preprocess

Parameters

Returns Promise<Converter>

Protected_sendMsg

Parameters

Returns Promise<MessageRet>

addFriendBack

Parameters

Returns Promise<boolean>

asFriend

Parameters

Returns Friend

asMember

Parameters

Returns Member

delete

Parameters

Returns Promise<boolean>

forwardFile

Parameters

Returns Promise<string>

getAddFriendSetting

Returns Promise<number>

getAvatarUrl

Parameters

Returns string

getChatHistory

Parameters

Returns Promise<PrivateMessage[]>

getFileInfo

Parameters

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

getFileUrl

Parameters

Returns Promise<string>

getForwardMsg

Parameters

`Protected`constructor

`Readonly`_uid

`Protected` `Readonly`c

`Protected` `Optional`gid

`Readonly`uin

Returns {
c: boolean;
}

`Protected`_preprocess

`Protected`_sendMsg

Returns Promise<{
appid: any;
expires: any;
md5: any;
size: any;
time: any;
uin: any;
}>

Returns Promise<{
data: string;
result: number;
}>

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