View Source Nostrum.Struct.Guild (Nostrum v0.8.0)
Struct representing a Discord guild.
Link to this section Summary
Types
The id of the guild's afk channel
The time someone must be afk before being moved
Application id of the guild creator if it is bot created.
A Nostrum.Struct.Guild that is fully available.
List of channels
Default message notifications level.
List of emojis
Explicit content filter level.
List of guild features
List of scheduled events
The hash of the guild's icon
The guild's id
Date the bot user joined the guild
Whether the guild is considered 'large'
Total number of members in the guild
Required MFA level of the guild
The name of the guild.
The id of the guild owner
The id of the channel where admins and moderators receive notices from Discord. This
is only available to guilds that contain PUBLIC in features/0.
The id of the voice region
A Nostrum.Struct.Guild that is sent on guild-specific rest endpoints.
List of roles
The id of the channel that is used for rules. This is only available to guilds that
contain PUBLIC in features/0.
The hash of the guild's splash
The id of the channel to which system messages are sent.
All active threads in the guild that the current user has permission to view
Whether the guild is available
A Nostrum.Struct.Guild that is unavailable.
A Nostrum.Struct.Guild that is sent on user-specific rest endpoints.
Guild invite vanity URL
The level of verification
List of voice states as maps
The channel id for the server widget.
Whether or not the server widget is enabled.
Functions
Returns the URL of a guild's icon, or nil if there is no icon.
Returns the URL of a guild's splash, or nil if there is no splash.
Link to this section Types
@type afk_channel_id() :: Nostrum.Struct.Channel.id() | nil
The id of the guild's afk channel
@type afk_timeout() :: integer()
The time someone must be afk before being moved
@type application_id() :: Nostrum.Snowflake.t() | nil
Application id of the guild creator if it is bot created.
@type available_guild() :: %Nostrum.Struct.Guild{ afk_channel_id: afk_channel_id(), afk_timeout: afk_timeout(), application_id: application_id(), channels: channels(), default_message_notifications: default_message_notifications(), emojis: emojis(), explicit_content_filter: explicit_content_filter(), features: features(), guild_scheduled_events: guild_scheduled_events(), icon: icon(), id: id(), joined_at: joined_at(), large: large(), member_count: member_count(), mfa_level: mfa_level(), name: name(), owner_id: owner_id(), public_updates_channel_id: public_updates_channel_id(), region: region(), roles: roles(), rules_channel_id: rules_channel_id(), splash: splash(), system_channel_id: system_channel_id(), threads: threads(), unavailable: false, vanity_url_code: vanity_url_code(), verification_level: verification_level(), voice_states: voice_states(), widget_channel_id: widget_channel_id(), widget_enabled: widget_enabled() }
A Nostrum.Struct.Guild that is fully available.
@type channels() :: %{required(Nostrum.Struct.Channel.id()) => Nostrum.Struct.Channel.t()} | nil
List of channels
@type default_message_notifications() :: integer()
Default message notifications level.
@type emojis() :: [Nostrum.Struct.Emoji.t()]
List of emojis
@type explicit_content_filter() :: integer()
Explicit content filter level.
@type features() :: [String.t()]
List of guild features
@type guild_scheduled_events() :: [Nostrum.Struct.Guild.ScheduledEvent.t()] | nil
List of scheduled events
@type icon() :: String.t() | nil
The hash of the guild's icon
@type id() :: Nostrum.Snowflake.t()
The guild's id
@type joined_at() :: String.t() | nil
Date the bot user joined the guild
@type large() :: boolean() | nil
Whether the guild is considered 'large'
@type member_count() :: integer() | nil
Total number of members in the guild
@type mfa_level() :: integer()
Required MFA level of the guild
@type name() :: String.t()
The name of the guild.
@type owner_id() :: Nostrum.Struct.User.id()
The id of the guild owner
@type public_updates_channel_id() :: Nostrum.Struct.Channel.id() | nil
The id of the channel where admins and moderators receive notices from Discord. This
is only available to guilds that contain PUBLIC in features/0.
@type region() :: String.t()
The id of the voice region
@type rest_guild() :: %Nostrum.Struct.Guild{ afk_channel_id: afk_channel_id(), afk_timeout: afk_timeout(), application_id: application_id(), channels: nil, default_message_notifications: default_message_notifications(), emojis: emojis(), explicit_content_filter: explicit_content_filter(), features: features(), guild_scheduled_events: nil, icon: icon(), id: id(), joined_at: nil, large: nil, member_count: nil, mfa_level: mfa_level(), name: name(), owner_id: owner_id(), public_updates_channel_id: public_updates_channel_id(), region: region(), roles: roles(), rules_channel_id: rules_channel_id(), splash: splash(), system_channel_id: system_channel_id(), threads: nil, unavailable: nil, vanity_url_code: vanity_url_code(), verification_level: verification_level(), voice_states: nil, widget_channel_id: widget_channel_id(), widget_enabled: widget_enabled() }
A Nostrum.Struct.Guild that is sent on guild-specific rest endpoints.
@type roles() :: %{ required(Nostrum.Struct.Guild.Role.id()) => Nostrum.Struct.Guild.Role.t() }
List of roles
@type rules_channel_id() :: Nostrum.Struct.Channel.id() | nil
The id of the channel that is used for rules. This is only available to guilds that
contain PUBLIC in features/0.
@type splash() :: String.t() | nil
The hash of the guild's splash
@type system_channel_id() :: Nostrum.Struct.Channel.id() | nil
The id of the channel to which system messages are sent.
@type t() :: available_guild() | unavailable_guild() | rest_guild() | user_guild()
@type threads() :: %{required(Nostrum.Struct.Channel.id()) => Nostrum.Struct.Channel.t()} | nil
All active threads in the guild that the current user has permission to view
@type user_guild() :: %Nostrum.Struct.Guild{ afk_channel_id: nil, afk_timeout: nil, application_id: nil, channels: nil, default_message_notifications: nil, emojis: nil, explicit_content_filter: nil, features: nil, guild_scheduled_events: term(), icon: icon(), id: id(), joined_at: nil, large: nil, member_count: nil, mfa_level: nil, name: name(), owner_id: nil, public_updates_channel_id: nil, region: nil, roles: nil, rules_channel_id: nil, splash: nil, system_channel_id: nil, threads: nil, unavailable: nil, vanity_url_code: nil, verification_level: nil, voice_states: nil, widget_channel_id: nil, widget_enabled: nil }
A Nostrum.Struct.Guild that is sent on user-specific rest endpoints.
@type vanity_url_code() :: String.t() | nil
Guild invite vanity URL
@type verification_level() :: integer()
The level of verification
@type voice_states() :: [map()] | nil
List of voice states as maps
@type widget_channel_id() :: Nostrum.Struct.Channel.id()
The channel id for the server widget.
@type widget_enabled() :: boolean() | nil
Whether or not the server widget is enabled.
Link to this section Functions
Returns the URL of a guild's icon, or nil if there is no icon.
Supported image formats are PNG, JPEG, and WebP.
examples
Examples
iex> guild = %Nostrum.Struct.Guild{icon: "86e39f7ae3307e811784e2ffd11a7310",
...> id: 41771983423143937}
iex> Nostrum.Struct.Guild.icon_url(guild)
"https://cdn.discordapp.com/icons/41771983423143937/86e39f7ae3307e811784e2ffd11a7310.webp"
iex> Nostrum.Struct.Guild.icon_url(guild, "png")
"https://cdn.discordapp.com/icons/41771983423143937/86e39f7ae3307e811784e2ffd11a7310.png"
iex> guild = %Nostrum.Struct.Guild{icon: nil}
iex> Nostrum.Struct.Guild.icon_url(guild)
nilReturns the URL of a guild's splash, or nil if there is no splash.
Supported image formats are PNG, JPEG, and WebP.
examples
Examples
iex> guild = %Nostrum.Struct.Guild{splash: "86e39f7ae3307e811784e2ffd11a7310",
...> id: 41771983423143937}
iex> Nostrum.Struct.Guild.splash_url(guild)
"https://cdn.discordapp.com/splashes/41771983423143937/86e39f7ae3307e811784e2ffd11a7310.webp"
iex> Nostrum.Struct.Guild.splash_url(guild, "png")
"https://cdn.discordapp.com/splashes/41771983423143937/86e39f7ae3307e811784e2ffd11a7310.png"
iex> guild = %Nostrum.Struct.Guild{splash: nil}
iex> Nostrum.Struct.Guild.splash_url(guild)
nil