ClientUser - antilandjs/antiland.js GitHub Wiki

The client account which has been authenticated.

extends User

Properties

.accentColor : number

The accent colour of the client user.

.blockedBy : Set<string>

A list of users that have blocked the client user.

.channelId : string

The ID of the private channel for the client user.

.contacts : ContactManager<id, User>

Search for, cache, and perform actions on contacts.

.favorites : FavoriteManager<id, User>

Search for, cache, and perform actions on favourites.

.friends : ClientFriendManager<id, User>

Search for, cache, and perform actions on friends.

.hexAccentColor : string

Client user accent colour hex value.

.messages : MessageManager<id, Message>

Search for, cache, and perform actions on direct messages.

.referrerId : string • readonly

Referrer ID if applicable.

.stickers : ClientStickerManager<id, object>

Search for, cache, and perform actions on purchased/owned sticker packs.

.tasks : TaskManager<id, object>

Search for, cache, and perform actions on direct messages.

Methods

.fetchContentSettings(options?) : Promise<object>

Account based content preferences.

Name	Type	Optional
options	object	Yes

.fetchSecuritySettings(options?) : Promise<object>

Account based security settings.

Name	Type	Optional
options	object	Yes

.fetchVisitors(options?) : Promise<object>

Fetch recent profile visitors. (costs 25K)

Name	Type	Optional
options	object	Yes

.generateToken() : Promise<unknown>

Unsure what this does.

.getHumanLink(options?) : Promise<object>

Get the client user vanity URL.

Name	Type	Optional
options	object	Yes

.purchaseSuperPowers() : Promise<boolean>

Purchase a one month super power trial. (costs 10000K)

.setAccessories(accessories) : Promise<boolean>

Set avatar accessories.

Name	Type	Optional
accessories	Array \| Set	No

.setAvatar(avatarId) : Promise<this>

Set avatar.

Name	Type	Optional
avatarId	string	No

.setGenderAndAge(options?) : Promise<this>

Set sex and age. (age can only be modified once per month)

Name	Type	Optional
options	object	Yes

.setInterestAndLanguage(options?) : Promise<this>

Set interest(s) and language.

Name	Type	Optional
options	object	Yes

.setMood(moodId) : Promise<this>

Set interest(s) and language.

Name	Type	Optional
moodId	string	No

.setPassword(password) : Promise<this>

Set user password.

Name	Type	Optional
password	string	No

.setSecuritySettings(options?) : Promise<this>

Set security settings.

Name	Type	Optional
options	object	Yes

.setSuperPowers(options?) : Promise<this>

Configurate super-powers.

Name	Type	Optional
options	object	Yes

.setUserData(options?) : Promise<this>

Set user data.

Name	Type	Optional
options	object	Yes

.softDelete() : Promise<unknown>

Schedule account for deletion? Unsure what this does, use it at your own risk.

.update(options?) : Promise<this>

Update user data.

Name	Type	Optional
options	object	Yes

.updatePrivateChannel(rollback?) : Promise<this>

Update private channel ID. (rollback uses user ID)

Name	Type	Optional
rollback	boolean	No

.setHumanLink(vanity) : Promise<object>

Set the vanity URL for your profile. (requires approval)

Name	Type	Optional
vanity	string	No

.unsetHumanLink() : Promise<object>

Unset the vanity URL for your profile.