Class Friend

好友(继承User)

Hierarchy

User
- Friend

Constructors

`Protected` constructor

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

Properties

`Private` `Optional` _info

_info?: FriendInfo

`Protected` `Readonly` c

c: Client

`Protected` `Optional` gid

gid?: number

对方群号

`Readonly` uid

uid: number

Accessors

class_id

get class_id(): undefined | number
好友分组 id

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

class_name

get class_name(): undefined | string
好友分组

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

client

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

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

`Private` dm

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

info

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

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

nickname

get nickname(): undefined | string
好友昵称

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

remark

get remark(): undefined | string
好友备注

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

sex

get sex(): undefined | Gender
好友性别

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

`Private` target

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

user_id

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

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

Methods

`Protected` _preprocess

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

`Protected` _sendMsg

_sendMsg(proto3: Encodable, brief: string, file?: boolean): Promise<{
    message_id: string;
    rand: number;
    seq: number;
    time: any;
}>
Parameters
- proto3: Encodable
- brief: string
- file: boolean = false
Returns Promise<{
    message_id: string;
    rand: number;
    seq: number;
    time: any;
}>
Inherited from User._sendMsg
- Defined in src/friend.ts:189

addFriendBack

addFriendBack(seq: number, remark?: string): Promise<boolean>
回添双向好友
Parameters
- seq: number
- remark: string = ''
Returns Promise<boolean>
Inherited from User.addFriendBack
- Defined in src/friend.ts:214

asFriend

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

asMember

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

delete

delete(block?: boolean): Promise<boolean>
删除好友，block默认为true
Parameters
- block: boolean = true
Returns Promise<boolean>
- Defined in src/friend.ts:430

forwardFile

forwardFile(fid: string): Promise<string>
转发离线文件
Parameters
- fid: string
Returns Promise<string>
- Defined in src/friend.ts:588

getAddFriendSetting

getAddFriendSetting(): Promise<number>
获取加好友设置

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

getAvatarUrl

getAvatarUrl(size?: 0 | 100 | 140 | 40): string
获取头像 url
Parameters
- size: 0 | 100 | 140 | 40 = 0
Returns string
Inherited from User.getAvatarUrl
- Defined in src/friend.ts:55

getChatHistory

getChatHistory(time?: number, cnt?: number): Promise<PrivateMessage[]>
获取 time 往前的 cnt 条聊天记录，默认当前时间，cnt 默认 20 不能超过 20
Parameters
- time: number = ...
- cnt: number = 20
Returns Promise<PrivateMessage[]>
Inherited from User.getChatHistory
- Defined in src/friend.ts:105

getFileInfo

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

getFileUrl

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

getForwardMsg

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

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:84

getVideoUrl

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

makeForwardMsg

makeForwardMsg(msglist: Forwardable | Forwardable[], title?: string, desc?: string): Promise<XmlElem>
1. 制作一条合并转发消息以备发送 (制作一次可以到处发)。
2. 需要注意的是，好友图片和群图片的内部格式不一样，对着群制作的转发消息中的图片，发给好友可能会裂图，反过来也一样。
3. 暂不完全支持套娃转发。
Parameters
- msglist: Forwardable | Forwardable[]
- title: string = '转发的聊天记录'
- desc: string = ''
Returns Promise<XmlElem>
Inherited from User.makeForwardMsg
- Defined in src/internal/contactable.ts:469

markRead

markRead(time?: number): Promise<void>
标记 time 之前为已读，默认当前时间
Parameters
- time: number = ...
Returns Promise<void>
Inherited from User.markRead
- Defined in src/friend.ts:127

poke

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

recallFile

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

recallMsg

recallMsg(msg: PrivateMessage): Promise<boolean>
撤回消息
Parameters
- msg: PrivateMessage
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:24
recallMsg(msgid: string): Promise<boolean>
撤回消息
Parameters
- msgid: string
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:25
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 src/friend.ts:26
recallMsg(param: string | number | PrivateMessage, rand?: number, time?: number): Promise<boolean>
撤回消息
Parameters
- param: string | number | PrivateMessage
- rand: number = 0
- time: number = 0
Returns Promise<boolean>
Inherited from User.recallMsg
- Defined in src/friend.ts:140

sendFile

sendFile(file: string | Buffer | Uint8Array, filename?: string, callback?: ((percentage: string) => void)): Promise<string>
发送离线文件

Returns
文件id(撤回时使用)
Parameters
- file: string | Buffer | Uint8Array
  
  一个文件路径，或者一块Buffer
- Optional filename: string
  
  对方看到的文件名(file为Buffer时，若留空则自动以md5命名)
- Optional callback: ((percentage: string) => void)
  
  监控上传进度的回调函数，拥有一个"百分比进度"的参数
  - - (percentage: string): void
    - Parameters
      
      percentage: string
      
      Returns void
Returns Promise<string>
- Defined in src/friend.ts:449

sendMsg

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

setClass

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

setFriendReq

setFriendReq(seq: number, yes?: boolean, remark?: string, block?: boolean): 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:233

setGroupInvite

setGroupInvite(gid: number, seq: number, yes?: boolean, block?: boolean): 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:273

setGroupReq

setGroupReq(gid: number, seq: number, yes?: boolean, reason?: string, block?: boolean): 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:252

setRemark

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

shareMusic

shareMusic(platform: MusicPlatform, id: string): Promise<void>
发送音乐分享
Parameters
- platform: MusicPlatform
- id: string
Returns Promise<void>
- Defined in src/friend.ts:381

shareUrl

shareUrl(content: ShareContent, config: ShareConfig): Promise<void>
发送网址分享
Parameters
- content: ShareContent
- config: ShareConfig
Returns Promise<void>
- Defined in src/friend.ts:387

thumbUp

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

uploadImages

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

uploadPtt

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

uploadVideo

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

`Static` as

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

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

class_id

Returns undefined | number

class_name

Returns undefined | string

client

Returns Client

Private dm

Returns boolean

info

Returns undefined | FriendInfo

nickname

Returns undefined | string

remark

Returns undefined | string

sex

Returns undefined | Gender

Private 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<{ message_id: string; rand: number; seq: number; time: any; }>

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

Parameters

size: 0 | 100 | 140 | 40 = 0

Returns string

`Protected` constructor

`Optional` _info: FriendInfo

`Private` `Optional` _info

`Protected` `Readonly` c

`Protected` `Optional` gid

`Readonly` uid

`Private` dm

`Private` target

`Protected` _preprocess

`Optional` source: Quotable

`Protected` _sendMsg

Returns Promise<{
message_id: string;
rand: number;
seq: number;
time: any;
}>

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

`Optional` md5: string | Buffer

`Optional` filename: string

`Optional` callback: ((percentage: string) => void)