aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Dto
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Controller/Dto')
-rw-r--r--MediaBrowser.Controller/Dto/DtoOptions.cs72
-rw-r--r--MediaBrowser.Controller/Dto/IDtoService.cs70
2 files changed, 142 insertions, 0 deletions
diff --git a/MediaBrowser.Controller/Dto/DtoOptions.cs b/MediaBrowser.Controller/Dto/DtoOptions.cs
new file mode 100644
index 000000000..b5ce09028
--- /dev/null
+++ b/MediaBrowser.Controller/Dto/DtoOptions.cs
@@ -0,0 +1,72 @@
+using MediaBrowser.Model.Entities;
+using MediaBrowser.Model.Querying;
+using System;
+using System.Linq;
+
+namespace MediaBrowser.Controller.Dto
+{
+ public class DtoOptions
+ {
+ private static readonly ItemFields[] DefaultExcludedFields = new []
+ {
+ ItemFields.SeasonUserData,
+ ItemFields.RefreshState
+ };
+
+ public ItemFields[] Fields { get; set; }
+ public ImageType[] ImageTypes { get; set; }
+ public int ImageTypeLimit { get; set; }
+ public bool EnableImages { get; set; }
+ public bool AddProgramRecordingInfo { get; set; }
+ public bool EnableUserData { get; set; }
+ public bool AddCurrentProgram { get; set; }
+
+ public DtoOptions()
+ : this(true)
+ {
+ }
+
+ private static readonly ImageType[] AllImageTypes = Enum.GetNames(typeof(ImageType))
+ .Select(i => (ImageType)Enum.Parse(typeof(ImageType), i, true))
+ .ToArray();
+
+ private static readonly ItemFields[] AllItemFields = Enum.GetNames(typeof(ItemFields))
+ .Select(i => (ItemFields)Enum.Parse(typeof(ItemFields), i, true))
+ .Except(DefaultExcludedFields)
+ .ToArray();
+
+ public bool ContainsField(ItemFields field)
+ {
+ return AllItemFields.Contains(field);
+ }
+
+ public DtoOptions(bool allFields)
+ {
+ ImageTypeLimit = int.MaxValue;
+ EnableImages = true;
+ EnableUserData = true;
+ AddCurrentProgram = true;
+
+ if (allFields)
+ {
+ Fields = AllItemFields;
+ }
+ else
+ {
+ Fields = new ItemFields[] { };
+ }
+
+ ImageTypes = AllImageTypes;
+ }
+
+ public int GetImageLimit(ImageType type)
+ {
+ if (EnableImages && ImageTypes.Contains(type))
+ {
+ return ImageTypeLimit;
+ }
+
+ return 0;
+ }
+ }
+}
diff --git a/MediaBrowser.Controller/Dto/IDtoService.cs b/MediaBrowser.Controller/Dto/IDtoService.cs
new file mode 100644
index 000000000..219b36789
--- /dev/null
+++ b/MediaBrowser.Controller/Dto/IDtoService.cs
@@ -0,0 +1,70 @@
+using MediaBrowser.Controller.Entities;
+using MediaBrowser.Model.Dto;
+using MediaBrowser.Model.Querying;
+using System.Collections.Generic;
+using MediaBrowser.Controller.Sync;
+
+namespace MediaBrowser.Controller.Dto
+{
+ /// <summary>
+ /// Interface IDtoService
+ /// </summary>
+ public interface IDtoService
+ {
+ /// <summary>
+ /// Gets the dto id.
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <returns>System.String.</returns>
+ string GetDtoId(BaseItem item);
+
+ /// <summary>
+ /// Attaches the primary image aspect ratio.
+ /// </summary>
+ /// <param name="dto">The dto.</param>
+ /// <param name="item">The item.</param>
+ void AttachPrimaryImageAspectRatio(IItemDto dto, BaseItem item);
+
+ /// <summary>
+ /// Gets the primary image aspect ratio.
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <returns>System.Nullable&lt;System.Double&gt;.</returns>
+ double? GetPrimaryImageAspectRatio(BaseItem item);
+
+ /// <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>
+ BaseItemDto GetBaseItemDto(BaseItem item, ItemFields[] fields, User user = null, BaseItem owner = null);
+
+ /// <summary>
+ /// Gets the base item dto.
+ /// </summary>
+ /// <param name="item">The item.</param>
+ /// <param name="options">The options.</param>
+ /// <param name="user">The user.</param>
+ /// <param name="owner">The owner.</param>
+ /// <returns>BaseItemDto.</returns>
+ BaseItemDto GetBaseItemDto(BaseItem item, DtoOptions options, User user = null, BaseItem owner = null);
+
+ /// <summary>
+ /// Gets the base item dtos.
+ /// </summary>
+ /// <param name="items">The items.</param>
+ /// <param name="options">The options.</param>
+ /// <param name="user">The user.</param>
+ /// <param name="owner">The owner.</param>
+ BaseItemDto[] GetBaseItemDtos(BaseItem[] items, DtoOptions options, User user = null, BaseItem owner = null);
+
+ BaseItemDto[] GetBaseItemDtos(List<BaseItem> items, DtoOptions options, User user = null, BaseItem owner = null);
+
+ /// <summary>
+ /// Gets the item by name dto.
+ /// </summary>
+ BaseItemDto GetItemByNameDto(BaseItem item, DtoOptions options, List<BaseItem> taggedItems, User user = null);
+ }
+}