Skip to content

Guild

This data type describes all available data about the server.

Properties

PropertyTypeDescription
idNumberUnique identifier
nameStringName
iconUrlStringIcon URL
bannerUrlStringBanner URL
afkTimeoutNumberAFK timeout for voice channels (in minutes)
afkChannelVoiceChannelAFK Voice Channel
memberCountNumberAmount of Members (including bots)
userCountNumberAmount of Members (excluding bots)
botCountNumberAmount of Bots
createdAtDateTimeCreation date and time
ownerMemberOwner
selfMemberMemberBot's member instance
boostCountNumberAmount of active boosts
indexesGuildIndexesGuild Indexes

Methods

getChannel(ID)

Returns channel by given id.

Returns: TextChannel, NewsChannel, VoiceChannel, StageChannel, ForumChannel, MediaChannel

getMember(ID)

Returns member by given id.

Returns: Member

getRole(ID)

Returns role by given id.

Returns: Role

clearAttributes(Key)

Clears attributes with specified key for all members.

Warning! Quota

Following methods have shared quota and can only be invoked 1 times in the same template:

  • clearAttributes
  • clearAllAttributes

clearAllAttributes()

Clears all attributes for all members.

Warning! Quota

Following methods have shared quota and can only be invoked 1 times in the same template:

  • clearAttributes
  • clearAllAttributes

getIndex(Name)

Returns an index by its name.

Returns: GuildIndex

Warning! Quota

You can only access 2 guild indexes in single message template.

All rights sniffed.