Class ClientUser

Represents the logged in Roblox client user.

Hierarchy

User
- ClientUser

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientUser(client: Client, data: any): ClientUser

Overrides User.constructor
- Defined in src/structures/ClientUser.ts:18
Creates a new client.

internal
Parameters
- client: Client
  
  the client that instancied this class
- data: any
  
  the json response from API call
Returns ClientUser

Properties

avatar

avatar: Avatar

The user's avatar

remarks: Must be fetched with User.fetchAvatar.

Readonly client

client: Client

Readonly createdAt

createdAt: Date

description

description: string

displayName

displayName: string

Readonly id

id: number

isBanned

isBanned: boolean

isFriend

isFriend: boolean

Readonly name

name: string

Methods

addFriend

addFriend(): Promise<any>

Inherited from User.addFriend
- Defined in src/structures/User.ts:68
Adds the user as friend.

Returns Promise<any>

declineAll

declineAll(): Promise<void>

- Defined in src/structures/ClientUser.ts:45
Declines all friend requests.

Returns Promise<void>

getAvatar

getAvatar(): Promise<Avatar>

- Defined in src/structures/ClientUser.ts:119
Gets the avatar of the logged in user.

Returns Promise<Avatar>
the avatar of the logged in user

getFriendFromId

getFriendFromId(id: number): Promise<Friend>

- Defined in src/structures/ClientUser.ts:136
Get the friend object

Parameters
- id: number
Returns Promise<Friend>
A friend object.

getFriends

getFriends(): Promise<Friend[]>

Inherited from User.getFriends
- Defined in src/structures/User.ts:48
Gets all friends of the user.

Returns Promise<Friend[]>
List of users

getGroup

getGroup(id: number): Promise<Group>

- Defined in src/structures/ClientUser.ts:124
Parameters
- id: number
Returns Promise<Group>

getPresence

getPresence(): Promise<Presence>

Inherited from User.getPresence
- Defined in src/structures/User.ts:86
Gets the presence of the user.

Returns Promise<Presence>
Promise

search

search(keyword: string, limit?: number): Promise<MinimalUser[]>

- Defined in src/structures/ClientUser.ts:63
Searches users with a keyword.

remarks
Do not pass a second parameter.

beta
Parameters
- keyword: string
- limit: number = 10
  
  Default is 10 results
Returns Promise<MinimalUser[]>
a list of minimal users

send

send(message: string | Message, conversationId?: number): Promise<void>

- Defined in src/structures/ClientUser.ts:93
Sends a message to a specific conversation with an id.

remarks
This function is only useful if you have a specific conversation id.

Parameters
- message: string | Message
  
  the message you want to send a string or a Message
- conversationId: number = null
  
  the conversation id
Returns Promise<void>

setDescription

setDescription(description: string): Promise<void>

- Defined in src/structures/ClientUser.ts:27
Sets the description of the logged in user's client.

Parameters
- description: string
  
  the description you want to change to
Returns Promise<void>

Generated using TypeDoc