Class Group

群

Hierarchy

Discuss
- Group

Constructors

`Protected` constructor

new Group(c: Client, gid: number, _info?: GroupInfo): Group
Parameters
- c: Client
- gid: number
- Optional _info: GroupInfo
Returns Group
Inherited from Discuss.constructor
- Defined in src/group.ts:137

Properties

`Private` `Optional` _info

_info?: GroupInfo

`Protected` `Readonly` c

c: Client

`Readonly` fs

fs: Gfs

群文件系统

`Readonly` gid

gid: number

`Protected` `Optional` uid

uid?: number

对方QQ号

Accessors

all_muted

get all_muted(): boolean
是否全员禁言

Returns boolean
- Defined in src/group.ts:124

client

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

Returns Client
- Defined in src/internal/contactable.ts:60

`Private` dm

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

group_id

get group_id(): number
this.gid的别名

Returns number
- Defined in src/group.ts:45

info

get info(): undefined | GroupInfo
群资料

Returns undefined | GroupInfo
- Defined in src/group.ts:103

is_admin

get is_admin(): boolean
是否是该群管理员

Returns boolean
- Defined in src/group.ts:119

is_owner

get is_owner(): boolean
是否是该群群主

Returns boolean
- Defined in src/group.ts:114

mute_left

get mute_left(): number
当前账号禁言剩余时间，没有被禁言时为 0

Returns number
- Defined in src/group.ts:129

name

get name(): undefined | string
群名称

Returns undefined | string
- Defined in src/group.ts:109

`Private` target

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

Methods

`Private` _fetchMembers

_fetchMembers(): Promise<Map<number, MemberInfo>>
Returns Promise<Map<number, MemberInfo>>
- Defined in src/group.ts:195

`Private` _getLastSeq

_getLastSeq(): Promise<any>
Returns Promise<any>
- Defined in src/group.ts:522

`Protected` _preprocess

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

`Private` _sendMsgByFrag

_sendMsgByFrag(converter: Converter): Promise<string>
Parameters
- converter: Converter
Returns Promise<string>
- Defined in src/group.ts:336

`Private` _setting

_setting(obj: {
[tag: number]: any;
}): Promise<boolean>
Parameters
- obj: {
  [tag: number]: any;
  }
  - [tag: number]: any
Returns Promise<boolean>
- Defined in src/group.ts:441

allowAnony

allowAnony(yes?: boolean): Promise<boolean>
允许/禁止匿名
Parameters
- yes: boolean = true
Returns Promise<boolean>
- Defined in src/group.ts:451

announce

announce(content: string): Promise<boolean>
发送简易群公告
Parameters
- content: string
Returns Promise<boolean>
- Defined in src/group.ts:437

getAnonyInfo

getAnonyInfo(): Promise<Omit<Anonymous, "flag">>
获取自己的匿名情报

Returns Promise<Omit<Anonymous, "flag">>
- Defined in src/group.ts:489

getAtAllRemainder

getAtAllRemainder(): Promise<number>
获取 @全体成员的剩余次数

Returns Promise<number>
- Defined in src/group.ts:510

getAvatarUrl

getAvatarUrl(size?: 0 | 100 | 140 | 40, history?: number): string
获取群头像url (history=1,2,3...)
Parameters
- size: 0 | 100 | 140 | 40 = 0
- history: number = 0
Returns string
- Defined in src/group.ts:150

getChatHistory

getChatHistory(seq?: number, cnt?: number): Promise<GroupMessage[]>
获取seq之前的cnt条聊天记录，默认从最后一条发言往前，cnt默认20不能超过20
Parameters
- seq: number = 0
- cnt: number = 20
Returns Promise<GroupMessage[]>
- Defined in src/group.ts:548

getFileUrl

getFileUrl(fid: string): Promise<string>
获取群文件下载地址
Parameters
- fid: string
Returns Promise<string>
- Defined in src/group.ts:572

getForwardMsg

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

getMemberMap

getMemberMap(no_cache?: boolean): Promise<Map<number, MemberInfo>>
获取群员列表
Parameters
- no_cache: boolean = false
Returns Promise<Map<number, MemberInfo>>
- Defined in src/group.ts:244

getVideoUrl

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

invite

invite(uid: number): Promise<boolean>
邀请好友入群
Parameters
- uid: number
Returns Promise<boolean>
- Defined in src/group.ts:588

kickMember

kickMember(uid: number, block?: boolean, message?: string): Promise<boolean>
移出群成员
Parameters
- uid: number
- block: boolean = false
- Optional message: string
Returns Promise<boolean>
- Defined in src/group.ts:644

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 Discuss.makeForwardMsg
- Defined in src/internal/contactable.ts:469

markRead

markRead(seq?: number): Promise<void>
标记seq之前为已读，默认到最后一条发言
Parameters
- seq: number = 0
Returns Promise<void>
- Defined in src/group.ts:537

muteAll

muteAll(yes?: boolean): Promise<boolean>
全员禁言
Parameters
- yes: boolean = true
Returns Promise<boolean>
- Defined in src/group.ts:432

muteAnony

muteAnony(flag: string, duration?: number): Promise<void>
禁言匿名玩家，默认1800秒
Parameters
- flag: string
- duration: number = 1800
Returns Promise<void>
- Defined in src/group.ts:472

muteMember

muteMember(uid: number, duration?: number): Promise<void>
禁言群成员
Parameters
- uid: number
- duration: number = 600
Returns Promise<void>
- Defined in src/group.ts:649

pickMember

pickMember(uid: number, strict?: boolean): Member
获取一枚群员实例
Parameters
- uid: number
- strict: boolean = false
Returns Member
- Defined in src/group.ts:145

pokeMember

pokeMember(uid: number): Promise<boolean>
私聊发送戳一戳给群成员
Parameters
- uid: number
Returns Promise<boolean>
- Defined in src/group.ts:654

quit

quit(): Promise<boolean>
退群/解散

Returns Promise<boolean>
- Defined in src/group.ts:614

recallMsg

recallMsg(msg: GroupMessage): Promise<boolean>
撤回消息
Parameters
- msg: GroupMessage
Returns Promise<boolean>
- Defined in src/group.ts:85
recallMsg(msgid: string): Promise<boolean>
撤回一条群消息
Parameters
- msgid: string
Returns Promise<boolean>
- Defined in src/group.ts:86
recallMsg(seq: number, rand: number, pktnum?: number): Promise<boolean>
撤回一条群消息
Parameters
- seq: number
- rand: number
- Optional pktnum: number
Returns Promise<boolean>
- Defined in src/group.ts:87
recallMsg(param: string | number | GroupMessage, rand?: number, pktnum?: number): Promise<boolean>
撤回一条群消息
Parameters
- param: string | number | GroupMessage
- rand: number = 0
- pktnum: number = 1
Returns Promise<boolean>
- Defined in src/group.ts:377

renew

renew(): Promise<GroupInfo>
强制刷新资料

Returns Promise<GroupInfo>
- Defined in src/group.ts:155

sendMsg

sendMsg(content: Sendable, source?: Quotable, anony?: boolean | Omit<Anonymous, "flag">): Promise<MessageRet>
发送一条消息
Parameters
- content: Sendable
- Optional source: Quotable
  
  引用回复的消息
- anony: boolean | Omit<Anonymous, "flag"> = false
  
  匿名
Returns Promise<MessageRet>
Inherited from Discuss.sendMsg
- Defined in src/group.ts:276

setAdmin

setAdmin(uid: number, yes?: boolean): Promise<boolean>
设置管理员
Parameters
- uid: number
- yes: boolean = true
Returns Promise<boolean>
- Defined in src/group.ts:629

setAvatar

setAvatar(file: string | Buffer | Readable): Promise<void>
设置群头像
Parameters
- file: string | Buffer | Readable
Returns Promise<void>
- Defined in src/group.ts:577

setCard

setCard(uid: number, card?: string): Promise<boolean>
设置群名片
Parameters
- uid: number
- card: string = ''
Returns Promise<boolean>
- Defined in src/group.ts:639

setName

setName(name: string): Promise<boolean>
设置群名
Parameters
- name: string
Returns Promise<boolean>
- Defined in src/group.ts:427

setRemark

setRemark(remark?: string): Promise<void>
设置备注
Parameters
- remark: string = ''
Returns Promise<void>
- Defined in src/group.ts:460

setTitle

setTitle(uid: number, title?: string, duration?: number): Promise<boolean>
设置专属头衔
Parameters
- uid: number
- title: string = ''
- duration: number = -1
Returns Promise<boolean>
- Defined in src/group.ts:634

shareMusic

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

shareUrl

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

sign

sign(): Promise<boolean>
群打卡

Returns Promise<boolean>
- Defined in src/group.ts:600

uploadImages

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

uploadPtt

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

uploadVideo

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

`Static` as

as(this: Client, gid: number, strict?: boolean): Group
Parameters
- this: Client
- gid: number
- strict: boolean = false
Returns Group
Inherited from Discuss.as
- Defined in src/group.ts:92

Class Group

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

c: Client

gid: number

Optional _info: GroupInfo

Returns Group

Properties

Private Optional _info

Protected Readonly c

Readonly fs

Readonly gid

Protected Optional uid

Accessors

all_muted

Returns boolean

client

Returns Client

Private dm

Returns boolean

group_id

Returns number

info

Returns undefined | GroupInfo

is_admin

Returns boolean

is_owner

Returns boolean

mute_left

Returns number

name

Returns undefined | string

Private target

Returns number

Methods

Private _fetchMembers

Returns Promise<Map<number, MemberInfo>>

Private _getLastSeq

Returns Promise<any>

Protected _preprocess

Parameters

content: Sendable

Optional source: Quotable

Returns Promise<Converter>

Private _sendMsgByFrag

Parameters

converter: Converter

Returns Promise<string>

Private _setting

Parameters

obj: { [tag: number]: any; }

[tag: number]: any

Returns Promise<boolean>

allowAnony

Parameters

yes: boolean = true

Returns Promise<boolean>

announce

Parameters

content: string

Returns Promise<boolean>

getAnonyInfo

Returns Promise<Omit<Anonymous, "flag">>

getAtAllRemainder

Returns Promise<number>

getAvatarUrl

Parameters

size: 0 | 100 | 140 | 40 = 0

history: number = 0

Returns string

getChatHistory

Parameters

seq: number = 0

`Protected` constructor

`Optional` _info: GroupInfo

`Private` `Optional` _info

`Protected` `Readonly` c

`Readonly` fs

`Readonly` gid

`Protected` `Optional` uid

`Private` dm

`Private` target

`Private` _fetchMembers

`Private` _getLastSeq

`Protected` _preprocess

`Optional` source: Quotable

`Private` _sendMsgByFrag

`Private` _setting

obj: {
[tag: number]: any;
}

`Optional` md5: string | Buffer

`Optional` message: string