Class User

Hierarchy

Contactable
Hierarchy
- User
  Hierarchy
  - Member

Index

Constructors

Properties

c group_id? maxListeners uid user_id?

Accessors

Constructors

constructor

new User(c: Client, uid: number): User
Parameters
- c: Client
- uid: number
Returns User
Overrides Contactable.constructor
- Defined in src/friend.ts:13

Properties

c

`Protected` `Optional` group_id

group_id?: number

maxListeners

maxListeners: number

`Readonly` uid

uid: number

`Protected` `Optional` user_id

user_id?: number

Accessors

client

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

Methods

addListener

addListener(event: EventName, listener: Listener, prepend?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addListener
- Defined in node_modules/event-deliver/lib/index.d.ts:10

addOnceListener

addOnceListener(event: EventName, listener: Listener, prepend?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.addOnceListener
- Defined in node_modules/event-deliver/lib/index.d.ts:12

after

after(event: string, listener: Listener): Dispose
Parameters
- event: string
- listener: Listener
Returns Dispose
Inherited from Contactable.after
- Defined in node_modules/event-deliver/lib/index.d.ts:20

asFriend

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

asMember

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

bail

bail(event: EventName, ...args: any[]): any
Parameters
- event: EventName
- Rest ...args: any[]
Returns any
Inherited from Contactable.bail
- Defined in node_modules/event-deliver/lib/index.d.ts:22

bailSync

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

before

before(event: string, listener: Listener): Dispose
Parameters
- event: string
- listener: Listener
Returns Dispose
Inherited from Contactable.before
- Defined in node_modules/event-deliver/lib/index.d.ts:19

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(event: EventName, ...args: any[]): void
Parameters
- event: EventName
- Rest ...args: any[]
Returns void
Inherited from Contactable.emit
- Defined in node_modules/event-deliver/lib/index.d.ts:18

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

eventNames

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

getMaxListeners

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

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

off

off(event?: EventName, listener?: Listener): boolean
Parameters
- Optional event: EventName
- Optional listener: Listener
Returns boolean
Inherited from Contactable.off
- Defined in node_modules/event-deliver/lib/index.d.ts:16

on

on(event: EventName, listener: Listener, prepend?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.on
- Defined in node_modules/event-deliver/lib/index.d.ts:9

once

once(event: EventName, listener: Listener, prepend?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional prepend: boolean
Returns Dispose
Inherited from Contactable.once
- Defined in node_modules/event-deliver/lib/index.d.ts:13

prependListener

prependListener(event: EventName, listener: Listener, append?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependListener
- Defined in node_modules/event-deliver/lib/index.d.ts:11

prependOnceListener

prependOnceListener(event: EventName, listener: Listener, append?: boolean): Dispose
Parameters
- event: EventName
- listener: Listener
- Optional append: boolean
Returns Dispose
Inherited from Contactable.prependOnceListener
- Defined in node_modules/event-deliver/lib/index.d.ts:14

removeListener

removeListener(event?: EventName, listener?: Listener): boolean
Parameters
- Optional event: EventName
- Optional listener: Listener
Returns boolean
Inherited from Contactable.removeListener
- Defined in node_modules/event-deliver/lib/index.d.ts:15

setMaxListeners

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

`Static` as

as(this: Client, uid: number): User
Parameters
- this: Client
- uid: number
Returns User
- Defined in src/friend.ts:16

Generated using TypeDoc