Constructor
new SoundboardSound()
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
available |
Boolean
|
Whether the soundboard sound is available or not (will always be true for default soundboard sounds) |
|
emojiID |
String
|
<nullable> |
The ID of the relating custom emoji (will always be null for default soundboard sounds) |
emojiName |
String
|
<nullable> |
The name mof the relating default emoji |
guild |
Guild
|
<nullable> |
The guild where the soundboard sound was created in (not present for default soundboard sounds). If the guild is uncached, this will be an object with an |
id |
String
|
The ID of the soundboard sound |
|
name |
String
|
The name of the soundboard sound |
|
user |
User
|
<nullable> |
The user that created the soundboard sound (not present for default soundboard sounds, or if the bot doesn't have either create/editGuildExpressions permissions) |
volume |
Number
|
The volume of the soundboard sound, between 0 and 1 |
- Source:
Methods
delete(reasonopt) → {Promise}
Delete the soundboard sound (not available for default soundboard sounds)
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reason |
String
|
<optional> |
The reason to be displayed in audit logs |
Returns:
- Type:
-
Promise
edit(options) → {Promise.<SoundboardSound>}
Edit the soundboard sound (not available for default soundboard sounds)
- Source:
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object
|
The properties to edit
|
Returns:
- Type:
-
Promise.<SoundboardSound>
send(channelID) → {Promise}
Send the soundboard sound to a connected voice channel
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
channelID |
String
|
The ID of the connected voice channel |
Returns:
- Type:
-
Promise