Skip to content

GuildIndexEntry

This data type describes a specific index entry.

INFO

For more information about guild indexes and how to use them, check Guild Indexes article.

Properties

PropertyTypeDescription
keyStringEntry key
valueNumberEntry value
metadataStringEntry metadata
indexNameStringThe index name related to this entry
updatedAtDateTimeUpdate date and time

Methods

update(Value, Metadata)

Updates entry value.

Returns the same value.

Returns: Number

Warning! Quota

You can only update entry value once using any method.

increment(Number)

Increments the value by specified amount and returns new value.

Returns: Number

Warning! Quota

You can only update entry value once using any method.

decrement(Number)

Decrements the value by specified amount and returns new value.

Returns: Number

Warning! Quota

You can only update entry value once using any method.

clear()

Clears entry and deletes it from database.

Warning! Quota

You can only update entry value once using any method.

All rights sniffed.