Class Member

Hierarchy

User
Hierarchy
- Member

Index

Constructors

constructor

new Member(c: Client, gid: number, uid: number): Member
Parameters
- c: Client
- gid: number
- uid: number
Returns Member
Overrides User.constructor
- Defined in src/group.ts:166

Properties

c

c: Client

group

group: Group

group_id

group_id: number

info

info: MemberInfo

maxListeners

maxListeners: number

`Readonly` uid

uid: number

user_id

user_id: number

Accessors

client

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

Methods

addListener

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

addOnceListener

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

after

after<E>(event: E, listener: MemberEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof MemberEventMap
Parameters
- event: E
- listener: MemberEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from User.after
- Defined in src/group.ts:235
after<S>(event: S & Exclude<S, keyof MemberEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof MemberEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from User.after
- Defined in src/group.ts:236
after<E>(event: E, listener: MemberEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof MemberEventMap
Parameters
- event: E
- listener: MemberEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from User.after
- Defined in src/group.ts:251
after<S>(event: S & Exclude<S, keyof MemberEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof MemberEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from User.after
- Defined in src/group.ts:252

asFriend

asFriend(): Friend
Returns Friend
Inherited from User.asFriend
- Defined in src/friend.ts:19

asMember

asMember(gid: number): Member
Parameters
- gid: number
Returns Member
Inherited from User.asMember
- Defined in src/friend.ts:22

bail

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

bailSync

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

before

before<E>(event: E, listener: MemberEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof MemberEventMap
Parameters
- event: E
- listener: MemberEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from User.before
- Defined in src/group.ts:233
before<S>(event: S & Exclude<S, keyof MemberEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof MemberEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from User.before
- Defined in src/group.ts:234
before<E>(event: E, listener: MemberEventMap[E], prepend?: boolean): Dispose
Type Parameters
Type Parameters
- E extends keyof MemberEventMap
Parameters
- event: E
- listener: MemberEventMap[E]
- Optional prepend: boolean
Returns Dispose
Inherited from User.before
- Defined in src/group.ts:249
before<S>(event: S & Exclude<S, keyof MemberEventMap>, listener: Listener, prepend?: boolean): Dispose
Type Parameters
Type Parameters
- S extends EventName
Parameters
- event: S & Exclude<S, keyof MemberEventMap>
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from User.before
- Defined in src/group.ts:250

em

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

emit

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

emitAsync

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

emitSync

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

eventNames

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

getMaxListeners

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

kick

kick(reject_add_request?: boolean): Promise<void>
Parameters
- Optional reject_add_request: boolean
Returns Promise<void>
- Defined in src/group.ts:182

listenerCount

listenerCount(event: EventName): number
Parameters
- event: EventName
Returns number
Inherited from User.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 User.listeners
- Defined in node_modules/event-deliver/lib/index.d.ts:8

mute

mute(duration?: number): Promise<void>
Parameters
- Optional duration: number
Returns Promise<void>
- Defined in src/group.ts:185

off

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

on

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

once

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

prependListener

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

prependOnceListener

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

removeListener

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

setAdmin

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

setCard

setCard(card: string): Promise<void>
Parameters
- card: string
Returns Promise<void>
- Defined in src/group.ts:191

setMaxListeners

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

setTitle

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

`Static` as

as(this: Client, gid: number, uid: number): Member
Parameters
- this: Client
- gid: number
- uid: number
Returns Member
Overrides User.as
- Defined in src/group.ts:174

Class Member

Hierarchy

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

c: Client

gid: number

uid: number

Returns Member

Properties

c

group

group_id

info

maxListeners

Readonly uid

user_id

Accessors

client

Returns Client

Methods

addListener

Type Parameters

Type Parameters

E extends keyof MemberEventMap

Parameters

event: E

listener: MemberEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof MemberEventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

addOnceListener

Type Parameters

Type Parameters

E extends keyof MemberEventMap

Parameters

event: E

listener: MemberEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof MemberEventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

after

Type Parameters

Type Parameters

E extends keyof MemberEventMap

Parameters

event: E

listener: MemberEventMap[E]

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

S extends EventName

Parameters

event: S & Exclude<S, keyof MemberEventMap>

listener: Listener

Optional prepend: boolean

Returns Dispose

Type Parameters

Type Parameters

`Readonly` uid

`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: MemberEventMap[E] extends ((...args: P) => any) ? P : never[]

`Rest` ...args: any[]

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

`Rest` ...args: any[]

`Optional` prepend: boolean

`Optional` prepend: boolean