Nostrum v0.6.0

View Source Nostrum.Struct.Guild (Nostrum v0.6.0)

Struct representing a Discord guild.

Link to this section Summary

Types

afk_channel_id()

The id of the guild's afk channel

afk_timeout()

The time someone must be afk before being moved

application_id()

Application id of the guild creator if it is bot created.

available_guild()

A Nostrum.Struct.Guild that is fully available.

channels()

List of channels

default_message_notifications()

Default message notifications level.

emojis()

List of emojis

explicit_content_filter()

Explicit content filter level.

features()

List of guild features

guild_scheduled_events()

List of scheduled events

icon()

The hash of the guild's icon

id()

The guild's id

joined_at()

Date the bot user joined the guild

large()

Whether the guild is considered 'large'

member_count()

Total number of members in the guild

members()

List of members

mfa_level()

Required MFA level of the guild

name()

The name of the guild.

owner_id()

The id of the guild owner

public_updates_channel_id()

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.

region()

The id of the voice region

rest_guild()

A Nostrum.Struct.Guild that is sent on guild-specific rest endpoints.

roles()

List of roles

rules_channel_id()

The id of the channel that is used for rules. This is only available to guilds that contain PUBLIC in features/0.

splash()

The hash of the guild's splash

system_channel_id()

The id of the channel to which system messages are sent.

t()
threads()

All active threads in the guild that the current user has permission to view

unavailable()

Whether the guild is available

unavailable_guild()

A Nostrum.Struct.Guild that is unavailable.

user_guild()

A Nostrum.Struct.Guild that is sent on user-specific rest endpoints.

vanity_url_code()

Guild invite vanity URL

verification_level()

The level of verification

voice_states()

List of voice states as maps

widget_channel_id()

The channel id for the server widget.

widget_enabled()

Whether or not the server widget is enabled.

Functions

icon_url(guild, image_format \\ "webp")

Returns the URL of a guild's icon, or nil if there is no icon.

splash_url(guild, image_format \\ "webp")

Returns the URL of a guild's splash, or nil if there is no splash.

Link to this section Types

Link to this type

afk_channel_id()

View Source

Specs

afk_channel_id() :: Nostrum.Struct.Channel.id() | nil

The id of the guild's afk channel

Link to this type

afk_timeout()

View Source

Specs

afk_timeout() :: integer()

The time someone must be afk before being moved

Link to this type

application_id()

View Source

Specs

application_id() :: Nostrum.Snowflake.t() | nil

Application id of the guild creator if it is bot created.

Link to this type

available_guild()

View Source

Specs

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(),
  members: members(),
  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.

Link to this type

channels()

View Source

Specs

channels() ::
  %{required(Nostrum.Struct.Channel.id()) => Nostrum.Struct.Channel.t()} | nil

List of channels

Link to this type

default_message_notifications()

View Source

Specs

default_message_notifications() :: integer()

Default message notifications level.

Link to this type

emojis()

View Source

Specs

emojis() :: [Nostrum.Struct.Emoji.t()]

List of emojis

Link to this type

explicit_content_filter()

View Source

Specs

explicit_content_filter() :: integer()

Explicit content filter level.

Link to this type

features()

View Source

Specs

features() :: [String.t()]

List of guild features

Link to this type

guild_scheduled_events()

View Source

Specs

guild_scheduled_events() :: [Nostrum.Struct.Guild.ScheduledEvent.t()] | nil

List of scheduled events

Link to this type

icon()

View Source

Specs

icon() :: String.t() | nil

The hash of the guild's icon

Link to this type

id()

View Source

Specs

id() :: Nostrum.Snowflake.t()

The guild's id

Link to this type

joined_at()

View Source

Specs

joined_at() :: String.t() | nil

Date the bot user joined the guild

Link to this type

large()

View Source

Specs

large() :: boolean() | nil

Whether the guild is considered 'large'

Link to this type

member_count()

View Source

Specs

member_count() :: integer() | nil

Total number of members in the guild

Link to this type

members()

View Source

Specs

members() ::
  %{required(Nostrum.Struct.User.id()) => Nostrum.Struct.Guild.Member.t()} | nil

List of members

Link to this type

mfa_level()

View Source

Specs

mfa_level() :: integer()

Required MFA level of the guild

Link to this type

name()

View Source

Specs

name() :: String.t()

The name of the guild.

Link to this type

owner_id()

View Source

Specs

owner_id() :: Nostrum.Struct.User.id()

The id of the guild owner

Link to this type

public_updates_channel_id()

View Source

Specs

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.

Link to this type

region()

View Source

Specs

region() :: String.t()

The id of the voice region

Link to this type

rest_guild()

View Source

Specs

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,
  members: 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.

Link to this type

roles()

View Source

Specs

roles() :: %{
  required(Nostrum.Struct.Guild.Role.id()) => Nostrum.Struct.Guild.Role.t()
}

List of roles

Link to this type

rules_channel_id()

View Source

Specs

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.

Link to this type

splash()

View Source

Specs

splash() :: String.t() | nil

The hash of the guild's splash

Link to this type

system_channel_id()

View Source

Specs

system_channel_id() :: Nostrum.Struct.Channel.id() | nil

The id of the channel to which system messages are sent.

Link to this type

t()

View Source

Specs

t() :: available_guild() | unavailable_guild() | rest_guild() | user_guild()
Link to this type

threads()

View Source (since 0.5.1)

Specs

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

Link to this type

unavailable()

View Source

Specs

unavailable() :: boolean() | nil

Whether the guild is available

Link to this type

unavailable_guild()

View Source

Specs

unavailable_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: nil,
  icon: nil,
  id: id(),
  joined_at: nil,
  large: nil,
  member_count: nil,
  members: nil,
  mfa_level: nil,
  name: nil,
  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: true,
  vanity_url_code: nil,
  verification_level: nil,
  voice_states: nil,
  widget_channel_id: nil,
  widget_enabled: nil
}

A Nostrum.Struct.Guild that is unavailable.

Link to this type

user_guild()

View Source

Specs

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,
  members: 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.

Link to this type

vanity_url_code()

View Source

Specs

vanity_url_code() :: String.t() | nil

Guild invite vanity URL

Link to this type

verification_level()

View Source

Specs

verification_level() :: integer()

The level of verification

Link to this type

voice_states()

View Source

Specs

voice_states() :: [map()] | nil

List of voice states as maps

Link to this type

widget_channel_id()

View Source

Specs

widget_channel_id() :: Nostrum.Struct.Channel.id()

The channel id for the server widget.

Link to this type

widget_enabled()

View Source

Specs

widget_enabled() :: boolean() | nil

Whether or not the server widget is enabled.

Link to this section Functions

Link to this function

icon_url(guild, image_format \\ "webp")

View Source

Specs

icon_url(t(), String.t()) :: String.t() | nil

Returns the URL of a guild's icon, or nil if there is no icon.

Supported image formats are PNG, JPEG, and WebP.

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)
nil
Link to this function

splash_url(guild, image_format \\ "webp")

View Source

Specs

splash_url(t(), String.t()) :: String.t() | nil

Returns the URL of a guild's splash, or nil if there is no splash.

Supported image formats are PNG, JPEG, and WebP.

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