channel

Channels, threads and permission overwrites.

One flat record with a type_, not a sum type: twelve of the thirteen types carry name, so a sum type would force a twelve-arm case to read it.

Only id and type_ are required, so an interaction’s partial channel decodes through the same decoder as a full one.

Types

ActiveThreads

</>

The body of GET /guilds/{id}/threads/active, which is every active thread at once. Discord sends no has_more here, so there is no page to ask for.

pub type ActiveThreads {
  ActiveThreads(
    threads: List(Channel),
    members: List(ThreadMember),
  )
}

Constructors

ActiveThreads(
  threads: List(Channel),
  members: List(ThreadMember),
)

Channel

</>

A channel of any kind, threads included.

pub type Channel {
  Channel(
    id: id.Id(id.Channel),
    type_: ChannelType,
    guild_id: option.Option(id.Id(id.Guild)),
    position: option.Option(Int),
    permission_overwrites: option.Option(
      List(PermissionOverwrite),
    ),
    name: option.Option(String),
    topic: option.Option(String),
    nsfw: option.Option(Bool),
    last_message_id: option.Option(id.Id(id.Message)),
    bitrate: option.Option(Int),
    user_limit: option.Option(Int),
    rate_limit_per_user: option.Option(Int),
    recipients: option.Option(List(user.User)),
    icon: option.Option(String),
    owner_id: option.Option(id.Id(id.User)),
    application_id: option.Option(id.Id(id.Application)),
    managed: option.Option(Bool),
    parent_id: option.Option(id.Id(id.Channel)),
    last_pin_timestamp: option.Option(String),
    rtc_region: option.Option(String),
    video_quality_mode: option.Option(VideoQualityMode),
    message_count: option.Option(Int),
    member_count: option.Option(Int),
    thread_metadata: option.Option(ThreadMetadata),
    member: option.Option(ThreadMember),
    default_auto_archive_duration: option.Option(
      ThreadAutoArchiveDuration,
    ),
    permissions: option.Option(permissions.Permissions),
    flags: option.Option(flags.Flags(ChannelFlag)),
    total_message_sent: option.Option(Int),
    default_thread_rate_limit_per_user: option.Option(Int),
    newly_created: option.Option(Bool),
  )
}

Constructors

Channel(
  id: id.Id(id.Channel),
  type_: ChannelType,
  guild_id: option.Option(id.Id(id.Guild)),
  position: option.Option(Int),
  permission_overwrites: option.Option(List(PermissionOverwrite)),
  name: option.Option(String),
  topic: option.Option(String),
  nsfw: option.Option(Bool),
  last_message_id: option.Option(id.Id(id.Message)),
  bitrate: option.Option(Int),
  user_limit: option.Option(Int),
  rate_limit_per_user: option.Option(Int),
  recipients: option.Option(List(user.User)),
  icon: option.Option(String),
  owner_id: option.Option(id.Id(id.User)),
  application_id: option.Option(id.Id(id.Application)),
  managed: option.Option(Bool),
  parent_id: option.Option(id.Id(id.Channel)),
  last_pin_timestamp: option.Option(String),
  rtc_region: option.Option(String),
  video_quality_mode: option.Option(VideoQualityMode),
  message_count: option.Option(Int),
  member_count: option.Option(Int),
  thread_metadata: option.Option(ThreadMetadata),
  member: option.Option(ThreadMember),
  default_auto_archive_duration: option.Option(
    ThreadAutoArchiveDuration,
  ),
  permissions: option.Option(permissions.Permissions),
  flags: option.Option(flags.Flags(ChannelFlag)),
  total_message_sent: option.Option(Int),
  default_thread_rate_limit_per_user: option.Option(Int),
  newly_created: option.Option(Bool),
)

Arguments

last_message_id: May point at a deleted message.
user_limit: 0 means no limit.
rate_limit_per_user: Slowmode in SECONDS, 0 to 21600. Also gates thread creation.
rtc_region: Null means Discord picks the region.
message_count: Threads only. Excludes the initial message, and stops at 50 on threads created before 2022-07-01.
member_count: Threads only. STOPS COUNTING AT 50.
member: The current user’s membership: only flags and join_timestamp.
default_auto_archive_duration: MINUTES.
permissions: The invoking user’s computed permissions, on the partial channels in an interaction’s resolved data and nowhere else. The bot’s own are app_permissions on model/interaction.Interaction, a key of the interaction rather than of any channel in it.
flags: None on the shapes that drop the key, an interaction’s partial included. Defaulting it to 0 would let a cache merge clear flags nobody cleared, and an edit sends that back.
total_message_sent: Threads only. Unlike message_count this never decrements.
newly_created: THREAD_CREATE only: a new thread, not one the bot was added to.

ChannelFlag

</>

pub type ChannelFlag {
  Pinned
  RequireTag
  HideMediaDownloadOptions
  IsSpoilerChannel
}

Constructors

```
Pinned
```
A forum or media post pinned to the top of its parent.
```
RequireTag
```
The parent forum requires a tag on every post.
```
HideMediaDownloadOptions
```
```
IsSpoilerChannel
```
Every attachment in the channel is treated as a spoiler.

ChannelFlags

</>

pub type ChannelFlags =
  flags.Flags(ChannelFlag)

ChannelType

</>

Live values are 0 to 5, 10 to 13, 15 and 16. 14 is hub-only, and 6 to 9 were withdrawn but can still turn up in cached data.

pub type ChannelType {
  GuildText
  Dm
  GuildVoice
  GroupDm
  GuildCategory
  GuildAnnouncement
  AnnouncementThread
  PublicThread
  PrivateThread
  GuildStageVoice
  GuildDirectory
  GuildForum
  GuildMedia
  UnknownChannelType(Int)
}

Constructors

```
GuildText
```
```
Dm
```
```
GuildVoice
```
```
GroupDm
```
```
GuildCategory
```
```
GuildAnnouncement
```
```
AnnouncementThread
```
```
PublicThread
```
```
PrivateThread
```
```
GuildStageVoice
```
```
GuildDirectory
```
```
GuildForum
```
```
GuildMedia
```
```
UnknownChannelType(Int)
```

OverwriteTarget

</>

Who an overwrite applies to. Three cases, not two Options: a type Discord adds after this build is neither a role nor a member, and treating it as either grants or denies the wrong people.

pub type OverwriteTarget {
  RoleTarget(id.Id(id.Role))
  MemberTarget(id.Id(id.User))
  UnknownTarget(id.Id(id.Overwrite), Int)
}

Constructors

```
RoleTarget(id.Id(id.Role))
```
```
MemberTarget(id.Id(id.User))
```
```
UnknownTarget(id.Id(id.Overwrite), Int)
```
The raw type, so a caller can recognise one this build cannot name.

OverwriteType

</>

pub type OverwriteType {
  RoleOverwrite
  MemberOverwrite
  UnknownOverwriteType(Int)
}

Constructors

```
RoleOverwrite
```
```
MemberOverwrite
```
```
UnknownOverwriteType(Int)
```

PermissionOverwrite

</>

id is a role id or a user id, and only type_ says which. Read it through overwrite_target.

pub type PermissionOverwrite {
  PermissionOverwrite(
    id: id.Id(id.Overwrite),
    type_: OverwriteType,
    allow: permissions.Permissions,
    deny: permissions.Permissions,
  )
}

Constructors

PermissionOverwrite(
  id: id.Id(id.Overwrite),
  type_: OverwriteType,
  allow: permissions.Permissions,
  deny: permissions.Permissions,
)

ThreadAutoArchiveDuration

</>

Minute values, not an ordinal: 60, 1440, 4320, 10080.

pub type ThreadAutoArchiveDuration {
  OneHour
  OneDay
  ThreeDays
  OneWeek
  UnknownAutoArchiveDuration(Int)
}

Constructors

```
OneHour
```
```
OneDay
```
```
ThreeDays
```
```
OneWeek
```
```
UnknownAutoArchiveDuration(Int)
```

ThreadList

</>

The body of the two archived thread listings, which page. members holds only the bot’s own membership, and only of the threads it has joined.

pub type ThreadList {
  ThreadList(
    threads: List(Channel),
    members: List(ThreadMember),
    has_more: Bool,
  )
}

Constructors

ThreadList(
  threads: List(Channel),
  members: List(ThreadMember),
  has_more: Bool,
)

Arguments

has_more: Another page exists before the oldest thread returned.

ThreadMember

</>

One user’s membership of one thread. Mind the collision: Channel.member is a ThreadMember, and ThreadMember.member is a GuildMember.

pub type ThreadMember {
  ThreadMember(
    id: option.Option(id.Id(id.Channel)),
    user_id: option.Option(id.Id(id.User)),
    join_timestamp: String,
    flags: Int,
    member: option.Option(member.GuildMember),
  )
}

Constructors

ThreadMember(
  id: option.Option(id.Id(id.Channel)),
  user_id: option.Option(id.Id(id.User)),
  join_timestamp: String,
  flags: Int,
  member: option.Option(member.GuildMember),
)

Arguments

id: The THREAD’s id.
flags: Notification settings. Discord names no flags for these.
member: Only when the request asked for with_member=true.

ThreadMetadata

</>

pub type ThreadMetadata {
  ThreadMetadata(
    archived: Bool,
    auto_archive_duration: ThreadAutoArchiveDuration,
    archive_timestamp: String,
    locked: Bool,
    invitable: option.Option(Bool),
    create_timestamp: option.Option(String),
  )
}

Constructors

ThreadMetadata(
  archived: Bool,
  auto_archive_duration: ThreadAutoArchiveDuration,
  archive_timestamp: String,
  locked: Bool,
  invitable: option.Option(Bool),
  create_timestamp: option.Option(String),
)

Arguments

auto_archive_duration: MINUTES.
archive_timestamp: ISO-8601, when the archive flag last changed.
invitable: Private threads only.
create_timestamp: Only threads created after 2022-01-09.

VideoQualityMode

</>

pub type VideoQualityMode {
  AutoQuality
  FullQuality
  UnknownVideoQualityMode(Int)
}

Constructors

```
AutoQuality
```
```
FullQuality
```
```
UnknownVideoQualityMode(Int)
```

Values

active_threads_decoder

</>

pub fn active_threads_decoder() -> decode.Decoder(ActiveThreads)

auto_archive_duration_decoder

</>

pub fn auto_archive_duration_decoder() -> decode.Decoder(
  ThreadAutoArchiveDuration,
)

auto_archive_duration_from_int

</>

pub fn auto_archive_duration_from_int(
  value: Int,
) -> ThreadAutoArchiveDuration

auto_archive_duration_to_int

</>

pub fn auto_archive_duration_to_int(
  value: ThreadAutoArchiveDuration,
) -> Int

auto_archive_duration_to_json

</>

pub fn auto_archive_duration_to_json(
  value: ThreadAutoArchiveDuration,
) -> json.Json

channel_flags

</>

pub fn channel_flags(
  of chosen: List(ChannelFlag),
) -> flags.Flags(ChannelFlag)

Build the flags an edit sends. Anything decoded off the wire should be edited with with_flag instead, so bits this build cannot name survive.

channel_type_decoder

</>

pub fn channel_type_decoder() -> decode.Decoder(ChannelType)

channel_type_from_int

</>

pub fn channel_type_from_int(value: Int) -> ChannelType

channel_type_to_int

</>

pub fn channel_type_to_int(value: ChannelType) -> Int

channel_type_to_json

</>

pub fn channel_type_to_json(value: ChannelType) -> json.Json

decoder

</>

pub fn decoder() -> decode.Decoder(Channel)

has_flag

</>

pub fn has_flag(
  bits: flags.Flags(ChannelFlag),
  flag: ChannelFlag,
) -> Bool

is_dm

</>

pub fn is_dm(type_: ChannelType) -> Bool

is_textable

</>

pub fn is_textable(type_: ChannelType) -> Bool

Voice and stage channels have a text chat too.

is_thread

</>

pub fn is_thread(type_: ChannelType) -> Bool

is_thread_only

</>

pub fn is_thread_only(type_: ChannelType) -> Bool

Forums and media channels hold threads only, so they are not textable.

is_voice

</>

pub fn is_voice(type_: ChannelType) -> Bool

no_channel_flags

</>

pub const no_channel_flags: flags.Flags(ChannelFlag)

overwrite_target

</>

pub fn overwrite_target(
  overwrite: PermissionOverwrite,
) -> OverwriteTarget

overwrite_type_decoder

</>

pub fn overwrite_type_decoder() -> decode.Decoder(OverwriteType)

overwrite_type_from_int

</>

pub fn overwrite_type_from_int(value: Int) -> OverwriteType

overwrite_type_to_int

</>

pub fn overwrite_type_to_int(value: OverwriteType) -> Int

overwrite_type_to_json

</>

pub fn overwrite_type_to_json(value: OverwriteType) -> json.Json

permission_overwrite_decoder

</>

pub fn permission_overwrite_decoder() -> decode.Decoder(
  PermissionOverwrite,
)

permission_overwrite_to_json

</>

pub fn permission_overwrite_to_json(
  overwrite: PermissionOverwrite,
) -> json.Json

thread_list_decoder

</>

pub fn thread_list_decoder() -> decode.Decoder(ThreadList)

thread_member_decoder

</>

pub fn thread_member_decoder() -> decode.Decoder(ThreadMember)

thread_metadata_decoder

</>

pub fn thread_metadata_decoder() -> decode.Decoder(ThreadMetadata)

video_quality_mode_decoder

</>

pub fn video_quality_mode_decoder() -> decode.Decoder(
  VideoQualityMode,
)

video_quality_mode_from_int

</>

pub fn video_quality_mode_from_int(
  value: Int,
) -> VideoQualityMode

video_quality_mode_to_int

</>

pub fn video_quality_mode_to_int(value: VideoQualityMode) -> Int

video_quality_mode_to_json

</>

pub fn video_quality_mode_to_json(
  value: VideoQualityMode,
) -> json.Json

with_flag

</>

pub fn with_flag(
  bits: flags.Flags(ChannelFlag),
  flag: ChannelFlag,
) -> flags.Flags(ChannelFlag)

without_flag

</>

pub fn without_flag(
  bits: flags.Flags(ChannelFlag),
  flag: ChannelFlag,
) -> flags.Flags(ChannelFlag)