aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/DevicesController.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Jellyfin.Api/Controllers/DevicesController.cs')
-rw-r--r--Jellyfin.Api/Controllers/DevicesController.cs209
1 files changed, 104 insertions, 105 deletions
diff --git a/Jellyfin.Api/Controllers/DevicesController.cs b/Jellyfin.Api/Controllers/DevicesController.cs
index aad60cf5c..497862236 100644
--- a/Jellyfin.Api/Controllers/DevicesController.cs
+++ b/Jellyfin.Api/Controllers/DevicesController.cs
@@ -13,129 +13,128 @@ using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
-namespace Jellyfin.Api.Controllers
+namespace Jellyfin.Api.Controllers;
+
+/// <summary>
+/// Devices Controller.
+/// </summary>
+[Authorize(Policy = Policies.RequiresElevation)]
+public class DevicesController : BaseJellyfinApiController
{
+ private readonly IDeviceManager _deviceManager;
+ private readonly ISessionManager _sessionManager;
+
/// <summary>
- /// Devices Controller.
+ /// Initializes a new instance of the <see cref="DevicesController"/> class.
/// </summary>
- [Authorize(Policy = Policies.RequiresElevation)]
- public class DevicesController : BaseJellyfinApiController
+ /// <param name="deviceManager">Instance of <see cref="IDeviceManager"/> interface.</param>
+ /// <param name="sessionManager">Instance of <see cref="ISessionManager"/> interface.</param>
+ public DevicesController(
+ IDeviceManager deviceManager,
+ ISessionManager sessionManager)
{
- private readonly IDeviceManager _deviceManager;
- private readonly ISessionManager _sessionManager;
+ _deviceManager = deviceManager;
+ _sessionManager = sessionManager;
+ }
- /// <summary>
- /// Initializes a new instance of the <see cref="DevicesController"/> class.
- /// </summary>
- /// <param name="deviceManager">Instance of <see cref="IDeviceManager"/> interface.</param>
- /// <param name="sessionManager">Instance of <see cref="ISessionManager"/> interface.</param>
- public DevicesController(
- IDeviceManager deviceManager,
- ISessionManager sessionManager)
- {
- _deviceManager = deviceManager;
- _sessionManager = sessionManager;
- }
+ /// <summary>
+ /// Get Devices.
+ /// </summary>
+ /// <param name="supportsSync">Gets or sets a value indicating whether [supports synchronize].</param>
+ /// <param name="userId">Gets or sets the user identifier.</param>
+ /// <response code="200">Devices retrieved.</response>
+ /// <returns>An <see cref="OkResult"/> containing the list of devices.</returns>
+ [HttpGet]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ public async Task<ActionResult<QueryResult<DeviceInfo>>> GetDevices([FromQuery] bool? supportsSync, [FromQuery] Guid? userId)
+ {
+ return await _deviceManager.GetDevicesForUser(userId, supportsSync).ConfigureAwait(false);
+ }
- /// <summary>
- /// Get Devices.
- /// </summary>
- /// <param name="supportsSync">Gets or sets a value indicating whether [supports synchronize].</param>
- /// <param name="userId">Gets or sets the user identifier.</param>
- /// <response code="200">Devices retrieved.</response>
- /// <returns>An <see cref="OkResult"/> containing the list of devices.</returns>
- [HttpGet]
- [ProducesResponseType(StatusCodes.Status200OK)]
- public async Task<ActionResult<QueryResult<DeviceInfo>>> GetDevices([FromQuery] bool? supportsSync, [FromQuery] Guid? userId)
+ /// <summary>
+ /// Get info for a device.
+ /// </summary>
+ /// <param name="id">Device Id.</param>
+ /// <response code="200">Device info retrieved.</response>
+ /// <response code="404">Device not found.</response>
+ /// <returns>An <see cref="OkResult"/> containing the device info on success, or a <see cref="NotFoundResult"/> if the device could not be found.</returns>
+ [HttpGet("Info")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task<ActionResult<DeviceInfo>> GetDeviceInfo([FromQuery, Required] string id)
+ {
+ var deviceInfo = await _deviceManager.GetDevice(id).ConfigureAwait(false);
+ if (deviceInfo is null)
{
- return await _deviceManager.GetDevicesForUser(userId, supportsSync).ConfigureAwait(false);
+ return NotFound();
}
- /// <summary>
- /// Get info for a device.
- /// </summary>
- /// <param name="id">Device Id.</param>
- /// <response code="200">Device info retrieved.</response>
- /// <response code="404">Device not found.</response>
- /// <returns>An <see cref="OkResult"/> containing the device info on success, or a <see cref="NotFoundResult"/> if the device could not be found.</returns>
- [HttpGet("Info")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult<DeviceInfo>> GetDeviceInfo([FromQuery, Required] string id)
- {
- var deviceInfo = await _deviceManager.GetDevice(id).ConfigureAwait(false);
- if (deviceInfo is null)
- {
- return NotFound();
- }
+ return deviceInfo;
+ }
- return deviceInfo;
+ /// <summary>
+ /// Get options for a device.
+ /// </summary>
+ /// <param name="id">Device Id.</param>
+ /// <response code="200">Device options retrieved.</response>
+ /// <response code="404">Device not found.</response>
+ /// <returns>An <see cref="OkResult"/> containing the device info on success, or a <see cref="NotFoundResult"/> if the device could not be found.</returns>
+ [HttpGet("Options")]
+ [ProducesResponseType(StatusCodes.Status200OK)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task<ActionResult<DeviceOptions>> GetDeviceOptions([FromQuery, Required] string id)
+ {
+ var deviceInfo = await _deviceManager.GetDeviceOptions(id).ConfigureAwait(false);
+ if (deviceInfo is null)
+ {
+ return NotFound();
}
- /// <summary>
- /// Get options for a device.
- /// </summary>
- /// <param name="id">Device Id.</param>
- /// <response code="200">Device options retrieved.</response>
- /// <response code="404">Device not found.</response>
- /// <returns>An <see cref="OkResult"/> containing the device info on success, or a <see cref="NotFoundResult"/> if the device could not be found.</returns>
- [HttpGet("Options")]
- [ProducesResponseType(StatusCodes.Status200OK)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult<DeviceOptions>> GetDeviceOptions([FromQuery, Required] string id)
- {
- var deviceInfo = await _deviceManager.GetDeviceOptions(id).ConfigureAwait(false);
- if (deviceInfo is null)
- {
- return NotFound();
- }
+ return deviceInfo;
+ }
- return deviceInfo;
- }
+ /// <summary>
+ /// Update device options.
+ /// </summary>
+ /// <param name="id">Device Id.</param>
+ /// <param name="deviceOptions">Device Options.</param>
+ /// <response code="204">Device options updated.</response>
+ /// <returns>A <see cref="NoContentResult"/>.</returns>
+ [HttpPost("Options")]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ public async Task<ActionResult> UpdateDeviceOptions(
+ [FromQuery, Required] string id,
+ [FromBody, Required] DeviceOptionsDto deviceOptions)
+ {
+ await _deviceManager.UpdateDeviceOptions(id, deviceOptions.CustomName).ConfigureAwait(false);
+ return NoContent();
+ }
- /// <summary>
- /// Update device options.
- /// </summary>
- /// <param name="id">Device Id.</param>
- /// <param name="deviceOptions">Device Options.</param>
- /// <response code="204">Device options updated.</response>
- /// <returns>A <see cref="NoContentResult"/>.</returns>
- [HttpPost("Options")]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- public async Task<ActionResult> UpdateDeviceOptions(
- [FromQuery, Required] string id,
- [FromBody, Required] DeviceOptionsDto deviceOptions)
+ /// <summary>
+ /// Deletes a device.
+ /// </summary>
+ /// <param name="id">Device Id.</param>
+ /// <response code="204">Device deleted.</response>
+ /// <response code="404">Device not found.</response>
+ /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the device could not be found.</returns>
+ [HttpDelete]
+ [ProducesResponseType(StatusCodes.Status204NoContent)]
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
+ public async Task<ActionResult> DeleteDevice([FromQuery, Required] string id)
+ {
+ var existingDevice = await _deviceManager.GetDevice(id).ConfigureAwait(false);
+ if (existingDevice is null)
{
- await _deviceManager.UpdateDeviceOptions(id, deviceOptions.CustomName).ConfigureAwait(false);
- return NoContent();
+ return NotFound();
}
- /// <summary>
- /// Deletes a device.
- /// </summary>
- /// <param name="id">Device Id.</param>
- /// <response code="204">Device deleted.</response>
- /// <response code="404">Device not found.</response>
- /// <returns>A <see cref="NoContentResult"/> on success, or a <see cref="NotFoundResult"/> if the device could not be found.</returns>
- [HttpDelete]
- [ProducesResponseType(StatusCodes.Status204NoContent)]
- [ProducesResponseType(StatusCodes.Status404NotFound)]
- public async Task<ActionResult> DeleteDevice([FromQuery, Required] string id)
- {
- var existingDevice = await _deviceManager.GetDevice(id).ConfigureAwait(false);
- if (existingDevice is null)
- {
- return NotFound();
- }
-
- var sessions = await _deviceManager.GetDevices(new DeviceQuery { DeviceId = id }).ConfigureAwait(false);
-
- foreach (var session in sessions.Items)
- {
- await _sessionManager.Logout(session).ConfigureAwait(false);
- }
+ var sessions = await _deviceManager.GetDevices(new DeviceQuery { DeviceId = id }).ConfigureAwait(false);
- return NoContent();
+ foreach (var session in sessions.Items)
+ {
+ await _sessionManager.Logout(session).ConfigureAwait(false);
}
+
+ return NoContent();
}
}