GuildIndex
This data type describes specific guild's index. Guild Indexes can be used to store a set of sorted data.
INFO
For more information about guild indexes and how to use them, check Guild Indexes article.
Properties
This is dynamic type properties of which are automatically generated based on index entry keys if they are valid identifiers.
WARNING
You can only access 2 index entries in single message template, e.g. two entries of a single index or one entry per two different indexes.
Methods
get(Key)
Returns or creates an entry by its key.
Returns: GuildIndexEntry
Warning! Quota
You can only request up to two entries of any index per single message template.
update(Entries)
Batch updates multiple entries at once (up to 2).
getPageOf(Number, Size, Sort)
Returns a page of index entries by page number and size with specified sorting direction.
Returns: Page<GuildIndexEntry>
Warning! Quota
You can only request a single page of index entries per single message template.
clearAll()
Clears all entries of this index.
Warning! Quota
You can only clear a single index per single message template.