aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Data
diff options
context:
space:
mode:
authorCody Robibero <cody@robibe.ro>2023-11-09 14:00:29 -0700
committerGitHub <noreply@github.com>2023-11-09 14:00:29 -0700
commit906f701fa81c7cde1a9a01b066f3f29ff98552a5 (patch)
treeefc92ef0ecf4e535a519de4f8e950a77bb2ad5c3 /Jellyfin.Data
parentc7a94d48ae019f41d5f06340bca7efe0788ad5ad (diff)
Convert CollectionType, SpecialFolderType to enum (#9764)
* Convert CollectionType, SpecialFolderType to enum * Hide internal enum CollectionType values * Apply suggestions from code review Co-authored-by: Shadowghost <Shadowghost@users.noreply.github.com> * Fix recent change * Update Jellyfin.Data/Attributes/OpenApiIgnoreEnumAttribute.cs Co-authored-by: Patrick Barron <barronpm@gmail.com> --------- Co-authored-by: Shadowghost <Shadowghost@users.noreply.github.com> Co-authored-by: Patrick Barron <barronpm@gmail.com>
Diffstat (limited to 'Jellyfin.Data')
-rw-r--r--Jellyfin.Data/Attributes/OpenApiIgnoreEnumAttribute.cs11
-rw-r--r--Jellyfin.Data/Enums/CollectionType.cs164
2 files changed, 175 insertions, 0 deletions
diff --git a/Jellyfin.Data/Attributes/OpenApiIgnoreEnumAttribute.cs b/Jellyfin.Data/Attributes/OpenApiIgnoreEnumAttribute.cs
new file mode 100644
index 000000000..ff613d9f8
--- /dev/null
+++ b/Jellyfin.Data/Attributes/OpenApiIgnoreEnumAttribute.cs
@@ -0,0 +1,11 @@
+using System;
+
+namespace Jellyfin.Data.Attributes;
+
+/// <summary>
+/// Attribute to specify that the enum value is to be ignored when generating the openapi spec.
+/// </summary>
+[AttributeUsage(AttributeTargets.Field)]
+public sealed class OpenApiIgnoreEnumAttribute : Attribute
+{
+}
diff --git a/Jellyfin.Data/Enums/CollectionType.cs b/Jellyfin.Data/Enums/CollectionType.cs
new file mode 100644
index 000000000..e2044a0bc
--- /dev/null
+++ b/Jellyfin.Data/Enums/CollectionType.cs
@@ -0,0 +1,164 @@
+using Jellyfin.Data.Attributes;
+
+namespace Jellyfin.Data.Enums;
+
+/// <summary>
+/// Collection type.
+/// </summary>
+public enum CollectionType
+{
+ /// <summary>
+ /// Unknown collection.
+ /// </summary>
+ Unknown = 0,
+
+ /// <summary>
+ /// Movies collection.
+ /// </summary>
+ Movies = 1,
+
+ /// <summary>
+ /// Tv shows collection.
+ /// </summary>
+ TvShows = 2,
+
+ /// <summary>
+ /// Music collection.
+ /// </summary>
+ Music = 3,
+
+ /// <summary>
+ /// Music videos collection.
+ /// </summary>
+ MusicVideos = 4,
+
+ /// <summary>
+ /// Trailers collection.
+ /// </summary>
+ Trailers = 5,
+
+ /// <summary>
+ /// Home videos collection.
+ /// </summary>
+ HomeVideos = 6,
+
+ /// <summary>
+ /// Box sets collection.
+ /// </summary>
+ BoxSets = 7,
+
+ /// <summary>
+ /// Books collection.
+ /// </summary>
+ Books = 8,
+
+ /// <summary>
+ /// Photos collection.
+ /// </summary>
+ Photos = 9,
+
+ /// <summary>
+ /// Live tv collection.
+ /// </summary>
+ LiveTv = 10,
+
+ /// <summary>
+ /// Playlists collection.
+ /// </summary>
+ Playlists = 11,
+
+ /// <summary>
+ /// Folders collection.
+ /// </summary>
+ Folders = 12,
+
+ /// <summary>
+ /// Tv show series collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvShowSeries = 101,
+
+ /// <summary>
+ /// Tv genres collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvGenres = 102,
+
+ /// <summary>
+ /// Tv genre collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvGenre = 103,
+
+ /// <summary>
+ /// Tv latest collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvLatest = 104,
+
+ /// <summary>
+ /// Tv next up collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvNextUp = 105,
+
+ /// <summary>
+ /// Tv resume collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvResume = 106,
+
+ /// <summary>
+ /// Tv favorite series collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvFavoriteSeries = 107,
+
+ /// <summary>
+ /// Tv favorite episodes collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ TvFavoriteEpisodes = 108,
+
+ /// <summary>
+ /// Latest movies collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieLatest = 109,
+
+ /// <summary>
+ /// Movies to resume collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieResume = 110,
+
+ /// <summary>
+ /// Movie movie collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieMovies = 111,
+
+ /// <summary>
+ /// Movie collections collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieCollections = 112,
+
+ /// <summary>
+ /// Movie favorites collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieFavorites = 113,
+
+ /// <summary>
+ /// Movie genres collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieGenres = 114,
+
+ /// <summary>
+ /// Movie genre collection.
+ /// </summary>
+ [OpenApiIgnoreEnum]
+ MovieGenre = 115
+}