< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.ArtistsController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/ArtistsController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 201
Coverable lines: 201
Total lines: 483
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 44
Branch coverage: 0%
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%
GetArtists(...)0%462210%
GetAlbumArtists(...)0%462210%
GetArtistByName(...)0%620%

File(s)

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

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using System.Linq;
 4using Jellyfin.Api.Extensions;
 5using Jellyfin.Api.Helpers;
 6using Jellyfin.Api.ModelBinders;
 7using Jellyfin.Data.Enums;
 8using Jellyfin.Database.Implementations.Entities;
 9using Jellyfin.Database.Implementations.Enums;
 10using Jellyfin.Extensions;
 11using MediaBrowser.Controller.Dto;
 12using MediaBrowser.Controller.Entities;
 13using MediaBrowser.Controller.Library;
 14using MediaBrowser.Model.Dto;
 15using MediaBrowser.Model.Entities;
 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/// The artists controller.
 25/// </summary>
 26[Route("Artists")]
 27[Authorize]
 28public class ArtistsController : BaseJellyfinApiController
 29{
 30    private readonly ILibraryManager _libraryManager;
 31    private readonly IUserManager _userManager;
 32    private readonly IDtoService _dtoService;
 33
 34    /// <summary>
 35    /// Initializes a new instance of the <see cref="ArtistsController"/> class.
 36    /// </summary>
 37    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 38    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 39    /// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
 040    public ArtistsController(
 041        ILibraryManager libraryManager,
 042        IUserManager userManager,
 043        IDtoService dtoService)
 44    {
 045        _libraryManager = libraryManager;
 046        _userManager = userManager;
 047        _dtoService = dtoService;
 048    }
 49
 50    /// <summary>
 51    /// Gets all artists from a given item, folder, or the entire library.
 52    /// </summary>
 53    /// <param name="minCommunityRating">Optional filter by minimum community rating.</param>
 54    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 55    /// <param name="limit">Optional. The maximum number of records to return.</param>
 56    /// <param name="searchTerm">Optional. Search term.</param>
 57    /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</
 58    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 59    /// <param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This all
 60    /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows 
 61    /// <param name="filters">Optional. Specify additional filters to apply.</param>
 62    /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
 63    /// <param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
 64    /// <param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe
 65    /// <param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple,
 66    /// <param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This all
 67    /// <param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe del
 68    /// <param name="years">Optional. If specified, results will be filtered based on production year. This allows multi
 69    /// <param name="enableUserData">Optional, include user data.</param>
 70    /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
 71    /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
 72    /// <param name="person">Optional. If specified, results will be filtered to include only those containing the speci
 73    /// <param name="personIds">Optional. If specified, results will be filtered to include only those containing the sp
 74    /// <param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only th
 75    /// <param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pi
 76    /// <param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multipl
 77    /// <param name="userId">User id.</param>
 78    /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi
 79    /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p
 80    /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</
 81    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
 82    /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
 83    /// <param name="enableImages">Optional, include image information in output.</param>
 84    /// <param name="enableTotalRecordCount">Total record count.</param>
 85    /// <response code="200">Artists returned.</response>
 86    /// <returns>An <see cref="OkResult"/> containing the artists.</returns>
 87    [HttpGet]
 88    [ProducesResponseType(StatusCodes.Status200OK)]
 89    public ActionResult<QueryResult<BaseItemDto>> GetArtists(
 90        [FromQuery] double? minCommunityRating,
 91        [FromQuery] int? startIndex,
 92        [FromQuery] int? limit,
 93        [FromQuery] string? searchTerm,
 94        [FromQuery] Guid? parentId,
 95        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
 96        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes,
 97        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 98        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFilter[] filters,
 99        [FromQuery] bool? isFavorite,
 100        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes,
 101        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] genres,
 102        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] genreIds,
 103        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] officialRatings,
 104        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] tags,
 105        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] int[] years,
 106        [FromQuery] bool? enableUserData,
 107        [FromQuery] int? imageTypeLimit,
 108        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
 109        [FromQuery] string? person,
 110        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] personIds,
 111        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] personTypes,
 112        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] studios,
 113        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] studioIds,
 114        [FromQuery] Guid? userId,
 115        [FromQuery] string? nameStartsWithOrGreater,
 116        [FromQuery] string? nameStartsWith,
 117        [FromQuery] string? nameLessThan,
 118        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy,
 119        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder,
 120        [FromQuery] bool? enableImages = true,
 121        [FromQuery] bool enableTotalRecordCount = true)
 122    {
 0123        userId = RequestHelpers.GetUserId(User, userId);
 0124        var dtoOptions = new DtoOptions { Fields = fields }
 0125            .AddClientFields(User)
 0126            .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
 127
 0128        User? user = null;
 0129        BaseItem parentItem = _libraryManager.GetParentItem(parentId, userId);
 130
 0131        if (!userId.IsNullOrEmpty())
 132        {
 0133            user = _userManager.GetUserById(userId.Value);
 134        }
 135
 0136        var query = new InternalItemsQuery(user)
 0137        {
 0138            ExcludeItemTypes = excludeItemTypes,
 0139            IncludeItemTypes = includeItemTypes,
 0140            MediaTypes = mediaTypes,
 0141            StartIndex = startIndex,
 0142            Limit = limit,
 0143            IsFavorite = isFavorite,
 0144            NameLessThan = nameLessThan,
 0145            NameStartsWith = nameStartsWith,
 0146            NameStartsWithOrGreater = nameStartsWithOrGreater,
 0147            Tags = tags,
 0148            OfficialRatings = officialRatings,
 0149            Genres = genres,
 0150            GenreIds = genreIds,
 0151            StudioIds = studioIds,
 0152            Person = person,
 0153            PersonIds = personIds,
 0154            PersonTypes = personTypes,
 0155            Years = years,
 0156            MinCommunityRating = minCommunityRating,
 0157            DtoOptions = dtoOptions,
 0158            SearchTerm = searchTerm,
 0159            EnableTotalRecordCount = enableTotalRecordCount,
 0160            OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder)
 0161        };
 162
 0163        if (parentId.HasValue)
 164        {
 0165            if (parentItem is Folder)
 166            {
 0167                query.AncestorIds = new[] { parentId.Value };
 168            }
 169            else
 170            {
 0171                query.ItemIds = new[] { parentId.Value };
 172            }
 173        }
 174
 175        // Studios
 0176        if (studios.Length != 0)
 177        {
 0178            query.StudioIds = studios.Select(i =>
 0179            {
 0180                try
 0181                {
 0182                    return _libraryManager.GetStudio(i);
 0183                }
 0184                catch
 0185                {
 0186                    return null;
 0187                }
 0188            }).Where(i => i is not null).Select(i => i!.Id).ToArray();
 189        }
 190
 0191        foreach (var filter in filters)
 192        {
 193            switch (filter)
 194            {
 195                case ItemFilter.Dislikes:
 0196                    query.IsLiked = false;
 0197                    break;
 198                case ItemFilter.IsFavorite:
 0199                    query.IsFavorite = true;
 0200                    break;
 201                case ItemFilter.IsFavoriteOrLikes:
 0202                    query.IsFavoriteOrLiked = true;
 0203                    break;
 204                case ItemFilter.IsFolder:
 0205                    query.IsFolder = true;
 0206                    break;
 207                case ItemFilter.IsNotFolder:
 0208                    query.IsFolder = false;
 0209                    break;
 210                case ItemFilter.IsPlayed:
 0211                    query.IsPlayed = true;
 0212                    break;
 213                case ItemFilter.IsResumable:
 0214                    query.IsResumable = true;
 0215                    break;
 216                case ItemFilter.IsUnplayed:
 0217                    query.IsPlayed = false;
 0218                    break;
 219                case ItemFilter.Likes:
 0220                    query.IsLiked = true;
 221                    break;
 222            }
 223        }
 224
 0225        var result = _libraryManager.GetArtists(query);
 226
 0227        var dtos = result.Items.Select(i =>
 0228        {
 0229            var (baseItem, itemCounts) = i;
 0230            var dto = _dtoService.GetItemByNameDto(baseItem, dtoOptions, null, user);
 0231
 0232            if (includeItemTypes.Length != 0)
 0233            {
 0234                dto.ChildCount = itemCounts.ItemCount;
 0235                dto.ProgramCount = itemCounts.ProgramCount;
 0236                dto.SeriesCount = itemCounts.SeriesCount;
 0237                dto.EpisodeCount = itemCounts.EpisodeCount;
 0238                dto.MovieCount = itemCounts.MovieCount;
 0239                dto.TrailerCount = itemCounts.TrailerCount;
 0240                dto.AlbumCount = itemCounts.AlbumCount;
 0241                dto.SongCount = itemCounts.SongCount;
 0242                dto.ArtistCount = itemCounts.ArtistCount;
 0243            }
 0244
 0245            return dto;
 0246        });
 247
 0248        return new QueryResult<BaseItemDto>(
 0249            query.StartIndex,
 0250            result.TotalRecordCount,
 0251            dtos.ToArray());
 252    }
 253
 254    /// <summary>
 255    /// Gets all album artists from a given item, folder, or the entire library.
 256    /// </summary>
 257    /// <param name="minCommunityRating">Optional filter by minimum community rating.</param>
 258    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 259    /// <param name="limit">Optional. The maximum number of records to return.</param>
 260    /// <param name="searchTerm">Optional. Search term.</param>
 261    /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</
 262    /// <param name="fields">Optional. Specify additional fields of information to return in the output.</param>
 263    /// <param name="excludeItemTypes">Optional. If specified, results will be filtered out based on item type. This all
 264    /// <param name="includeItemTypes">Optional. If specified, results will be filtered based on item type. This allows 
 265    /// <param name="filters">Optional. Specify additional filters to apply.</param>
 266    /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
 267    /// <param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
 268    /// <param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe
 269    /// <param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple,
 270    /// <param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This all
 271    /// <param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe del
 272    /// <param name="years">Optional. If specified, results will be filtered based on production year. This allows multi
 273    /// <param name="enableUserData">Optional, include user data.</param>
 274    /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
 275    /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
 276    /// <param name="person">Optional. If specified, results will be filtered to include only those containing the speci
 277    /// <param name="personIds">Optional. If specified, results will be filtered to include only those containing the sp
 278    /// <param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only th
 279    /// <param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pi
 280    /// <param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multipl
 281    /// <param name="userId">User id.</param>
 282    /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi
 283    /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p
 284    /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</
 285    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited.</param>
 286    /// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
 287    /// <param name="enableImages">Optional, include image information in output.</param>
 288    /// <param name="enableTotalRecordCount">Total record count.</param>
 289    /// <response code="200">Album artists returned.</response>
 290    /// <returns>An <see cref="OkResult"/> containing the album artists.</returns>
 291    [HttpGet("AlbumArtists")]
 292    [ProducesResponseType(StatusCodes.Status200OK)]
 293    public ActionResult<QueryResult<BaseItemDto>> GetAlbumArtists(
 294        [FromQuery] double? minCommunityRating,
 295        [FromQuery] int? startIndex,
 296        [FromQuery] int? limit,
 297        [FromQuery] string? searchTerm,
 298        [FromQuery] Guid? parentId,
 299        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
 300        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes,
 301        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] includeItemTypes,
 302        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFilter[] filters,
 303        [FromQuery] bool? isFavorite,
 304        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes,
 305        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] genres,
 306        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] genreIds,
 307        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] officialRatings,
 308        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] tags,
 309        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] int[] years,
 310        [FromQuery] bool? enableUserData,
 311        [FromQuery] int? imageTypeLimit,
 312        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
 313        [FromQuery] string? person,
 314        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] personIds,
 315        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] personTypes,
 316        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] studios,
 317        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] studioIds,
 318        [FromQuery] Guid? userId,
 319        [FromQuery] string? nameStartsWithOrGreater,
 320        [FromQuery] string? nameStartsWith,
 321        [FromQuery] string? nameLessThan,
 322        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy,
 323        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder,
 324        [FromQuery] bool? enableImages = true,
 325        [FromQuery] bool enableTotalRecordCount = true)
 326    {
 0327        userId = RequestHelpers.GetUserId(User, userId);
 0328        var dtoOptions = new DtoOptions { Fields = fields }
 0329            .AddClientFields(User)
 0330            .AddAdditionalDtoOptions(enableImages, enableUserData, imageTypeLimit, enableImageTypes);
 331
 0332        User? user = null;
 0333        BaseItem parentItem = _libraryManager.GetParentItem(parentId, userId);
 334
 0335        if (!userId.IsNullOrEmpty())
 336        {
 0337            user = _userManager.GetUserById(userId.Value);
 338        }
 339
 0340        var query = new InternalItemsQuery(user)
 0341        {
 0342            ExcludeItemTypes = excludeItemTypes,
 0343            IncludeItemTypes = includeItemTypes,
 0344            MediaTypes = mediaTypes,
 0345            StartIndex = startIndex,
 0346            Limit = limit,
 0347            IsFavorite = isFavorite,
 0348            NameLessThan = nameLessThan,
 0349            NameStartsWith = nameStartsWith,
 0350            NameStartsWithOrGreater = nameStartsWithOrGreater,
 0351            Tags = tags,
 0352            OfficialRatings = officialRatings,
 0353            Genres = genres,
 0354            GenreIds = genreIds,
 0355            StudioIds = studioIds,
 0356            Person = person,
 0357            PersonIds = personIds,
 0358            PersonTypes = personTypes,
 0359            Years = years,
 0360            MinCommunityRating = minCommunityRating,
 0361            DtoOptions = dtoOptions,
 0362            SearchTerm = searchTerm,
 0363            EnableTotalRecordCount = enableTotalRecordCount,
 0364            OrderBy = RequestHelpers.GetOrderBy(sortBy, sortOrder)
 0365        };
 366
 0367        if (parentId.HasValue)
 368        {
 0369            if (parentItem is Folder)
 370            {
 0371                query.AncestorIds = new[] { parentId.Value };
 372            }
 373            else
 374            {
 0375                query.ItemIds = new[] { parentId.Value };
 376            }
 377        }
 378
 379        // Studios
 0380        if (studios.Length != 0)
 381        {
 0382            query.StudioIds = studios.Select(i =>
 0383            {
 0384                try
 0385                {
 0386                    return _libraryManager.GetStudio(i);
 0387                }
 0388                catch
 0389                {
 0390                    return null;
 0391                }
 0392            }).Where(i => i is not null).Select(i => i!.Id).ToArray();
 393        }
 394
 0395        foreach (var filter in filters)
 396        {
 397            switch (filter)
 398            {
 399                case ItemFilter.Dislikes:
 0400                    query.IsLiked = false;
 0401                    break;
 402                case ItemFilter.IsFavorite:
 0403                    query.IsFavorite = true;
 0404                    break;
 405                case ItemFilter.IsFavoriteOrLikes:
 0406                    query.IsFavoriteOrLiked = true;
 0407                    break;
 408                case ItemFilter.IsFolder:
 0409                    query.IsFolder = true;
 0410                    break;
 411                case ItemFilter.IsNotFolder:
 0412                    query.IsFolder = false;
 0413                    break;
 414                case ItemFilter.IsPlayed:
 0415                    query.IsPlayed = true;
 0416                    break;
 417                case ItemFilter.IsResumable:
 0418                    query.IsResumable = true;
 0419                    break;
 420                case ItemFilter.IsUnplayed:
 0421                    query.IsPlayed = false;
 0422                    break;
 423                case ItemFilter.Likes:
 0424                    query.IsLiked = true;
 425                    break;
 426            }
 427        }
 428
 0429        var result = _libraryManager.GetAlbumArtists(query);
 430
 0431        var dtos = result.Items.Select(i =>
 0432        {
 0433            var (baseItem, itemCounts) = i;
 0434            var dto = _dtoService.GetItemByNameDto(baseItem, dtoOptions, null, user);
 0435
 0436            if (includeItemTypes.Length != 0)
 0437            {
 0438                dto.ChildCount = itemCounts.ItemCount;
 0439                dto.ProgramCount = itemCounts.ProgramCount;
 0440                dto.SeriesCount = itemCounts.SeriesCount;
 0441                dto.EpisodeCount = itemCounts.EpisodeCount;
 0442                dto.MovieCount = itemCounts.MovieCount;
 0443                dto.TrailerCount = itemCounts.TrailerCount;
 0444                dto.AlbumCount = itemCounts.AlbumCount;
 0445                dto.SongCount = itemCounts.SongCount;
 0446                dto.ArtistCount = itemCounts.ArtistCount;
 0447            }
 0448
 0449            return dto;
 0450        });
 451
 0452        return new QueryResult<BaseItemDto>(
 0453            query.StartIndex,
 0454            result.TotalRecordCount,
 0455            dtos.ToArray());
 456    }
 457
 458    /// <summary>
 459    /// Gets an artist by name.
 460    /// </summary>
 461    /// <param name="name">Studio name.</param>
 462    /// <param name="userId">Optional. Filter by user id, and attach user data.</param>
 463    /// <response code="200">Artist returned.</response>
 464    /// <returns>An <see cref="OkResult"/> containing the artist.</returns>
 465    [HttpGet("{name}")]
 466    [ProducesResponseType(StatusCodes.Status200OK)]
 467    public ActionResult<BaseItemDto> GetArtistByName([FromRoute, Required] string name, [FromQuery] Guid? userId)
 468    {
 0469        userId = RequestHelpers.GetUserId(User, userId);
 0470        var dtoOptions = new DtoOptions().AddClientFields(User);
 471
 0472        var item = _libraryManager.GetArtist(name, dtoOptions);
 473
 0474        if (!userId.IsNullOrEmpty())
 475        {
 0476            var user = _userManager.GetUserById(userId.Value);
 477
 0478            return _dtoService.GetBaseItemDto(item, dtoOptions, user);
 479        }
 480
 0481        return _dtoService.GetBaseItemDto(item, dtoOptions);
 482    }
 483}
Generated by: ReportGenerator 5.4.5.0
4/26/2025 - 12:10:58 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Dto.IDtoService)
GetArtists(System.Nullable`1<System.Double>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.String,System.Nullable`1<System.Guid>,MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable`1<System.Boolean>,Jellyfin.Data.Enums.MediaType[],System.String[],System.Guid[],System.String[],System.String[],System.Int32[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Int32>,MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.Guid[],System.Nullable`1<System.Guid>,System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable`1<System.Boolean>,System.Boolean)
GetAlbumArtists(System.Nullable`1<System.Double>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.String,System.Nullable`1<System.Guid>,MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable`1<System.Boolean>,Jellyfin.Data.Enums.MediaType[],System.String[],System.Guid[],System.String[],System.String[],System.Int32[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Int32>,MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.Guid[],System.Nullable`1<System.Guid>,System.String,System.String,System.String,Jellyfin.Data.Enums.ItemSortBy[],Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable`1<System.Boolean>,System.Boolean)
GetArtistByName(System.String,System.Nullable`1<System.Guid>)