Add MediaChannels (#853)

Common functionality between ForumChannel and MediaChannel was extracted to a new ThreadOnlyChannel supertype. See discord/discord-api-docs#6232
kordlib · Sep 3, 2023 · 4aa9701 · 4aa9701
1 parent 027c237
commit 4aa9701
Show file tree

Hide file tree

Showing 30 changed files with 876 additions and 113 deletions.
diff --git a/common/api/common.api b/common/api/common.api
@@ -1711,6 +1711,10 @@ public final class dev/kord/common/entity/ChannelFlag$Companion {
 	public fun values ()[Ldev/kord/common/entity/ChannelFlag;
 }
 
+public final class dev/kord/common/entity/ChannelFlag$HideMediaDownloadOptions : dev/kord/common/entity/ChannelFlag {
+	public static final field INSTANCE Ldev/kord/common/entity/ChannelFlag$HideMediaDownloadOptions;
+}
+
 public final class dev/kord/common/entity/ChannelFlag$Pinned : dev/kord/common/entity/ChannelFlag {
 	public static final field INSTANCE Ldev/kord/common/entity/ChannelFlag$Pinned;
 }
@@ -1801,6 +1805,10 @@ public final class dev/kord/common/entity/ChannelType$GuildForum : dev/kord/comm
 	public static final field INSTANCE Ldev/kord/common/entity/ChannelType$GuildForum;
 }
 
+public final class dev/kord/common/entity/ChannelType$GuildMedia : dev/kord/common/entity/ChannelType {
+	public static final field INSTANCE Ldev/kord/common/entity/ChannelType$GuildMedia;
+}
+
 public final class dev/kord/common/entity/ChannelType$GuildNews : dev/kord/common/entity/ChannelType {
 	public static final field INSTANCE Ldev/kord/common/entity/ChannelType$GuildNews;
 }

diff --git a/common/build/generated/ksp/metadata/commonMain/kotlin/dev/kord/common/entity/ChannelFlag.kt b/common/build/generated/ksp/metadata/commonMain/kotlin/dev/kord/common/entity/ChannelFlag.kt
@@ -80,6 +80,7 @@ public sealed class ChannelFlag(
     public fun ordinal(): Int = when (this) {
         Pinned -> 0
         RequireTag -> 1
+        HideMediaDownloadOptions -> 2
         is Unknown -> Int.MAX_VALUE
     }
 
@@ -103,16 +104,23 @@ public sealed class ChannelFlag(
     ) : ChannelFlag(shift)
 
     /**
-     * This thread is pinned to the top of its parent [GuildForum][ChannelType.GuildForum] channel.
+     * This thread is pinned to the top of its parent [GuildForum][ChannelType.GuildForum] or
+     * [GuildMedia][ChannelType.GuildMedia] channel.
      */
     public object Pinned : ChannelFlag(1)
 
     /**
      * Whether a tag is required to be specified when creating a thread in a
-     * [GuildForum][ChannelType.GuildForum] channel.
+     * [GuildForum][ChannelType.GuildForum] or [GuildMedia][ChannelType.GuildMedia] channel.
      */
     public object RequireTag : ChannelFlag(4)
 
+    /**
+     * When set hides the embedded media download options. Available only for
+     * [GuildMedia][ChannelType.GuildMedia] channels.
+     */
+    public object HideMediaDownloadOptions : ChannelFlag(15)
+
     public companion object {
         /**
          * A [List] of all known [ChannelFlag]s.
@@ -121,6 +129,7 @@ public sealed class ChannelFlag(
             listOf(
                 Pinned,
                 RequireTag,
+                HideMediaDownloadOptions,
             )
         }
 
@@ -148,6 +157,7 @@ public sealed class ChannelFlag(
         public fun fromShift(shift: Int): ChannelFlag = when (shift) {
             1 -> Pinned
             4 -> RequireTag
+            15 -> HideMediaDownloadOptions
             else -> Unknown(shift)
         }
 
@@ -161,6 +171,7 @@ public sealed class ChannelFlag(
         public open fun valueOf(name: String): ChannelFlag = when (name) {
             "Pinned" -> Pinned
             "RequireTag" -> RequireTag
+            "HideMediaDownloadOptions" -> HideMediaDownloadOptions
             else -> throw IllegalArgumentException(name)
         }
 

diff --git a/common/build/generated/ksp/metadata/commonMain/kotlin/dev/kord/common/entity/ChannelType.kt b/common/build/generated/ksp/metadata/commonMain/kotlin/dev/kord/common/entity/ChannelType.kt
@@ -117,6 +117,11 @@ public sealed class ChannelType(
      */
     public object GuildForum : ChannelType(15)
 
+    /**
+     * A channel that can only contain threads, similar to [GuildForum] channels.
+     */
+    public object GuildMedia : ChannelType(16)
+
     internal object Serializer : KSerializer<ChannelType> {
         override val descriptor: SerialDescriptor =
                 PrimitiveSerialDescriptor("dev.kord.common.entity.ChannelType", PrimitiveKind.INT)
@@ -146,6 +151,7 @@ public sealed class ChannelType(
                 GuildStageVoice,
                 GuildDirectory,
                 GuildForum,
+                GuildMedia,
             )
         }
 
@@ -167,6 +173,7 @@ public sealed class ChannelType(
             13 -> GuildStageVoice
             14 -> GuildDirectory
             15 -> GuildForum
+            16 -> GuildMedia
             else -> Unknown(value, null)
         }
     }

diff --git a/common/src/commonMain/kotlin/entity/DiscordChannel.kt b/common/src/commonMain/kotlin/entity/DiscordChannel.kt
@@ -37,6 +37,10 @@
                     "Student-Hubs-FAQ) containing the listed servers.",
         ),
         Entry("GuildForum", intValue = 15, kDoc = "A channel that can only contain threads."),
+        Entry(
+            "GuildMedia", intValue = 16,
+            kDoc = "A channel that can only contain threads, similar to [GuildForum] channels.",
+        ),
     ],
 )
 
@@ -47,12 +51,18 @@
     entries = [
         Entry(
             "Pinned", shift = 1,
-            kDoc = "This thread is pinned to the top of its parent [GuildForum][ChannelType.GuildForum] channel.",
+            kDoc = "This thread is pinned to the top of its parent [GuildForum][ChannelType.GuildForum] or " +
+                "[GuildMedia][ChannelType.GuildMedia] channel.",
         ),
         Entry(
             "RequireTag", shift = 4,
             kDoc = "Whether a tag is required to be specified when creating a thread in a " +
-                "[GuildForum][ChannelType.GuildForum] channel.",
+                "[GuildForum][ChannelType.GuildForum] or [GuildMedia][ChannelType.GuildMedia] channel.",
+        ),
+        Entry(
+            "HideMediaDownloadOptions", shift = 15, noStaticFieldIfEntityWasEnum = true,
+            kDoc = "When set hides the embedded media download options. Available only for " +
+                "[GuildMedia][ChannelType.GuildMedia] channels.",
         ),
     ],
 )