aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Data/Enums
diff options
context:
space:
mode:
authorPatrick Barron <barronpm@gmail.com>2020-05-19 19:44:55 -0400
committerPatrick Barron <barronpm@gmail.com>2020-05-20 10:04:00 -0400
commit292993d8efabf0380d7b6a53e074324b4c92f377 (patch)
tree7183eef690d993534cdd90aba29a7bfd3eecca6b /Jellyfin.Data/Enums
parentd35a7ba8bd5d49124cef0fb844080a3109cf61b7 (diff)
Document various classes.
Diffstat (limited to 'Jellyfin.Data/Enums')
-rw-r--r--Jellyfin.Data/Enums/PermissionKind.cs86
-rw-r--r--Jellyfin.Data/Enums/PreferenceKind.cs50
2 files changed, 136 insertions, 0 deletions
diff --git a/Jellyfin.Data/Enums/PermissionKind.cs b/Jellyfin.Data/Enums/PermissionKind.cs
index df18261e6..8b1472f97 100644
--- a/Jellyfin.Data/Enums/PermissionKind.cs
+++ b/Jellyfin.Data/Enums/PermissionKind.cs
@@ -1,27 +1,113 @@
namespace Jellyfin.Data.Enums
{
+ /// <summary>
+ /// The types of user permissions.
+ /// </summary>
public enum PermissionKind
{
+ /// <summary>
+ /// Whether the user is an administrator.
+ /// </summary>
IsAdministrator,
+
+ /// <summary>
+ /// Whether the user is hidden.
+ /// </summary>
IsHidden,
+
+ /// <summary>
+ /// Whether the user is disabled.
+ /// </summary>
IsDisabled,
+
+ /// <summary>
+ /// Whether the user can control shared devices.
+ /// </summary>
EnableSharedDeviceControl,
+
+ /// <summary>
+ /// Whether the user can access the server remotely.
+ /// </summary>
EnableRemoteAccess,
+
+ /// <summary>
+ /// Whether the user can manage live tv.
+ /// </summary>
EnableLiveTvManagement,
+
+ /// <summary>
+ /// Whether the user can access live tv.
+ /// </summary>
EnableLiveTvAccess,
+
+ /// <summary>
+ /// Whether the user can play media.
+ /// </summary>
EnableMediaPlayback,
+
+ /// <summary>
+ /// Whether the server should transcode audio for the user if requested.
+ /// </summary>
EnableAudioPlaybackTranscoding,
+
+ /// <summary>
+ /// Whether the server should transcode video for the user if requested.
+ /// </summary>
EnableVideoPlaybackTranscoding,
+
+ /// <summary>
+ /// Whether the user can delete content.
+ /// </summary>
EnableContentDeletion,
+
+ /// <summary>
+ /// Whether the user can download content.
+ /// </summary>
EnableContentDownloading,
+
+ /// <summary>
+ /// Whether to enable sync transcoding for the user.
+ /// </summary>
EnableSyncTranscoding,
+
+ /// <summary>
+ /// Whether the user can do media conversion.
+ /// </summary>
EnableMediaConversion,
+
+ /// <summary>
+ /// Whether the user has access to all devices.
+ /// </summary>
EnableAllDevices,
+
+ /// <summary>
+ /// Whether the user has access to all channels.
+ /// </summary>
EnableAllChannels,
+
+ /// <summary>
+ /// Whether the user has access to all folders.
+ /// </summary>
EnableAllFolders,
+
+ /// <summary>
+ /// Whether to enable public sharing for the user.
+ /// </summary>
EnablePublicSharing,
+
+ /// <summary>
+ /// Whether the user can remotely control other users.
+ /// </summary>
EnableRemoteControlOfOtherUsers,
+
+ /// <summary>
+ /// Whether the user is permitted to do playback remuxing.
+ /// </summary>
EnablePlaybackRemuxing,
+
+ /// <summary>
+ /// Whether the server should force transcoding on remote connections for the user.
+ /// </summary>
ForceRemoteSourceTranscoding
}
}
diff --git a/Jellyfin.Data/Enums/PreferenceKind.cs b/Jellyfin.Data/Enums/PreferenceKind.cs
index ea1221e1a..e0e9cfe04 100644
--- a/Jellyfin.Data/Enums/PreferenceKind.cs
+++ b/Jellyfin.Data/Enums/PreferenceKind.cs
@@ -1,18 +1,68 @@
namespace Jellyfin.Data.Enums
{
+ /// <summary>
+ /// The types of user preferences.
+ /// </summary>
public enum PreferenceKind
{
+ /// <summary>
+ /// A list of blocked tags.
+ /// </summary>
BlockedTags,
+
+ /// <summary>
+ /// A list of blocked channels.
+ /// </summary>
BlockedChannels,
+
+ /// <summary>
+ /// A list of blocked media folders.
+ /// </summary>
BlockedMediaFolders,
+
+ /// <summary>
+ /// A list of enabled devices.
+ /// </summary>
EnabledDevices,
+
+ /// <summary>
+ /// A list of enabled channels
+ /// </summary>
EnabledChannels,
+
+ /// <summary>
+ /// A list of enabled folders.
+ /// </summary>
EnabledFolders,
+
+ /// <summary>
+ /// A list of folders to allow content deletion from.
+ /// </summary>
EnableContentDeletionFromFolders,
+
+ /// <summary>
+ /// A list of latest items to exclude.
+ /// </summary>
LatestItemExcludes,
+
+ /// <summary>
+ /// A list of media to exclude.
+ /// </summary>
MyMediaExcludes,
+
+ /// <summary>
+ /// A list of grouped folders.
+ /// </summary>
GroupedFolders,
+
+ /// <summary>
+ /// A list of unrated items to block.
+ /// </summary>
BlockUnratedItems,
+
+ /// <summary>
+ /// A list of ordered views.
+ /// </summary>
OrderedViews
}
}