@spec all_flags() :: [flag()]

Every flag name EDA knows about.

@spec apply_changeset(
  EDA.Entity.Changeset.t(),
  keyword()
) :: {:ok, t()} | {:error, term()}

Applies a changeset to a channel. No-op if the changeset has no changes.

Options

• :reason - Audit log reason

@spec change(EDA.Entity.Changeset.t(), atom(), term()) :: EDA.Entity.Changeset.t()

Adds a change to an existing changeset for this entity.

@spec changeset(t()) :: EDA.Entity.Changeset.t()

Creates a changeset for batching mutations to this entity.

@spec delete(
  t() | String.t() | integer(),
  keyword()
) :: :ok | {:error, term()}

Deletes a channel.

Options

• :reason - Audit log reason

@spec fetch(t() | String.t() | integer()) :: {:ok, t()} | {:error, term()}

Fetches a channel by ID. Checks cache first, falls back to REST.

@spec fetch!(t() | String.t() | integer()) :: t()

Fetches a channel by ID. Raises on error.

@spec flag_hide_media_download_options() :: integer()

Hides embedded media download options; media channels only (1 <<< 15).

@spec flag_list(t() | map() | integer() | nil) :: [flag()]

Returns the set flags as a list of names, ignoring bits EDA does not know.

Examples

iex> EDA.Channel.flag_list(%EDA.Channel{flags: (1 <<< 17) + (1 <<< 1)})
[:obfuscated, :pinned]

iex> EDA.Channel.flag_list(nil)
[]

@spec flag_obfuscated() :: integer()

The channel's metadata is obfuscated because the bot cannot view it (1 <<< 17).

@spec flag_pinned() :: integer()

Thread pinned in its parent forum or media channel (1 <<< 1).

@spec flag_require_tag() :: integer()

Threads in this forum or media channel require a tag (1 <<< 4).

@spec flag_spoiler() :: integer()

The channel requires opt-in viewing (1 <<< 21).

@spec follow(t() | String.t() | integer(), t() | String.t() | integer(), keyword()) ::
  {:ok, map()} | {:error, term()}

Follows an announcement channel, posting its published messages to target. Returns the webhook Discord created there, %{"channel_id" => ..., "webhook_id" => ...}.

Options

• :reason — audit log reason

@spec forum?(t()) :: boolean()

Returns true if the channel is a forum channel (type 15).

Examples

iex> EDA.Channel.forum?(%EDA.Channel{type: 15})
true

iex> EDA.Channel.forum?(%EDA.Channel{type: 0})
false

@spec has_flag?(t() | map() | integer() | nil, flag()) :: boolean()

Returns true if the given flag is set.

Accepts a t/0, a raw channel map as the cache stores it, a bitfield, or nil.

Examples

iex> EDA.Channel.has_flag?(%EDA.Channel{flags: 1 <<< 17}, :obfuscated)
true

iex> EDA.Channel.has_flag?(%{"flags" => 0}, :obfuscated)
false

iex> EDA.Channel.has_flag?(nil, :obfuscated)
false

Returns 2 — Gallery view layout.

Returns 1 — List view layout.

Returns 0 — Forum layout not set.

@spec media?(t()) :: boolean()

Returns true if the channel is a media channel (type 16).

Examples

iex> EDA.Channel.media?(%EDA.Channel{type: 16})
true

iex> EDA.Channel.media?(%EDA.Channel{type: 0})
false

@spec modify(t() | String.t() | integer(), map(), keyword()) ::
  {:ok, t()} | {:error, term()}

Modifies a channel. Accepts a struct or ID, a map of changes, and options.

Options

• :reason - Audit log reason

@spec obfuscated?(t() | map() | integer() | nil) :: boolean()

Returns true if Discord has obfuscated this channel because the bot cannot view it.

Obfuscated channels are still dispatched over the gateway, but their metadata is redacted: name becomes ___hidden___, sensitive fields are nulled, and permission_overwrites holds a single overwrite denying VIEW_CHANNEL to the guild's @everyone role. Treat them as "exists but invisible" — in particular do not compute permissions from those overwrites, and consider filtering them out of channel listings shown to users.

Mandatory for every bot from 2026-11-16; before then it is opt-in via config :eda, capabilities: [:channel_obfuscation] (see EDA.Gateway.Capabilities).

Examples

iex> EDA.Channel.obfuscated?(%EDA.Channel{flags: 1 <<< 17})
true

iex> EDA.Channel.obfuscated?(%EDA.Channel{flags: 0})
false

iex> EDA.Channel.obfuscated?(%{"flags" => 1 <<< 17})
true

iex> EDA.Channel.obfuscated?(nil)
false

@spec obfuscated_name() :: String.t()

The name Discord substitutes for an obfuscated channel.

Examples

iex> EDA.Channel.obfuscated_name()
"___hidden___"

@spec request_info(String.t() | integer(), [:status | :voice_start_time]) :: :ok

Asks the gateway for a guild's ephemeral channel data (opcode 43): voice channel statuses and voice session start times, which are not part of the channel object.

The answer arrives as a CHANNEL_INFO event — EDA.Event.ChannelInfo. Returns :ok once the request is sent; it does not wait for the answer. Changes after that arrive as VOICE_CHANNEL_STATUS_UPDATE and VOICE_CHANNEL_START_TIME_UPDATE.

EDA.Channel.request_info(guild_id)
EDA.Channel.request_info(guild_id, [:status])

@spec send_message(t() | String.t() | integer(), String.t() | map() | keyword()) ::
  {:ok, EDA.Message.t()} | {:error, term()}

Sends a message to a channel. Returns a %EDA.Message{} struct.

@spec set_voice_status(t() | String.t() | integer(), String.t() | nil, keyword()) ::
  :ok | {:error, term()}

Sets a voice channel's status (up to 500 characters, or nil to clear it).

Accepts a channel struct or ID.

Options

• :reason - Audit log reason

Returns 1 — Sort by creation date.

Returns 0 — Sort by latest activity.

@spec thread?(t()) :: boolean()

Returns true if the channel is a thread (types 10, 11, 12).

Examples

iex> EDA.Channel.thread?(%EDA.Channel{type: 11})
true

iex> EDA.Channel.thread?(%EDA.Channel{type: 0})
false

Returns 1 — Direct message.

Returns 3 — Group DM.

Returns 4 — Guild category.

Returns 15 — Forum channel.

Returns 16 — Media channel.

Returns 5 — Guild news/announcement channel.

Returns 10 — Thread in a news channel.

Returns 12 — Private thread.

Returns 11 — Public thread.

Returns 13 — Stage voice channel.

Returns 0 — Guild text channel.

Returns 2 — Guild voice channel.