Constructor
new GuildPreview()
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
approximateMemberCount |
Number
|
The approximate number of members in the guild |
|
approximatePresenceCount |
Number
|
The approximate number of presences in the guild |
|
description |
String
|
<nullable> |
The description for the guild (VIP only) |
discoverySplash |
String
|
<nullable> |
The hash of the guild discovery splash image, or null if no splash |
discoverySplashURL |
String
|
<nullable> |
The URL of the guild's discovery splash image |
emojis |
Array.<Object>
|
An array of guild emoji objects |
|
features |
Array.<String>
|
An array of guild feature strings |
|
icon |
String
|
<nullable> |
The hash of the guild icon, or null if no icon |
iconURL |
String
|
<nullable> |
The URL of the guild's icon |
id |
String
|
The ID of the guild |
|
name |
String
|
The name of the guild |
|
splash |
String
|
<nullable> |
The hash of the guild splash image, or null if no splash (VIP only) |
splashURL |
String
|
<nullable> |
The URL of the guild's splash image |
- Source:
Extends
Methods
dynamicDiscoverySplashURL(formatopt, sizeopt) → (nullable) {String}
Get the guild's splash with the given format and size
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
format |
String
|
<optional> |
The filetype of the icon ("jpg", "jpeg", "png", "gif", or "webp") |
size |
Number
|
<optional> |
The size of the icon (any power of two between 16 and 4096) |
Returns:
- Type:
-
String
dynamicIconURL(formatopt, sizeopt) → (nullable) {String}
Get the guild's icon with the given format and size
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
format |
String
|
<optional> |
The filetype of the icon ("jpg", "jpeg", "png", "gif", or "webp") |
size |
Number
|
<optional> |
The size of the icon (any power of two between 16 and 4096) |
Returns:
- Type:
-
String
dynamicSplashURL(formatopt, sizeopt) → (nullable) {String}
Get the guild's splash with the given format and size
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
format |
String
|
<optional> |
The filetype of the icon ("jpg", "jpeg", "png", "gif", or "webp") |
size |
Number
|
<optional> |
The size of the icon (any power of two between 16 and 4096) |
Returns:
- Type:
-
String