Class Group

Hierarchy

Contactable
Hierarchy
- Group

Index

Constructors

constructor

new Group(c: Client, group_id: number): Group
Parameters
- c: Client
- group_id: number
Returns Group
Overrides Contactable.constructor
- Defined in src/group.ts:45

Properties

c

c: Client

gfs

gfs: GFS

`Readonly` group_id

group_id: number

maxListeners

maxListeners: number

members

members: Map<number, Member> = ...

`Protected` `Optional` user_id

user_id?: number

Accessors

client

get client(): Client
Returns Client
Inherited from Contactable.client
- Defined in src/contactable.ts:10

info

get info(): GroupInfo
Returns GroupInfo
- Defined in src/group.ts:56
set info(info: GroupInfo): void
Parameters
- info: GroupInfo
Returns void
- Defined in src/group.ts:59

Methods

addListener

addListener<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addListener
- Defined in src/group.ts:205
addListener<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addListener
- Defined in src/group.ts:206

addOnceListener

addOnceListener<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addOnceListener
- Defined in src/group.ts:211
addOnceListener<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addOnceListener
- Defined in src/group.ts:212

after

after<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.after
- Defined in src/group.ts:201
after<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.after
- Defined in src/group.ts:202
after<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.after
- Defined in src/group.ts:217
after<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.after
- Defined in src/group.ts:218

bail

bail<E>(event: E, ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]): Promise<any>
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- Rest ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]
Returns Promise<any>
Inherited from Contactable.bail
- Defined in src/group.ts:227
bail<S>(event: S & Exclude<S, keyof GroupEventMap>, ...args: any[]): Promise<any>
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- Rest ...args: any[]
Returns Promise<any>
Inherited from Contactable.bail
- Defined in src/group.ts:228

bailSync

bailSync<E>(event: E, ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]): Promise<any>
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- Rest ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]
Returns Promise<any>
Inherited from Contactable.bailSync
- Defined in src/group.ts:229
bailSync<S>(event: S & Exclude<S, keyof GroupEventMap>, ...args: any[]): Promise<any>
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- Rest ...args: any[]
Returns Promise<any>
Inherited from Contactable.bailSync
- Defined in src/group.ts:230

before

before<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.before
- Defined in src/group.ts:199
before<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.before
- Defined in src/group.ts:200
before<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.before
- Defined in src/group.ts:215
before<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.before
- Defined in src/group.ts:216

em

em(name: string, data: any): void
Parameters
- name: string
- data: any
Returns void
Inherited from Contactable.em
- Defined in src/contactable.ts:13

emit

emit<E>(event: E, ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]): void
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- Rest ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]
Returns void
Inherited from Contactable.emit
- Defined in src/group.ts:223
emit<S>(event: S & Exclude<S, keyof GroupEventMap>, ...args: any[]): void
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- Rest ...args: any[]
Returns void
Inherited from Contactable.emit
- Defined in src/group.ts:224

emitAsync

emitAsync(event: EventName, ...args: any[]): Promise<void>
Parameters
- event: EventName
- Rest ...args: any[]
Returns Promise<void>
Inherited from Contactable.emitAsync
- Defined in node_modules/event-deliver/lib/index.d.ts:17

emitSync

emitSync<E>(event: E, ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]): void
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- Rest ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]
Returns void
- Defined in src/group.ts:225
emitSync<S>(event: S & Exclude<S, keyof GroupEventMap>, ...args: any[]): void
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- Rest ...args: any[]
Returns void
- Defined in src/group.ts:226

eventNames

eventNames(): EventName[]
Returns EventName[]
Inherited from Contactable.eventNames
- Defined in node_modules/event-deliver/lib/index.d.ts:24

getHonorInfo

getHonorInfo(type: "all" | "legend" | "talkative" | "performer" | "strong_newbie" | "emotion"): Promise<GroupHonorInfo>
Parameters
- type: "all" | "legend" | "talkative" | "performer" | "strong_newbie" | "emotion"
Returns Promise<GroupHonorInfo>
- Defined in src/group.ts:69

getInfo

getInfo(cache?: boolean): Promise<GroupInfo>
Parameters
- Optional cache: boolean
Returns Promise<GroupInfo>
- Defined in src/group.ts:62

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from Contactable.getMaxListeners
- Defined in node_modules/event-deliver/lib/index.d.ts:7

kickMember

kickMember(member_id: number, reject_add_request?: boolean): Promise<void>
Parameters
- member_id: number
- Optional reject_add_request: boolean
Returns Promise<void>
- Defined in src/group.ts:76

listenerCount

listenerCount(event: EventName): number
Parameters
- event: EventName
Returns number
Inherited from Contactable.listenerCount
- Defined in node_modules/event-deliver/lib/index.d.ts:23

listeners

listeners(event?: EventName): Listener[]
Parameters
- Optional event: EventName
Returns Listener[]
Inherited from Contactable.listeners
- Defined in node_modules/event-deliver/lib/index.d.ts:8

muteAll

muteAll(enable?: boolean): Promise<void>
Parameters
- Optional enable: boolean
Returns Promise<void>
- Defined in src/group.ts:85

muteAnonymous

muteAnonymous(flag: string, duration?: number): Promise<void>
Parameters
- flag: string
- Optional duration: number
Returns Promise<void>
- Defined in src/group.ts:82

muteMember

muteMember(member_id: number, duration?: number): Promise<void>
Parameters
- member_id: number
- Optional duration: number
Returns Promise<void>
- Defined in src/group.ts:79

off

off<E>(event?: E, listener?: GroupEventMap[E]): boolean
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- Optional event: E
- Optional listener: GroupEventMap[E]
Returns boolean
Inherited from Contactable.off
- Defined in src/group.ts:219
off<S>(event?: S & Exclude<S, keyof GroupEventMap>, listener?: Listener): boolean
Type Parameters
Type Parameters
- S extends EventName
Parameters
- Optional event: S & Exclude<S, keyof GroupEventMap>
- Optional listener: Listener
Returns boolean
Inherited from Contactable.off
- Defined in src/group.ts:220

on

on<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.on
- Defined in src/group.ts:203
on<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.on
- Defined in src/group.ts:204

once

once<E>(event: E, listener: GroupEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.once
- Defined in src/group.ts:209
once<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.once
- Defined in src/group.ts:210

pickMember

pickMember(uid: number): Member
获取一枚群员实例
Parameters
- uid: number
Returns Member
- Defined in src/group.ts:73

prependListener

prependListener<E>(event: E, listener: GroupEventMap[E], append?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependListener
- Defined in src/group.ts:207
prependListener<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, append?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependListener
- Defined in src/group.ts:208

prependOnceListener

prependOnceListener<E>(event: E, listener: GroupEventMap[E], append?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- event: E
- listener: GroupEventMap[E]
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependOnceListener
- Defined in src/group.ts:213
prependOnceListener<S>(event: S & Exclude<S, keyof GroupEventMap>, listener: Listener, append?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof GroupEventMap>
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependOnceListener
- Defined in src/group.ts:214

quit

quit(is_dismiss?: boolean): Promise<void>
Parameters
- Optional is_dismiss: boolean
Returns Promise<void>
- Defined in src/group.ts:100

removeListener

removeListener<E>(event?: E, listener?: GroupEventMap[E]): boolean
Type Parameters
Type Parameters
- E extends keyof GroupEventMap
Parameters
- Optional event: E
- Optional listener: GroupEventMap[E]
Returns boolean
Inherited from Contactable.removeListener
- Defined in src/group.ts:221
removeListener<S>(event?: S & Exclude<S, keyof GroupEventMap>, listener?: Listener): boolean
Type Parameters
Type Parameters
- S extends EventName
Parameters
- Optional event: S & Exclude<S, keyof GroupEventMap>
- Optional listener: Listener
Returns boolean
Inherited from Contactable.removeListener
- Defined in src/group.ts:222

sendMsg

sendMsg(message: Sendable, quote?: Quotable): Promise<MessageRet>
Parameters
- message: Sendable
- Optional quote: Quotable
Returns Promise<MessageRet>
- Defined in src/group.ts:114

setAdmin

setAdmin(member_id: number, enable?: boolean): Promise<void>
Parameters
- member_id: number
- Optional enable: boolean
Returns Promise<void>
- Defined in src/group.ts:88

setAnonymous

setAnonymous(enable?: boolean): Promise<void>
Parameters
- Optional enable: boolean
Returns Promise<void>
- Defined in src/group.ts:91

setAvatar

setAvatar(file: string): Promise<GroupHonorInfo>
Parameters
- file: string
Returns Promise<GroupHonorInfo>
- Defined in src/group.ts:66

setMaxListeners

setMaxListeners(n: number): Group
Parameters
- n: number
Returns Group
Inherited from Contactable.setMaxListeners
- Defined in node_modules/event-deliver/lib/index.d.ts:5

setMemberCard

setMemberCard(member_id: number, card: string): Promise<void>
Parameters
- member_id: number
- card: string
Returns Promise<void>
- Defined in src/group.ts:94

setMemberTitle

setMemberTitle(member_id: number, title: string, duration?: number): Promise<void>
Parameters
- member_id: number
- title: string
- Optional duration: number
Returns Promise<void>
- Defined in src/group.ts:103

setName

setName(group_name: string): Promise<void>
Parameters
- group_name: string
Returns Promise<void>
- Defined in src/group.ts:97

sign

sign(): Promise<void>
Returns Promise<void>
- Defined in src/group.ts:111

`Static` as

as(this: Client, group_id: number): Group
Parameters
- this: Client
- group_id: number
Returns Group
- Defined in src/group.ts:117

Class Group

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

c: Client

group_id: number

Returns Group

Properties

c

gfs

Readonly group_id

maxListeners

members

Protected Optional user_id

Accessors

client

Returns Client

info

Returns GroupInfo

Parameters

info: GroupInfo

Returns void

Methods

addListener

Type Parameters

Type Parameters

E extends keyof GroupEventMap

Parameters

event: E

listener: GroupEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof GroupEventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

addOnceListener

Type Parameters

Type Parameters

E extends keyof GroupEventMap

Parameters

event: E

listener: GroupEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof GroupEventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

after

Type Parameters

Type Parameters

E extends keyof GroupEventMap

Parameters

event: E

listener: GroupEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof GroupEventMap>

listener: Listener

Optional prepend: boolean

`Readonly` group_id

`Protected` `Optional` user_id

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Optional` prepend: boolean

`Rest` ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]

`Rest` ...args: any[]

`Rest` ...args: GroupEventMap[E] extends ((...args: P) => any) ? P : never[]

`Rest` ...args: any[]

`Optional` prepend: boolean

`Optional` prepend: boolean