User - antilandjs/antiland.js GitHub Wiki

The base structure for user objects.

extends BaseStructure

Properties

.activity : string

The current presence of the user.

.age : number

Age of the user.

.blocked : boolean • readonly

Whether the user has blocked the client user.

.displayName : string

User display name. (includes emoji for sex)

.dmChannel : Dialogue • readonly

Whether the user has blocked the client user.

.friends : FriendManager

Search for, cache, and perform actions on friends.

.gender : string

Gender of the user.

.humanLink : string • readonly

Whether the user has blocked the client user.

.isAdmin : boolean • readonly

Whether the user is an app moderator.

.isInPrison : boolean • readonly

Whether the user is jailed.

.isVIP : boolean

Whether the user has super-powers?

.karma : number

Amount of karma for the user.

.minKarma : number

The minimum amount of karma required to DM the user.

.username : string

The lowercase display name without the emoji for sex.

Methods

.avatarURL() : string

The avatar URL for the user.

.checkRating(options?) : Promise<number>

Check the rating for a user profile.

.createDM() : Promise<Dialogue>

Create a private DM with a user.

.fetchDM(options?) : Promise<Dialogue>

Fetch or create a DM with a user.

.isPaired() : boolean

Check whether a user is your friend.

.send(content|options?) : Promise<object>

Send a message to a user.