Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

The user class.

param

The client.

param

The user.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new User(client: Client, user: User | RoomUser): User

Properties

avatarUrl

avatarUrl: null | string

The avatar url of the user.

bannerUrl

bannerUrl: null | string

The banner url of the user.

bio

bio: null | string

The bio of the user.

client

client: Client

The client that instantiated the user.

Optional currentRoom

currentRoom: Room

The current room of the user.

currentRoomId

currentRoomId: null | string

The current room id of the user.

displayName

displayName: string

The display name of the user.

followers

followers: number

The number of followers of the user.

following

following: null | boolean

If the user follows you.

followingCount

followingCount: number

The number of people that the user follows.

followsYou

followsYou: null | boolean

Whether the user follows you.

id

id: string

The id of the user.

lastOnline

lastOnline: string

When the user was last online.

online

online: boolean

If the user is online.

Optional roomPermissions

roomPermissions: unknown

The room permissions of the user.

username

username: string

The username of the user.

Methods

follow

  • follow(value: boolean): Promise<void>

  • Follows the user.

    Parameters

    • value: boolean

      If you want to follow the user.

    Returns Promise<void>

Generated using TypeDoc