Guild
in package
Tags
Table of Contents
Properties
- $afk_channel_id : string|null
- $afk_timeout : int|null
- $application_id : string|null
- $approximate_member_count : int|null
- $approximate_presence_count : int|null
- $banner : string|null
- $default_message_notifications : DefaultMessageNotificationLevel|null
- $description : string|null
- $discovery_splash : string|null
- $emojis : array<string|int, mixed>|null
- $explicit_content_filter : ExplicitContentFilterLevel|null
- $features : array<string|int, mixed>
- $icon : string|null
- $icon_hash : string|null
- $id : string
- $max_members : int|null
- $max_presences : int|null
- $max_stage_video_channel_users : int|null
- $max_video_channel_users : int|null
- $mfa_level : MfaLevel|null
- $name : string|null
- $nsfw_level : GuildNsfwLevel|null
- $owner : bool|null
- $owner_id : string|null
- $permissions : string|null
- $preferred_locale : string|null
- $premium_progress_bar_enabled : bool|null
- $premium_subscription_count : int|null
- $premium_tier : PremiumTier|null
- $public_updates_channel_id : string|null
- $region : string|null
- Voice region id for the guild (deprecated).
- $roles : array<string|int, mixed>|null
- $rules_channel_id : string|null
- $safety_alerts_channel_id : string|null
- $splash : string|null
- $stickers : array<string|int, mixed>|null
- $system_channel_flags : int|null
- $system_channel_id : string|null
- $vanity_url_code : string|null
- $verification_level : VerificationLevel|null
- $welcome_screen : WelcomeScreen|null
- $widget_channel_id : string|null
- $widget_enabled : bool|null
Methods
- __construct() : mixed
Properties
$afk_channel_id
public
string|null
$afk_channel_id
$afk_timeout
public
int|null
$afk_timeout
$application_id
public
string|null
$application_id
$approximate_member_count
public
int|null
$approximate_member_count
= null
$approximate_presence_count
public
int|null
$approximate_presence_count
= null
$banner
public
string|null
$banner
$default_message_notifications
public
DefaultMessageNotificationLevel|null
$default_message_notifications
$description
public
string|null
$description
$discovery_splash
public
string|null
$discovery_splash
$emojis
public
array<string|int, mixed>|null
$emojis
$explicit_content_filter
public
ExplicitContentFilterLevel|null
$explicit_content_filter
$features
public
array<string|int, mixed>
$features
$icon
public
string|null
$icon
$icon_hash
public
string|null
$icon_hash
= null
$id
public
string
$id
$max_members
public
int|null
$max_members
= null
$max_presences
public
int|null
$max_presences
= null
$max_stage_video_channel_users
public
int|null
$max_stage_video_channel_users
= null
$max_video_channel_users
public
int|null
$max_video_channel_users
= null
$mfa_level
public
MfaLevel|null
$mfa_level
$name
public
string|null
$name
$nsfw_level
public
GuildNsfwLevel|null
$nsfw_level
$owner
public
bool|null
$owner
= null
$owner_id
public
string|null
$owner_id
$permissions
public
string|null
$permissions
= null
$preferred_locale
public
string|null
$preferred_locale
$premium_progress_bar_enabled
public
bool|null
$premium_progress_bar_enabled
$premium_subscription_count
public
int|null
$premium_subscription_count
= null
$premium_tier
public
PremiumTier|null
$premium_tier
$public_updates_channel_id
public
string|null
$public_updates_channel_id
$region
Voice region id for the guild (deprecated).
public
string|null
$region
$roles
public
array<string|int, mixed>|null
$roles
$rules_channel_id
public
string|null
$rules_channel_id
$safety_alerts_channel_id
public
string|null
$safety_alerts_channel_id
$splash
public
string|null
$splash
$stickers
public
array<string|int, mixed>|null
$stickers
= null
$system_channel_flags
public
int|null
$system_channel_flags
$system_channel_id
public
string|null
$system_channel_id
$vanity_url_code
public
string|null
$vanity_url_code
$verification_level
public
VerificationLevel|null
$verification_level
$welcome_screen
public
WelcomeScreen|null
$welcome_screen
= null
$widget_channel_id
public
string|null
$widget_channel_id
= null
$widget_enabled
public
bool|null
$widget_enabled
= null
Methods
__construct()
public
__construct(string $id, string|null $name, string|null $icon, string|null $splash, string|null $discovery_splash, string|null $owner_id, string|null $afk_channel_id, int|null $afk_timeout, VerificationLevel|null $verification_level, DefaultMessageNotificationLevel|null $default_message_notifications, ExplicitContentFilterLevel|null $explicit_content_filter, array<string|int, Role> $roles, array<string|int, Emoji> $emojis, array<string|int, string> $features, MfaLevel|null $mfa_level, string|null $application_id, string|null $system_channel_id, int|null $system_channel_flags, string|null $rules_channel_id, string|null $vanity_url_code, string|null $description, string|null $banner, PremiumTier|null $premium_tier, string|null $preferred_locale, string|null $public_updates_channel_id, GuildNsfwLevel|null $nsfw_level, bool $premium_progress_bar_enabled, string|null $safety_alerts_channel_id[, string|null $icon_hash = null ][, bool|null $owner = null ][, string|null $permissions = null ][, string|null $region = null ][, bool|null $widget_enabled = null ][, string|null $widget_channel_id = null ][, int|null $max_presences = null ][, int|null $max_members = null ][, int|null $premium_subscription_count = null ][, int|null $max_video_channel_users = null ][, int|null $max_stage_video_channel_users = null ][, int|null $approximate_member_count = null ][, int|null $approximate_presence_count = null ][, WelcomeScreen|null $welcome_screen = null ][, array<string|int, Sticker>|null $stickers = null ]) : mixed
Parameters
- $id : string
-
Guild id.
- $name : string|null
-
Guild name (2-100 characters, excluding trailing and leading whitespace).
- $icon : string|null
-
Icon hash.
- $splash : string|null
-
Splash hash.
- $discovery_splash : string|null
-
Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature.
- $owner_id : string|null
-
ID of owner.
- $afk_channel_id : string|null
-
ID of afk channel.
- $afk_timeout : int|null
-
AFK timeout in seconds.
- $verification_level : VerificationLevel|null
-
Verification level required for the guild.
- $default_message_notifications : DefaultMessageNotificationLevel|null
-
Default message notifications level.
- $explicit_content_filter : ExplicitContentFilterLevel|null
-
Explicit content filter level.
- $roles : array<string|int, Role>
-
Roles in the guild.
- $emojis : array<string|int, Emoji>
-
Custom guild emojis.
- $features : array<string|int, string>
-
Enabled guild features.
- $mfa_level : MfaLevel|null
-
Required MFA level for the guild.
- $application_id : string|null
-
Application id of the guild creator if it is bot-created.
- $system_channel_id : string|null
-
The id of the channel where guild notices such as welcome messages and boost events are posted.
- $system_channel_flags : int|null
-
System channel flags.
- $rules_channel_id : string|null
-
The id of the channel where Community guilds can display rules and/or guidelines.
- $vanity_url_code : string|null
-
The vanity url code for the guild.
- $description : string|null
-
The description of the guild.
- $banner : string|null
-
Banner hash.
- $premium_tier : PremiumTier|null
-
Premium tier (Sever Boost level).
- $preferred_locale : string|null
-
The preferred locale of a Community guild; used in server discovery and notices from Discord, and sent in interactions; defaults to "en-US".
- $public_updates_channel_id : string|null
-
The id of the channel where admins and moderators of Community guilds receive notices from Discord.
- $nsfw_level : GuildNsfwLevel|null
-
Guild NSFW level.
- $premium_progress_bar_enabled : bool
-
Whether the guild has the boost progress bar enabled.
- $safety_alerts_channel_id : string|null
-
The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord.
- $icon_hash : string|null = null
-
Icon hash, returned when in the template object.
- $owner : bool|null = null
-
True if the user is the owner of the guild.
- $permissions : string|null = null
-
Total permissions for the user in the guild (excludes overwrites and implicit permissions).
- $region : string|null = null
-
Voice region id for the guild (deprecated).
- $widget_enabled : bool|null = null
-
True if the server widget is enabled.
- $widget_channel_id : string|null = null
-
The channel id that the widget will generate an invite to, or null if set to no invite.
- $max_presences : int|null = null
-
The maximum number of presences for the guild (null is always returned, apart from the largest of guilds).
- $max_members : int|null = null
-
The maximum number of members for the guild.
- $premium_subscription_count : int|null = null
-
The number of boosts this guild currently has.
- $max_video_channel_users : int|null = null
-
The maximum amount of users in a video channel.
- $max_stage_video_channel_users : int|null = null
-
The maximum amount of users in a stage video channel.
- $approximate_member_count : int|null = null
-
Approximate number of members in this guild, returned from the GET /guilds/
and /users/@me/guilds endpoints when with_counts is true. - $approximate_presence_count : int|null = null
-
Approximate number of non-offline members in this guild, returned from the GET /guilds/
and /users/@me/guilds endpoints when with_counts is true. - $welcome_screen : WelcomeScreen|null = null
-
The welcome screen of a Community guild, shown to new members, returned in an invite's guild object.
- $stickers : array<string|int, Sticker>|null = null
-
Custom guild stickers.