< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.ChannelsController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/ChannelsController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 6
Coverable lines: 6
Total lines: 253
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetAllChannelFeatures()100%210%
GetChannelFeatures(...)100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/ChannelsController.cs

#LineLine coverage
 1using System;
 2using System.Collections.Generic;
 3using System.ComponentModel.DataAnnotations;
 4using System.Threading;
 5using System.Threading.Tasks;
 6using Jellyfin.Api.Helpers;
 7using Jellyfin.Api.ModelBinders;
 8using Jellyfin.Data.Enums;
 9using Jellyfin.Extensions;
 10using MediaBrowser.Controller.Channels;
 11using MediaBrowser.Controller.Dto;
 12using MediaBrowser.Controller.Entities;
 13using MediaBrowser.Controller.Library;
 14using MediaBrowser.Model.Channels;
 15using MediaBrowser.Model.Dto;
 16using MediaBrowser.Model.Querying;
 17using Microsoft.AspNetCore.Authorization;
 18using Microsoft.AspNetCore.Http;
 19using Microsoft.AspNetCore.Mvc;
 20
 21namespace Jellyfin.Api.Controllers;
 22
 23/// <summary>
 24/// Channels Controller.
 25/// </summary>
 26[Authorize]
 27public class ChannelsController : BaseJellyfinApiController
 28{
 29    private readonly IChannelManager _channelManager;
 30    private readonly IUserManager _userManager;
 31
 32    /// <summary>
 33    /// Initializes a new instance of the <see cref="ChannelsController"/> class.
 34    /// </summary>
 35    /// <param name="channelManager">Instance of the <see cref="IChannelManager"/> interface.</param>
 36    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 037    public ChannelsController(IChannelManager channelManager, IUserManager userManager)
 38    {
 039        _channelManager = channelManager;
 040        _userManager = userManager;
 041    }
 42
 43    /// <summary>
 44    /// Gets available channels.
 45    /// </summary>
 46    /// <param name="userId">User Id to filter by. Use <see cref="Guid.Empty"/> to not filter by user.</param>
 47    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 48    /// <param name="limit">Optional. The maximum number of records to return.</param>
 49    /// <param name="supportsLatestItems">Optional. Filter by channels that support getting latest items.</param>
 50    /// <param name="supportsMediaDeletion">Optional. Filter by channels that support media deletion.</param>
 51    /// <param name="isFavorite">Optional. Filter by channels that are favorite.</param>
 52    /// <response code="200">Channels returned.</response>
 53    /// <returns>An <see cref="OkResult"/> containing the channels.</returns>
 54    [HttpGet]
 55    [ProducesResponseType(StatusCodes.Status200OK)]
 56    public async Task<ActionResult<QueryResult<BaseItemDto>>> GetChannels(
 57        [FromQuery] Guid? userId,
 58        [FromQuery] int? startIndex,
 59        [FromQuery] int? limit,
 60        [FromQuery] bool? supportsLatestItems,
 61        [FromQuery] bool? supportsMediaDeletion,
 62        [FromQuery] bool? isFavorite)
 63    {
 64        userId = RequestHelpers.GetUserId(User, userId);
 65        return await _channelManager.GetChannelsAsync(new ChannelQuery
 66        {
 67            Limit = limit,
 68            StartIndex = startIndex,
 69            UserId = userId.Value,
 70            SupportsLatestItems = supportsLatestItems,
 71            SupportsMediaDeletion = supportsMediaDeletion,
 72            IsFavorite = isFavorite
 73        }).ConfigureAwait(false);
 74    }
 75
 76    /// <summary>
 77    /// Get all channel features.
 78    /// </summary>
 79    /// <response code="200">All channel features returned.</response>
 80    /// <returns>An <see cref="OkResult"/> containing the channel features.</returns>
 81    [HttpGet("Features")]
 82    [ProducesResponseType(StatusCodes.Status200OK)]
 83    public ActionResult<IEnumerable<ChannelFeatures>> GetAllChannelFeatures()
 84    {
 085        return _channelManager.GetAllChannelFeatures();
 86    }
 87
 88    /// <summary>
 89    /// Get channel features.
 90    /// </summary>
 91    /// <param name="channelId">Channel id.</param>
 92    /// <response code="200">Channel features returned.</response>
 93    /// <returns>An <see cref="OkResult"/> containing the channel features.</returns>
 94    [HttpGet("{channelId}/Features")]
 95    public ActionResult<ChannelFeatures> GetChannelFeatures([FromRoute, Required] Guid channelId)
 96    {
 097        return _channelManager.GetChannelFeatures(channelId);
 98    }
 99
 100    /// <summary>
 101    /// Get channel items.
 102    /// </summary>
 103    /// <param name="channelId">Channel Id.</param>
 104    /// <param name="folderId">Optional. Folder Id.</param>
 105    /// <param name="userId">Optional. User Id.</param>
 106    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 107    /// <param name="limit">Optional. The maximum number of records to return.</param>
 108    /// <param name="sortOrder">Optional. Sort Order - Ascending,Descending.</param>
 109    /// <param name="filters">Optional. Specify additional filters to apply.</param>
 110    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar
 111    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 112    /// <response code="200">Channel items returned.</response>
 113    /// <returns>
 114    /// A <see cref="Task"/> representing the request to get the channel items.
 115    /// The task result contains an <see cref="OkResult"/> containing the channel items.
 116    /// </returns>
 117    [HttpGet("{channelId}/Items")]
 118    public async Task<ActionResult<QueryResult<BaseItemDto>>> GetChannelItems(
 119        [FromRoute, Required] Guid channelId,
 120        [FromQuery] Guid? folderId,
 121        [FromQuery] Guid? userId,
 122        [FromQuery] int? startIndex,
 123        [FromQuery] int? limit,
 124        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] SortOrder[] sortOrder,
 125        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFilter[] filters,
 126        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemSortBy[] sortBy,
 127        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields[] fields)
 128    {
 129        userId = RequestHelpers.GetUserId(User, userId);
 130        var user = userId.IsNullOrEmpty()
 131            ? null
 132            : _userManager.GetUserById(userId.Value);
 133
 134        var query = new InternalItemsQuery(user)
 135        {
 136            Limit = limit,
 137            StartIndex = startIndex,
 138            ChannelIds = new[] { channelId },
 139            ParentId = folderId ?? Guid.Empty,
 140            OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder),
 141            DtoOptions = new DtoOptions { Fields = fields }
 142        };
 143
 144        foreach (var filter in filters)
 145        {
 146            switch (filter)
 147            {
 148                case ItemFilter.IsFolder:
 149                    query.IsFolder = true;
 150                    break;
 151                case ItemFilter.IsNotFolder:
 152                    query.IsFolder = false;
 153                    break;
 154                case ItemFilter.IsUnplayed:
 155                    query.IsPlayed = false;
 156                    break;
 157                case ItemFilter.IsPlayed:
 158                    query.IsPlayed = true;
 159                    break;
 160                case ItemFilter.IsFavorite:
 161                    query.IsFavorite = true;
 162                    break;
 163                case ItemFilter.IsResumable:
 164                    query.IsResumable = true;
 165                    break;
 166                case ItemFilter.Likes:
 167                    query.IsLiked = true;
 168                    break;
 169                case ItemFilter.Dislikes:
 170                    query.IsLiked = false;
 171                    break;
 172                case ItemFilter.IsFavoriteOrLikes:
 173                    query.IsFavoriteOrLiked = true;
 174                    break;
 175            }
 176        }
 177
 178        return await _channelManager.GetChannelItems(query, CancellationToken.None).ConfigureAwait(false);
 179    }
 180
 181    /// <summary>
 182    /// Gets latest channel items.
 183    /// </summary>
 184    /// <param name="userId">Optional. User Id.</param>
 185    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 186    /// <param name="limit">Optional. The maximum number of records to return.</param>
 187    /// <param name="filters">Optional. Specify additional filters to apply.</param>
 188    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 189    /// <param name="channelIds">Optional. Specify one or more channel id's, comma delimited.</param>
 190    /// <response code="200">Latest channel items returned.</response>
 191    /// <returns>
 192    /// A <see cref="Task"/> representing the request to get the latest channel items.
 193    /// The task result contains an <see cref="OkResult"/> containing the latest channel items.
 194    /// </returns>
 195    [HttpGet("Items/Latest")]
 196    public async Task<ActionResult<QueryResult<BaseItemDto>>> GetLatestChannelItems(
 197        [FromQuery] Guid? userId,
 198        [FromQuery] int? startIndex,
 199        [FromQuery] int? limit,
 200        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFilter[] filters,
 201        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] ItemFields[] fields,
 202        [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] Guid[] channelIds)
 203    {
 204        userId = RequestHelpers.GetUserId(User, userId);
 205        var user = userId.IsNullOrEmpty()
 206            ? null
 207            : _userManager.GetUserById(userId.Value);
 208
 209        var query = new InternalItemsQuery(user)
 210        {
 211            Limit = limit,
 212            StartIndex = startIndex,
 213            ChannelIds = channelIds,
 214            DtoOptions = new DtoOptions { Fields = fields }
 215        };
 216
 217        foreach (var filter in filters)
 218        {
 219            switch (filter)
 220            {
 221                case ItemFilter.IsFolder:
 222                    query.IsFolder = true;
 223                    break;
 224                case ItemFilter.IsNotFolder:
 225                    query.IsFolder = false;
 226                    break;
 227                case ItemFilter.IsUnplayed:
 228                    query.IsPlayed = false;
 229                    break;
 230                case ItemFilter.IsPlayed:
 231                    query.IsPlayed = true;
 232                    break;
 233                case ItemFilter.IsFavorite:
 234                    query.IsFavorite = true;
 235                    break;
 236                case ItemFilter.IsResumable:
 237                    query.IsResumable = true;
 238                    break;
 239                case ItemFilter.Likes:
 240                    query.IsLiked = true;
 241                    break;
 242                case ItemFilter.Dislikes:
 243                    query.IsLiked = false;
 244                    break;
 245                case ItemFilter.IsFavoriteOrLikes:
 246                    query.IsFavoriteOrLiked = true;
 247                    break;
 248            }
 249        }
 250
 251        return await _channelManager.GetLatestChannelItems(query, CancellationToken.None).ConfigureAwait(false);
 252    }
 253}
Generated by: ReportGenerator 5.3.8.0
9/19/2024 - 12:16:35 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Channels.IChannelManager,MediaBrowser.Controller.Library.IUserManager)
GetAllChannelFeatures()
GetChannelFeatures(System.Guid)