# ClientUser
The user logged in into the client
# Constructor
new ClientUser(client, data);
PARAMETER | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
client | Client | The client that instantiated this | No |
data | APIData | The user logged in API data | No |
# Properties
# badges
The badges for this user
# createdAt
The date the user was created
# createdTimestamp
The timestamp in seconds the user was created
# description
The user description (markdown style)
# displayName
The user display name
- Type: String
# gravatarHash
The Gravatar hash
- Type: String
# isBanned
Checks if the client user is banned from FakeYou
- Type: Boolean
# isMod
Checkis if the client user is a FakeYou moderator
- Type: Boolean
# links
The social links this belongs to
- Type: LinksData
# partial
Checks if has partial data
- Type: Boolean
# plan
The client user's FakeYou plan type
- Type: String
# token
The user token
- Type: UserToken
# ttsVisibility
The default TTS visibility of this user
# username
The username of the user
- Type: String
# w2lVisibility
The default W2L visibility of this user
# Methods
# edit(options)
Edit the client user info
PARAMETER | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
options | ClientEditOptions | The client user options to edit | No |
- Return: Promise <ClientUser>
# fetch()
Get all data about this user
- Return: Promise <ClientUser>
# gravatarURL()
Obtains the URL of gravatar image
- Return: String
# profileURL()
Obtains the URL of FakeYou profile
- Return: String
# ttsModels()
Get the models made by the client user
- Return: Promise <Group <ModelToken, Model>>
# ttsResults()
Get the TTS results generated by the client user
- Return: Promise <Group <ResultToken, TTSResult>>