Group - antilandjs/antiland.js GitHub Wiki

The base structure for user objects.

extends Dialogue

Properties

.bans : BanManager

The ban manager for this chat.

.categories : Set<string>

A list of categories and topics for this chat.

.description : string | null • readonly

The description for this chat.

.founder : User • readonly

The founder of this group.

.founderId : string

The ID of the user who founded this group.

.humanLink : string | null • readonly

The human-link vanity URL for this group chat.

.manageable : boolean • readonly

Whether the client user can manage this group.

.members : MemberManager

The member manager for this group.

.minKarma : number

Search for, cache, and perform actions on friends.

Methods

.edit(options?) : Promise<number>

Edit the details of this group chat. (requires you to be the founder)

Name	Type	Optional
options	object	Yes

.join() : Promise<boolean>

Join this dialogue.

.resetSpamReport() : Promise<unknown>

Not sure what this does.

.sendComplaint(userId, messageId) : boolean

Send a complain about a message sent by another user.

Name	Type	Optional
userId	string	No
messageId	string	No

.setHumanLink(vanity) : Promise<Group>

Set the human-link for this group chat.

Name	Type	Optional
vanity	string	No

.setFilters(filters) : Promise<Group>

Set the chat filters for this chat.

Name	Type	Optional
filters	Array	No

.setInfo(options) : Promise<Group>

Set the info for this chat.

Name	Type	Optional
options	object	Yes

.setMood(moodId) : Promise<Group>

Set the chat mood for this chat.

Name	Type	Optional
moodId	string	No

.setName(name) : Promise<Group>

Set the name for this chat.

Name	Type	Optional
name	string	No

.unsetHumanLink() : Promise<Group>

Unset the human-link for this chat.

.update(options?) : Promise<Group>

Update the details of this group chat. (requires you to be the founder)

Name	Type	Optional
options	object	Yes

.updateFilters(options?) : Promise<Group>

Update the chat filters for this chat.

Name	Type	Optional
options	Array	Yes

.updateInfo(options?) : Promise<Group>

Update the info for this chat.

Name	Type	Optional
options	object	Yes