jellyfin/MediaBrowser.Controller/Dto/IDtoService.cs

74 lines
2.5 KiB
C#
Raw Normal View History

2013-09-04 17:02:19 +00:00
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Dto;
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Querying;
2014-08-15 16:35:41 +00:00
using System;
2013-09-04 17:02:19 +00:00
using System.Collections.Generic;
namespace MediaBrowser.Controller.Dto
{
/// <summary>
/// Interface IDtoService
/// </summary>
public interface IDtoService
{
/// <summary>
/// Gets the user dto.
/// </summary>
/// <param name="user">The user.</param>
2013-09-17 02:44:06 +00:00
/// <returns>UserDto.</returns>
2014-08-15 16:35:41 +00:00
[Obsolete]
2013-09-17 02:44:06 +00:00
UserDto GetUserDto(User user);
2013-09-04 17:02:19 +00:00
/// <summary>
/// Gets the dto id.
/// </summary>
/// <param name="item">The item.</param>
/// <returns>System.String.</returns>
string GetDtoId(BaseItem item);
2014-01-14 20:03:35 +00:00
/// <summary>
/// Attaches the primary image aspect ratio.
/// </summary>
/// <param name="dto">The dto.</param>
/// <param name="item">The item.</param>
void AttachPrimaryImageAspectRatio(IItemDto dto, IHasImages item);
2013-09-04 17:02:19 +00:00
/// <summary>
/// Gets the base item dto.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="fields">The fields.</param>
/// <param name="user">The user.</param>
/// <param name="owner">The owner.</param>
/// <returns>Task{BaseItemDto}.</returns>
2013-09-17 02:44:06 +00:00
BaseItemDto GetBaseItemDto(BaseItem item, List<ItemFields> fields, User user = null, BaseItem owner = null);
2014-03-19 04:59:45 +00:00
/// <summary>
/// Gets the chapter information dto.
/// </summary>
/// <param name="chapterInfo">The chapter information.</param>
/// <param name="item">The item.</param>
/// <returns>ChapterInfoDto.</returns>
ChapterInfoDto GetChapterInfoDto(ChapterInfo chapterInfo, BaseItem item);
2014-07-08 01:41:03 +00:00
/// <summary>
/// Gets the user item data dto.
/// </summary>
/// <param name="data">The data.</param>
/// <returns>UserItemDataDto.</returns>
UserItemDataDto GetUserItemDataDto(UserItemData data);
/// <summary>
/// Gets the item by name dto.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="fields">The fields.</param>
/// <param name="taggedItems">The tagged items.</param>
/// <param name="user">The user.</param>
/// <returns>BaseItemDto.</returns>
BaseItemDto GetItemByNameDto<T>(T item, List<ItemFields> fields, List<BaseItem> taggedItems, User user = null)
where T : BaseItem, IItemByName;
2013-09-04 17:02:19 +00:00
}
}