Skip to main content

Interface: GuildSettings

Per-guild configuration envelope that customizes giveaway behaviour.

Settings are merged with DEFAULT_SETTINGS at runtime to ensure a complete object is always available to commands and utilities.

Properties

defaults

defaults: object;

Default attributes applied to newly created giveaways.

NameTypeDescription
buttonLabelstringCustom label displayed on the entry button component.
dmWinnersbooleanWhether winners should receive direct messages when selected.
durationstringDefault ISO 8601 duration string (e.g. 1h, 2d).
winnersnumberDefault number of winners for /giveaway start.

limits

limits: object;

Safety limits enforced across all giveaways within a guild.

NameTypeDescription
maxDurationDaysnumberMaximum giveaway duration expressed in whole days.
maxWinnersnumberUpper bound on the number of winners that can be configured.

restrictions

restrictions: object;

Guild-wide entry requirements enforced for every giveaway.

NameTypeDescription
allowRoleIdsstring[]Role IDs that are explicitly allowed to enter; empty means all roles allowed.
denyRoleIdsstring[]Role IDs that are prevented from entering.
minAccountAgeDaysnull | numberMinimum required Discord account age in days, or null to disable.