Class Friend

好友

Hierarchy (View Summary)

icqq.User
- Friend

Constructors

`Protected`constructor

new Friend(c: icqq.Client, uid: number, _info?: FriendInfo): icqq.Friend
Parameters
- c: icqq.Client
- uid: number
- Optional_info: FriendInfo
Returns icqq.Friend
Overrides User.constructor
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:180

Properties

`Protected` `Readonly`c

c: icqq.Client

getInfo

getInfo: () => Promise<FriendInfo>

获取好友信息

`Protected` `Optional`gid

gid?: number

对方群号

`Readonly`uid

uid: number

对方QQ号

user_id

user_id: number

用户id

Accessors

[unscopables]

get "[unscopables]"(): { c: boolean }
Returns { c: boolean }
Inherited from User.[unscopables]
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:17

class_id

get class_id(): number
分组id

Returns number
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:177

class_name

get class_name(): string
分组名

Returns string
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:179

client

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

Returns icqq.Client
Inherited from User.client
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:15

dm

get dm(): boolean
Returns boolean
Inherited from User.dm
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:13

info

get info(): FriendInfo
好友资料

Returns FriendInfo
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:169

nickname

get nickname(): string
昵称

Returns string
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:171

remark

get remark(): string
备注

Returns string
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:175

sex

get sex(): Gender
性别

Returns Gender
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:173

target

get target(): number
Returns number
Inherited from User.target
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:12

user_id

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

Returns number
Inherited from User.user_id
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:19

Methods

`Protected`_preprocess

_preprocess(content: Sendable, source?: Quotable): Promise<Converter>
发消息预处理
Parameters
- content: Sendable
- Optionalsource: Quotable
Returns Promise<Converter>
Inherited from User._preprocess
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:30

`Protected`_sendMsg

_sendMsg(proto3: Encodable, brief: string, file?: boolean): Promise<MessageRet>
Parameters
- proto3: Encodable
- brief: string
- Optionalfile: boolean
Returns Promise<MessageRet>
Inherited from User._sendMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:84

addFriendBack

addFriendBack(seq: number, remark?: string): Promise<boolean>
回添双向好友
Parameters
- seq: number
  申请消息序号
- Optionalremark: string
  好友备注
Returns Promise<boolean>
Inherited from User.addFriendBack
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:90

asFriend

asFriend(strict?: boolean): icqq.Friend
返回作为好友的实例
Parameters
- Optionalstrict: boolean
Returns icqq.Friend
Inherited from User.asFriend
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:23

asMember

asMember(gid: number, strict?: boolean): icqq.Member
返回作为某群群员的实例
Parameters
- gid: number
- Optionalstrict: boolean
Returns icqq.Member
Inherited from User.asMember
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:25

delete

delete(block?: boolean): Promise<boolean>
删除好友
Parameters
- Optionalblock: boolean
  屏蔽此好友的申请，默认为true
Returns Promise<boolean>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:191

forwardFile

forwardFile(fid: string, group_id?: number): Promise<string>
转发离线文件
Parameters
- fid: string
  文件fid
- Optionalgroup_id: number
  群号，转发群文件时填写
Returns Promise<string>
转发成功后新文件的id
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:211

getAddFriendSetting

getAddFriendSetting(): Promise<number>
Returns Promise<number>
Inherited from User.getAddFriendSetting
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:32

getAvatarUrl

getAvatarUrl(size?: 0 | 40 | 100 | 140): string
获取头像url
Parameters
- Optionalsize: 0 | 40 | 100 | 140
  头像大小，默认0
Returns string
头像的url地址
Inherited from User.getAvatarUrl
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:31

getChatHistory

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

getFileInfo

getFileInfo(
fid: string,
): 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 node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:120

getFileUrl

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

getForwardMsg

getForwardMsg(
    resid: string,
    fileName?: string,
    nt?: boolean,
): Promise<ForwardMessage[]>
下载并解析合并转发
Parameters
- resid: string
- OptionalfileName: string
- Optionalnt: boolean
Returns Promise<ForwardMessage[]>
Inherited from User.getForwardMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:46

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 node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:39

getVideoUrl

getVideoUrl(fid: string, md5: string | Buffer<ArrayBufferLike>): Promise<string>
获取视频下载地址
Parameters
- fid: string
- md5: string | Buffer<ArrayBufferLike>
Returns Promise<string>
Inherited from User.getVideoUrl
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:50

makeForwardMsg

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

markRead

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

poke

poke(self?: boolean): Promise<boolean>
戳一戳
Parameters
- Optionalself: boolean
Returns Promise<boolean>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:186

recallFile

recallFile(fid: string): Promise<boolean>
撤回离线文件
Parameters
- fid: string
  文件id
Returns Promise<boolean>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:204

recallMsg

recallMsg(msg: PrivateMessage): Promise<boolean>
撤回消息
Parameters
- msg: PrivateMessage
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:11
recallMsg(msgid: string): Promise<boolean>
Parameters
- msgid: string
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:12
recallMsg(seq: number, rand: number, time: number): Promise<boolean>
Parameters
- seq: number
- rand: number
- time: number
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:13
recallMsg(param: number, rand: number, time: number): Promise<boolean>
撤回消息，cqhttp方法用
Parameters
- param: number
- rand: number
- time: number
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:66
recallMsg(message_id: string): Promise<boolean>
撤回消息
Parameters
- message_id: string
  消息id
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:71
recallMsg(message: PrivateMessage): Promise<boolean>
撤回消息
Parameters
- message: PrivateMessage
  私聊消息对象
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:76

searchSameGroup

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

Returns Promise<any>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:216

sendFile

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

sendMsg

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

setClass

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

setFriendReq

setFriendReq(
    seq: number,
    yes?: boolean,
    remark?: string,
    block?: boolean,
): Promise<boolean>
处理好友申请
Parameters
- seq: number
  申请消息序号
- Optionalyes: boolean
  是否同意
- Optionalremark: string
  好友备注
- Optionalblock: boolean
  是否屏蔽来自此用户的申请
Returns Promise<boolean>
Inherited from User.setFriendReq
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:98

setGroupInvite

setGroupInvite(
    gid: number,
    seq: number,
    yes?: boolean,
    block?: boolean,
): Promise<boolean>
处理群邀请
Parameters
- gid: number
  群号
- seq: number
  申请消息序号
- Optionalyes: boolean
  是否同意
- Optionalblock: boolean
  是否屏蔽来自此群的邀请
Returns Promise<boolean>
Inherited from User.setGroupInvite
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:115

setGroupReq

setGroupReq(
    gid: number,
    seq: number,
    yes?: boolean,
    reason?: string,
    block?: boolean,
): Promise<boolean>
处理入群申请
Parameters
- gid: number
  群号
- seq: number
  申请消息序号
- Optionalyes: boolean
  是否同意
- Optionalreason: string
  若拒绝，拒绝的原因
- Optionalblock: boolean
  是否屏蔽来自此用户的申请
Returns Promise<boolean>
Inherited from User.setGroupReq
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:107

setRemark

setRemark(remark: string): Promise<void>
设置备注
Parameters
- remark: string
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:182

shareMusic

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

shareUrl

shareUrl(content: ShareContent, config?: ShareConfig): Promise<void>
发送网址分享
Parameters
- content: ShareContent
- Optionalconfig: ShareConfig
Returns Promise<void>
Inherited from User.shareUrl
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:26

thumbUp

thumbUp(times?: number): Promise<boolean>
点赞，支持陌生人点赞
Parameters
- Optionaltimes: number
  点赞次数，默认1次
Returns Promise<boolean>
Inherited from User.thumbUp
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:37

uploadImages

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

uploadPtt

uploadPtt(
    elem: PttElem,
    transcoding?: boolean,
    brief?: string,
): Promise<PttElem>
上传一个语音以备发送(理论上传一次所有群和好友都能发)
Parameters
- elem: PttElem
- Optionaltranscoding: boolean
- Optionalbrief: string
Returns Promise<PttElem>
Inherited from User.uploadPtt
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/internal/contactable.d.ts:36

uploadVideo

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

`Static`as

as(this: icqq.Client, uid: number, strict?: boolean): icqq.Friend
Parameters
- this: icqq.Client
- uid: number
- Optionalstrict: boolean
Returns icqq.Friend
Overrides User.as
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/friend.d.ts:167

Class Friend

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns icqq.Friend

Properties

Protected Readonlyc

getInfo

Protected Optionalgid

Readonlyuid

user_id

Accessors

[unscopables]

Returns { c: boolean }

class_id

Returns number

class_name

Returns string

client

Returns icqq.Client

dm

Returns boolean

info

Returns FriendInfo

nickname

Returns string

remark

Returns string

sex

Returns Gender

target

Returns number

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 icqq.Friend

asMember

Parameters

Returns icqq.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

Returns Promise<ForwardMessage[]>

getSimpleInfo

`Protected`constructor

`Protected` `Readonly`c

`Protected` `Optional`gid

`Readonly`uid

`Protected`_preprocess

`Protected`_sendMsg

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