Nostrum.Struct.Channel (Nostrum v0.4.6) View Source

Struct representing a Discord guild channel.

A Nostrum.Struct.Channel represents all 5 types of channels. Each channel has a field :type with any of the following values:

0 - GUILD_TEXT
1 - DM
2 - GUILD_VOICE
3 - GROUP_DM
4 - GUILD_CATEGORY

More information can be found on the Discord API Channel Documentation.

Mentioning Channels in Messages

A Nostrum.Struct.Channel can be mentioned in message content using the String.Chars protocol or mention/1.

channel = %Nostrum.Struct.Channel{id: 381889573426429952}
Nostrum.Api.create_message!(184046599834435585, "#{channel}")
%Nostrum.Struct.Message{content: "<#381889573426429952>"}

channel = %Nostrum.Struct.Channel{id: 280085880452939778}
Nostrum.Api.create_message!(280085880452939778, "#{Nostrum.Struct.Channel.mention(channel)}")
%Nostrum.Struct.Message{content: "<#280085880452939778>"}

Link to this section Summary

Types

application_id()

The application id of the group DM creator if it is bot-created

bitrate()

The bitrate of the voice channel

channel_category()

A Nostrum.Struct.Channel that represents a channel category in a guild.

dm_channel()

A Nostrum.Struct.Channel that represents a DM channel.

group_dm_channel()

A Nostrum.Struct.Channel that represents a group DM channel.

guild_channel()

A Nostrum.Struct.Channel that represents a channel in a guild.

guild_id()

The id of the channel's guild

guild_text_channel()

A Nostrum.Struct.Channel that represents a text channel in a guild.

guild_voice_channel()

A Nostrum.Struct.Channel that represents a voice channel in a guild.

icon()

The icon hash of the channel

id()

The channel's id

last_message_id()

Id of the last message sent

last_pin_timestamp()

When the last pinned message was pinned

name()

The name of the channel

nsfw()

If the channel is nsfw

owner_id()

The id of the DM creator

parent_id()

The id of the parent category for a channel

permission_overwrites()

The list of overwrites

position()

The ordered position of the channel

recipients()

The recipients of the DM

t()

text_channel()

A Nostrum.Struct.Channel that represents a text channel.

topic()

Current channel topic

user_limit()

The user limit of the voice channel

voice_channel()

A Nostrum.Struct.Channel that represents a voice channel.

Functions

mention(channel)

Formats a Nostrum.Struct.Channel into a mention.

Link to this section Types

application_id()

Specs

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

The application id of the group DM creator if it is bot-created

bitrate()

Specs

bitrate() :: integer()

The bitrate of the voice channel

channel_category()

Specs

channel_category() :: %Nostrum.Struct.Channel{
  application_id: nil,
  bitrate: nil,
  guild_id: guild_id(),
  icon: nil,
  id: id(),
  last_message_id: nil,
  last_pin_timestamp: nil,
  name: name(),
  nsfw: nsfw(),
  owner_id: nil,
  parent_id: parent_id(),
  permission_overwrites: permission_overwrites(),
  position: position(),
  recipients: nil,
  topic: nil,
  type: 4,
  user_limit: nil
}

A Nostrum.Struct.Channel that represents a channel category in a guild.

dm_channel()

Specs

dm_channel() :: %Nostrum.Struct.Channel{
  application_id: nil,
  bitrate: nil,
  guild_id: nil,
  icon: nil,
  id: id(),
  last_message_id: last_message_id(),
  last_pin_timestamp: nil,
  name: nil,
  nsfw: nil,
  owner_id: nil,
  parent_id: nil,
  permission_overwrites: nil,
  position: nil,
  recipients: recipients(),
  topic: nil,
  type: 1,
  user_limit: nil
}

A Nostrum.Struct.Channel that represents a DM channel.

group_dm_channel()

Specs

group_dm_channel() :: %Nostrum.Struct.Channel{
  application_id: application_id(),
  bitrate: nil,
  guild_id: nil,
  icon: icon(),
  id: id(),
  last_message_id: last_message_id(),
  last_pin_timestamp: nil,
  name: name(),
  nsfw: nil,
  owner_id: owner_id(),
  parent_id: nil,
  permission_overwrites: nil,
  position: nil,
  recipients: recipients(),
  topic: nil,
  type: 3,
  user_limit: nil
}

A Nostrum.Struct.Channel that represents a group DM channel.

guild_channel()

Specs

guild_channel() ::
  guild_text_channel() | guild_voice_channel() | channel_category()

A Nostrum.Struct.Channel that represents a channel in a guild.

guild_id()

Specs

guild_id() :: Nostrum.Struct.Guild.id()

The id of the channel's guild

guild_text_channel()

Specs

guild_text_channel() :: %Nostrum.Struct.Channel{
  application_id: nil,
  bitrate: nil,
  guild_id: guild_id(),
  icon: nil,
  id: id(),
  last_message_id: last_message_id(),
  last_pin_timestamp: last_pin_timestamp(),
  name: name(),
  nsfw: nsfw(),
  owner_id: nil,
  parent_id: parent_id(),
  permission_overwrites: permission_overwrites(),
  position: position(),
  recipients: nil,
  topic: topic(),
  type: 0,
  user_limit: nil
}

A Nostrum.Struct.Channel that represents a text channel in a guild.

guild_voice_channel()

Specs

guild_voice_channel() :: %Nostrum.Struct.Channel{
  application_id: nil,
  bitrate: bitrate(),
  guild_id: guild_id(),
  icon: nil,
  id: id(),
  last_message_id: nil,
  last_pin_timestamp: nil,
  name: name(),
  nsfw: nsfw(),
  owner_id: nil,
  parent_id: parent_id(),
  permission_overwrites: permission_overwrites(),
  position: position(),
  recipients: nil,
  topic: nil,
  type: 2,
  user_limit: user_limit()
}

A Nostrum.Struct.Channel that represents a voice channel in a guild.

icon()

Specs

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

The icon hash of the channel

id()

Specs

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

The channel's id

last_message_id()

Specs

last_message_id() :: Nostrum.Struct.Message.id() | nil

Id of the last message sent

last_pin_timestamp()

Specs

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

When the last pinned message was pinned

name()

Specs

name() :: String.t()

The name of the channel

nsfw()

Specs

nsfw() :: boolean()

If the channel is nsfw

owner_id()

Specs

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

The id of the DM creator

parent_id()

Specs

parent_id() :: id() | nil

The id of the parent category for a channel

permission_overwrites()

Specs

permission_overwrites() :: [Nostrum.Struct.Overwrite.t()]

The list of overwrites

position()

Specs

position() :: integer()

The ordered position of the channel

recipients()

Specs

recipients() :: [Nostrum.Struct.User.t()]

The recipients of the DM

t()

Specs

t() ::
  guild_text_channel()
  | dm_channel()
  | guild_voice_channel()
  | group_dm_channel()
  | channel_category()

text_channel()

Specs

text_channel() :: guild_text_channel() | dm_channel() | group_dm_channel()

A Nostrum.Struct.Channel that represents a text channel.

topic()

Specs

topic() :: String.t()

Current channel topic

user_limit()

Specs

user_limit() :: integer()

The user limit of the voice channel

voice_channel()

Specs

voice_channel() :: guild_voice_channel()

A Nostrum.Struct.Channel that represents a voice channel.

Link to this section Functions

mention(channel)

Specs

mention(t()) :: String.t()

Formats a Nostrum.Struct.Channel into a mention.

Examples

iex> channel = %Nostrum.Struct.Channel{id: 381889573426429952}
...> Nostrum.Struct.Channel.mention(channel)
"<#381889573426429952>"