aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Constants
diff options
context:
space:
mode:
authorShadowghost <Ghost_of_Stone@web.de>2023-01-31 12:18:10 +0100
committerShadowghost <Ghost_of_Stone@web.de>2023-02-02 18:50:33 +0100
commitf5f890e68562e55d4bed16c454c4b4305152b296 (patch)
treeb52e3b45ceb2faa446153866600b4456fed44c8b /Jellyfin.Api/Constants
parent58b3945805db4f88bc069ee84013bdf85d7429b1 (diff)
Migrate to file-scoped namespaces
Diffstat (limited to 'Jellyfin.Api/Constants')
-rw-r--r--Jellyfin.Api/Constants/AuthenticationSchemes.cs17
-rw-r--r--Jellyfin.Api/Constants/InternalClaimTypes.cs65
-rw-r--r--Jellyfin.Api/Constants/Policies.cs121
-rw-r--r--Jellyfin.Api/Constants/UserRoles.cs33
4 files changed, 116 insertions, 120 deletions
diff --git a/Jellyfin.Api/Constants/AuthenticationSchemes.cs b/Jellyfin.Api/Constants/AuthenticationSchemes.cs
index bac3379e7..d5c2253e4 100644
--- a/Jellyfin.Api/Constants/AuthenticationSchemes.cs
+++ b/Jellyfin.Api/Constants/AuthenticationSchemes.cs
@@ -1,13 +1,12 @@
-namespace Jellyfin.Api.Constants
+namespace Jellyfin.Api.Constants;
+
+/// <summary>
+/// Authentication schemes for user authentication in the API.
+/// </summary>
+public static class AuthenticationSchemes
{
/// <summary>
- /// Authentication schemes for user authentication in the API.
+ /// Scheme name for the custom legacy authentication.
/// </summary>
- public static class AuthenticationSchemes
- {
- /// <summary>
- /// Scheme name for the custom legacy authentication.
- /// </summary>
- public const string CustomAuthentication = "CustomAuthentication";
- }
+ public const string CustomAuthentication = "CustomAuthentication";
}
diff --git a/Jellyfin.Api/Constants/InternalClaimTypes.cs b/Jellyfin.Api/Constants/InternalClaimTypes.cs
index 8323312e5..73c4acb88 100644
--- a/Jellyfin.Api/Constants/InternalClaimTypes.cs
+++ b/Jellyfin.Api/Constants/InternalClaimTypes.cs
@@ -1,43 +1,42 @@
-namespace Jellyfin.Api.Constants
+namespace Jellyfin.Api.Constants;
+
+/// <summary>
+/// Internal claim types for authorization.
+/// </summary>
+public static class InternalClaimTypes
{
/// <summary>
- /// Internal claim types for authorization.
+ /// User Id.
/// </summary>
- public static class InternalClaimTypes
- {
- /// <summary>
- /// User Id.
- /// </summary>
- public const string UserId = "Jellyfin-UserId";
+ public const string UserId = "Jellyfin-UserId";
- /// <summary>
- /// Device Id.
- /// </summary>
- public const string DeviceId = "Jellyfin-DeviceId";
+ /// <summary>
+ /// Device Id.
+ /// </summary>
+ public const string DeviceId = "Jellyfin-DeviceId";
- /// <summary>
- /// Device.
- /// </summary>
- public const string Device = "Jellyfin-Device";
+ /// <summary>
+ /// Device.
+ /// </summary>
+ public const string Device = "Jellyfin-Device";
- /// <summary>
- /// Client.
- /// </summary>
- public const string Client = "Jellyfin-Client";
+ /// <summary>
+ /// Client.
+ /// </summary>
+ public const string Client = "Jellyfin-Client";
- /// <summary>
- /// Version.
- /// </summary>
- public const string Version = "Jellyfin-Version";
+ /// <summary>
+ /// Version.
+ /// </summary>
+ public const string Version = "Jellyfin-Version";
- /// <summary>
- /// Token.
- /// </summary>
- public const string Token = "Jellyfin-Token";
+ /// <summary>
+ /// Token.
+ /// </summary>
+ public const string Token = "Jellyfin-Token";
- /// <summary>
- /// Is Api Key.
- /// </summary>
- public const string IsApiKey = "Jellyfin-IsApiKey";
- }
+ /// <summary>
+ /// Is Api Key.
+ /// </summary>
+ public const string IsApiKey = "Jellyfin-IsApiKey";
}
diff --git a/Jellyfin.Api/Constants/Policies.cs b/Jellyfin.Api/Constants/Policies.cs
index a72eeea28..5a5a2bf46 100644
--- a/Jellyfin.Api/Constants/Policies.cs
+++ b/Jellyfin.Api/Constants/Policies.cs
@@ -1,78 +1,77 @@
-namespace Jellyfin.Api.Constants
+namespace Jellyfin.Api.Constants;
+
+/// <summary>
+/// Policies for the API authorization.
+/// </summary>
+public static class Policies
{
/// <summary>
- /// Policies for the API authorization.
+ /// Policy name for default authorization.
/// </summary>
- public static class Policies
- {
- /// <summary>
- /// Policy name for default authorization.
- /// </summary>
- public const string DefaultAuthorization = "DefaultAuthorization";
+ public const string DefaultAuthorization = "DefaultAuthorization";
- /// <summary>
- /// Policy name for requiring first time setup or elevated privileges.
- /// </summary>
- public const string FirstTimeSetupOrElevated = "FirstTimeSetupOrElevated";
+ /// <summary>
+ /// Policy name for requiring first time setup or elevated privileges.
+ /// </summary>
+ public const string FirstTimeSetupOrElevated = "FirstTimeSetupOrElevated";
- /// <summary>
- /// Policy name for requiring elevated privileges.
- /// </summary>
- public const string RequiresElevation = "RequiresElevation";
+ /// <summary>
+ /// Policy name for requiring elevated privileges.
+ /// </summary>
+ public const string RequiresElevation = "RequiresElevation";
- /// <summary>
- /// Policy name for allowing local access only.
- /// </summary>
- public const string LocalAccessOnly = "LocalAccessOnly";
+ /// <summary>
+ /// Policy name for allowing local access only.
+ /// </summary>
+ public const string LocalAccessOnly = "LocalAccessOnly";
- /// <summary>
- /// Policy name for escaping schedule controls.
- /// </summary>
- public const string IgnoreParentalControl = "IgnoreParentalControl";
+ /// <summary>
+ /// Policy name for escaping schedule controls.
+ /// </summary>
+ public const string IgnoreParentalControl = "IgnoreParentalControl";
- /// <summary>
- /// Policy name for requiring download permission.
- /// </summary>
- public const string Download = "Download";
+ /// <summary>
+ /// Policy name for requiring download permission.
+ /// </summary>
+ public const string Download = "Download";
- /// <summary>
- /// Policy name for requiring first time setup or default permissions.
- /// </summary>
- public const string FirstTimeSetupOrDefault = "FirstTimeSetupOrDefault";
+ /// <summary>
+ /// Policy name for requiring first time setup or default permissions.
+ /// </summary>
+ public const string FirstTimeSetupOrDefault = "FirstTimeSetupOrDefault";
- /// <summary>
- /// Policy name for requiring local access or elevated privileges.
- /// </summary>
- public const string LocalAccessOrRequiresElevation = "LocalAccessOrRequiresElevation";
+ /// <summary>
+ /// Policy name for requiring local access or elevated privileges.
+ /// </summary>
+ public const string LocalAccessOrRequiresElevation = "LocalAccessOrRequiresElevation";
- /// <summary>
- /// Policy name for requiring (anonymous) LAN access.
- /// </summary>
- public const string AnonymousLanAccessPolicy = "AnonymousLanAccessPolicy";
+ /// <summary>
+ /// Policy name for requiring (anonymous) LAN access.
+ /// </summary>
+ public const string AnonymousLanAccessPolicy = "AnonymousLanAccessPolicy";
- /// <summary>
- /// Policy name for escaping schedule controls or requiring first time setup.
- /// </summary>
- public const string FirstTimeSetupOrIgnoreParentalControl = "FirstTimeSetupOrIgnoreParentalControl";
+ /// <summary>
+ /// Policy name for escaping schedule controls or requiring first time setup.
+ /// </summary>
+ public const string FirstTimeSetupOrIgnoreParentalControl = "FirstTimeSetupOrIgnoreParentalControl";
- /// <summary>
- /// Policy name for accessing SyncPlay.
- /// </summary>
- public const string SyncPlayHasAccess = "SyncPlayHasAccess";
+ /// <summary>
+ /// Policy name for accessing SyncPlay.
+ /// </summary>
+ public const string SyncPlayHasAccess = "SyncPlayHasAccess";
- /// <summary>
- /// Policy name for creating a SyncPlay group.
- /// </summary>
- public const string SyncPlayCreateGroup = "SyncPlayCreateGroup";
+ /// <summary>
+ /// Policy name for creating a SyncPlay group.
+ /// </summary>
+ public const string SyncPlayCreateGroup = "SyncPlayCreateGroup";
- /// <summary>
- /// Policy name for joining a SyncPlay group.
- /// </summary>
- public const string SyncPlayJoinGroup = "SyncPlayJoinGroup";
+ /// <summary>
+ /// Policy name for joining a SyncPlay group.
+ /// </summary>
+ public const string SyncPlayJoinGroup = "SyncPlayJoinGroup";
- /// <summary>
- /// Policy name for accessing a SyncPlay group.
- /// </summary>
- public const string SyncPlayIsInGroup = "SyncPlayIsInGroup";
- }
+ /// <summary>
+ /// Policy name for accessing a SyncPlay group.
+ /// </summary>
+ public const string SyncPlayIsInGroup = "SyncPlayIsInGroup";
}
diff --git a/Jellyfin.Api/Constants/UserRoles.cs b/Jellyfin.Api/Constants/UserRoles.cs
index d9a536e7d..41c7b7cd0 100644
--- a/Jellyfin.Api/Constants/UserRoles.cs
+++ b/Jellyfin.Api/Constants/UserRoles.cs
@@ -1,23 +1,22 @@
-namespace Jellyfin.Api.Constants
+namespace Jellyfin.Api.Constants;
+
+/// <summary>
+/// Constants for user roles used in the authentication and authorization for the API.
+/// </summary>
+public static class UserRoles
{
/// <summary>
- /// Constants for user roles used in the authentication and authorization for the API.
+ /// Guest user.
/// </summary>
- public static class UserRoles
- {
- /// <summary>
- /// Guest user.
- /// </summary>
- public const string Guest = "Guest";
+ public const string Guest = "Guest";
- /// <summary>
- /// Regular user with no special privileges.
- /// </summary>
- public const string User = "User";
+ /// <summary>
+ /// Regular user with no special privileges.
+ /// </summary>
+ public const string User = "User";
- /// <summary>
- /// Administrator user with elevated privileges.
- /// </summary>
- public const string Administrator = "Administrator";
- }
+ /// <summary>
+ /// Administrator user with elevated privileges.
+ /// </summary>
+ public const string Administrator = "Administrator";
}