Hierarchy
- BaseAPIObject
- Guild
Index
Constructors
Private constructor
Parameters
data: Object
params: Object
Returns Guild
Properties
api
The version of the requested API route
banner
The banner data of the guild
created
The creation date of the guild
created
The creation date of the guild as a unix timestamp
has
Indicates whether the object has the data returned if
GuildRequestOptions.fetchAdditionalStats=true during request
This is used to determine whether `Guild#fetchAdditionalStats()` has an effect.
level
The level of the guild
lib
The version of the representation of the data by the wrapper
members
The members of the guild
name
The name of the guild
requested
The unix timestamp indicating when this request started executing
source
The route used to request the data for this object
This is the value used to identify cache entries. API results with the same source can use the cache.
tag
The tag of the guild
territories
The amount of territories the guild currently holds
hasAdditionalStats=true, this is an array of Territories instead.timestamp
The unix timestamp indicating when the data of this request was last updated
This stat does not reflect the time this data was created, but when the API frontend last synced this data. The PvP leaderboard, for instance, updates once per hour. Yet this timestamp will update once every 30 seconds.
xp
The xp percentage of the 1.19 requirement of the guilds current level as a number between 0 and 1
Calculates like current_xp /requirement_1_19.
You can use data.guildLevels to translate the percentages to 1.20 values or percentages.
Methods
fetch
Mutates the object as if the fetchAdditionalStats property was
truewhen this guild was requestedThis method causes API requests.
Parameters
Optional options: GuildRequestOptions
The options for the request; the
guildfield has no effect
Returns Promise<Guild>
Represents a guild from the API