Class GiveawaysManager

Index

Constructors

Methods

edit end fetchMessage reroll start

Constructors

constructor

new GiveawaysManager(client): GiveawaysManager
Parameters
- client: ForgeClient
Returns GiveawaysManager
- Defined in src/managers/GiveawaysManager.ts:23

Methods

edit

edit(id, options): Promise<null | Giveaway>
Edits an existing giveaway.
Parameters
- id: string
  The id of the giveaway to edit.
- options: Partial<Omit<IGiveawayStartOptions, "duration" | "guildID" | "channelID">>
  The options used to edit this giveaway.
Returns Promise<null | Giveaway>
- Defined in src/managers/GiveawaysManager.ts:201

end

end(id): Promise<null | Giveaway>
Ends an existing giveaway.
Parameters
- id: string
  The id of the giveaway to end.
Returns Promise<null | Giveaway>
- Defined in src/managers/GiveawaysManager.ts:91

fetchMessage

fetchMessage(channelID, messageID?): Promise<void | Message<true>>
Fetches the message of a giveaway.
Parameters
- channelID: string
  The id of the channel to pull message from.
- OptionalmessageID: string
  The id of the message to fetch.
Returns Promise<void | Message<true>>
- Defined in src/managers/GiveawaysManager.ts:250

reroll

reroll(id, unique?, amount?): Promise<null | Giveaway>
Rerolls an existing giveaway.
Parameters
- id: string
  The id of the giveaway to reroll.
- unique: boolean = false
  Whether to not include the previous winners.
- Optionalamount: number
  The amount of new winners.
Returns Promise<null | Giveaway>
- Defined in src/managers/GiveawaysManager.ts:155

start

start(options): Promise<null | Giveaway>
Starts a new giveaway on a guild.
Parameters
- options: IGiveawayStartOptions
  The start options for the giveaway.
Returns Promise<null | Giveaway>
- Defined in src/managers/GiveawaysManager.ts:33