new Starboard(manager, id, options, messages)
A starboard
Parameters:
| Name | Type | Description |
|---|---|---|
manager |
StarboardsManager | The starboard manager |
id |
number | The ID of this starboard |
options |
StarboardOptions | The starboard options |
messages |
Array.<StarMessageData> | The messages in this starboard |
Members
(private) _options :StarboardOptions
The options of this starboard
Type:
botStar :boolean
Whether bots can star messages for this starboard
Type:
- boolean
channel :Discord.TextChannel|Discord.NewsChannel
The channel of this starboard
Type:
- Discord.TextChannel | Discord.NewsChannel
channelID :Discord.Snowflake
The ID of the channel of this starboard
Type:
- Discord.Snowflake
color :Discord.EmojiIdentifierResolvable
The color of the embed(s) of this starboard's messages
Type:
- Discord.EmojiIdentifierResolvable
emoji :Discord.EmojiIdentifierResolvable
The emoji to react with for this starboard
Type:
- Discord.EmojiIdentifierResolvable
guild :Discord.Guild
The guild of this starboard
Type:
- Discord.Guild
guildId :Discord.Snowflake
The ID of the guild of this starboard
Type:
- Discord.Snowflake
id :number
The ID of this starboard
Type:
- number
(nullable) ignoreMembers :function
Ignore star reactions from members who pass this function
Type:
- function
(nullable) ignoreMessages :function
Ignore star reactions for messages that pass this function
Type:
- function
manager :StarboardsManager
The manager of this starboard
Type:
messages :Array.<StarMessageData>
The messages in this starboard
Type:
- Array.<StarMessageData>
selfStar :boolean
Whether members can star their own messages for this starboard
Type:
- boolean
threshold :number
The amount of reactions required for this starboard
Type:
- number
Methods
(async) deleteStarMessage(message)
Delete a message from the starboard
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Discord.Message | The message to be deleted from the starboard |
(async) postStarMessage(message)
Post a new message in the starboard channel
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Discord.Message | The message to post in the starboard channel |