BaseItemsRequest.cs 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  1. using MediaBrowser.Model.Entities;
  2. using MediaBrowser.Model.Querying;
  3. using ServiceStack;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Linq;
  7. namespace MediaBrowser.Api.UserLibrary
  8. {
  9. public abstract class BaseItemsRequest : IHasDtoOptions
  10. {
  11. protected BaseItemsRequest()
  12. {
  13. EnableImages = true;
  14. EnableTotalRecordCount = true;
  15. }
  16. /// <summary>
  17. /// Gets or sets the max offical rating.
  18. /// </summary>
  19. /// <value>The max offical rating.</value>
  20. [ApiMember(Name = "MaxOfficialRating", Description = "Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  21. public string MaxOfficialRating { get; set; }
  22. [ApiMember(Name = "HasThemeSong", Description = "Optional filter by items with theme songs.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  23. public bool? HasThemeSong { get; set; }
  24. [ApiMember(Name = "HasThemeVideo", Description = "Optional filter by items with theme videos.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  25. public bool? HasThemeVideo { get; set; }
  26. [ApiMember(Name = "HasSubtitles", Description = "Optional filter by items with subtitles.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  27. public bool? HasSubtitles { get; set; }
  28. [ApiMember(Name = "HasSpecialFeature", Description = "Optional filter by items with special features.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  29. public bool? HasSpecialFeature { get; set; }
  30. [ApiMember(Name = "HasTrailer", Description = "Optional filter by items with trailers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  31. public bool? HasTrailer { get; set; }
  32. [ApiMember(Name = "AdjacentTo", Description = "Optional. Return items that are siblings of a supplied item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  33. public string AdjacentTo { get; set; }
  34. [ApiMember(Name = "MinIndexNumber", Description = "Optional filter by minimum index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  35. public int? MinIndexNumber { get; set; }
  36. [ApiMember(Name = "MinPlayers", Description = "Optional filter by minimum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  37. public int? MinPlayers { get; set; }
  38. [ApiMember(Name = "MaxPlayers", Description = "Optional filter by maximum number of game players.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  39. public int? MaxPlayers { get; set; }
  40. [ApiMember(Name = "ParentIndexNumber", Description = "Optional filter by parent index number.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  41. public int? ParentIndexNumber { get; set; }
  42. [ApiMember(Name = "HasParentalRating", Description = "Optional filter by items that have or do not have a parental rating", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  43. public bool? HasParentalRating { get; set; }
  44. [ApiMember(Name = "IsHD", Description = "Optional filter by items that are HD or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  45. public bool? IsHD { get; set; }
  46. [ApiMember(Name = "LocationTypes", Description = "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  47. public string LocationTypes { get; set; }
  48. [ApiMember(Name = "ExcludeLocationTypes", Description = "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  49. public string ExcludeLocationTypes { get; set; }
  50. [ApiMember(Name = "IsMissing", Description = "Optional filter by items that are missing episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  51. public bool? IsMissing { get; set; }
  52. [ApiMember(Name = "IsUnaired", Description = "Optional filter by items that are unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  53. public bool? IsUnaired { get; set; }
  54. [ApiMember(Name = "IsVirtualUnaired", Description = "Optional filter by items that are virtual unaired episodes or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  55. public bool? IsVirtualUnaired { get; set; }
  56. [ApiMember(Name = "MinCommunityRating", Description = "Optional filter by minimum community rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  57. public double? MinCommunityRating { get; set; }
  58. [ApiMember(Name = "MinCriticRating", Description = "Optional filter by minimum critic rating.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  59. public double? MinCriticRating { get; set; }
  60. [ApiMember(Name = "AiredDuringSeason", Description = "Gets all episodes that aired during a season, including specials.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  61. public int? AiredDuringSeason { get; set; }
  62. [ApiMember(Name = "MinPremiereDate", Description = "Optional. The minimum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  63. public string MinPremiereDate { get; set; }
  64. [ApiMember(Name = "MaxPremiereDate", Description = "Optional. The maximum premiere date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
  65. public string MaxPremiereDate { get; set; }
  66. [ApiMember(Name = "HasOverview", Description = "Optional filter by items that have an overview or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  67. public bool? HasOverview { get; set; }
  68. [ApiMember(Name = "HasImdbId", Description = "Optional filter by items that have an imdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  69. public bool? HasImdbId { get; set; }
  70. [ApiMember(Name = "HasTmdbId", Description = "Optional filter by items that have a tmdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  71. public bool? HasTmdbId { get; set; }
  72. [ApiMember(Name = "HasTvdbId", Description = "Optional filter by items that have a tvdb id or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  73. public bool? HasTvdbId { get; set; }
  74. [ApiMember(Name = "IsInBoxSet", Description = "Optional filter by items that are in boxsets, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  75. public bool? IsInBoxSet { get; set; }
  76. public string ExcludeItemIds { get; set; }
  77. public bool EnableTotalRecordCount { get; set; }
  78. /// <summary>
  79. /// Skips over a given number of items within the results. Use for paging.
  80. /// </summary>
  81. /// <value>The start index.</value>
  82. [ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  83. public int? StartIndex { get; set; }
  84. /// <summary>
  85. /// The maximum number of items to return
  86. /// </summary>
  87. /// <value>The limit.</value>
  88. [ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  89. public int? Limit { get; set; }
  90. /// <summary>
  91. /// Whether or not to perform the query recursively
  92. /// </summary>
  93. /// <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
  94. [ApiMember(Name = "Recursive", Description = "When searching within folders, this determines whether or not the search will be recursive. true/false", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  95. public bool Recursive { get; set; }
  96. /// <summary>
  97. /// Gets or sets the sort order.
  98. /// </summary>
  99. /// <value>The sort order.</value>
  100. [ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  101. public SortOrder? SortOrder { get; set; }
  102. /// <summary>
  103. /// Specify this to localize the search to a specific item or folder. Omit to use the root.
  104. /// </summary>
  105. /// <value>The parent id.</value>
  106. [ApiMember(Name = "ParentId", Description = "Specify this to localize the search to a specific item or folder. Omit to use the root", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  107. public string ParentId { get; set; }
  108. /// <summary>
  109. /// Fields to return within the items, in addition to basic information
  110. /// </summary>
  111. /// <value>The fields.</value>
  112. [ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, CriticRatingSummary, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  113. public string Fields { get; set; }
  114. /// <summary>
  115. /// Gets or sets the exclude item types.
  116. /// </summary>
  117. /// <value>The exclude item types.</value>
  118. [ApiMember(Name = "ExcludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  119. public string ExcludeItemTypes { get; set; }
  120. /// <summary>
  121. /// Gets or sets the include item types.
  122. /// </summary>
  123. /// <value>The include item types.</value>
  124. [ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  125. public string IncludeItemTypes { get; set; }
  126. /// <summary>
  127. /// Filters to apply to the results
  128. /// </summary>
  129. /// <value>The filters.</value>
  130. [ApiMember(Name = "Filters", Description = "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  131. public string Filters { get; set; }
  132. /// <summary>
  133. /// Gets or sets the Isfavorite option
  134. /// </summary>
  135. /// <value>IsFavorite</value>
  136. [ApiMember(Name = "IsFavorite", Description = "Optional filter by items that are marked as favorite, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  137. public bool? IsFavorite { get; set; }
  138. /// <summary>
  139. /// Gets or sets the media types.
  140. /// </summary>
  141. /// <value>The media types.</value>
  142. [ApiMember(Name = "MediaTypes", Description = "Optional filter by MediaType. Allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  143. public string MediaTypes { get; set; }
  144. /// <summary>
  145. /// Gets or sets the image types.
  146. /// </summary>
  147. /// <value>The image types.</value>
  148. [ApiMember(Name = "ImageTypes", Description = "Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  149. public string ImageTypes { get; set; }
  150. /// <summary>
  151. /// What to sort the results by
  152. /// </summary>
  153. /// <value>The sort by.</value>
  154. [ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  155. public string SortBy { get; set; }
  156. [ApiMember(Name = "IsPlayed", Description = "Optional filter by items that are played, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  157. public bool? IsPlayed { get; set; }
  158. /// <summary>
  159. /// Limit results to items containing specific genres
  160. /// </summary>
  161. /// <value>The genres.</value>
  162. [ApiMember(Name = "Genres", Description = "Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  163. public string Genres { get; set; }
  164. public string GenreIds { get; set; }
  165. [ApiMember(Name = "OfficialRatings", Description = "Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  166. public string OfficialRatings { get; set; }
  167. [ApiMember(Name = "Tags", Description = "Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  168. public string Tags { get; set; }
  169. /// <summary>
  170. /// Limit results to items containing specific years
  171. /// </summary>
  172. /// <value>The years.</value>
  173. [ApiMember(Name = "Years", Description = "Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  174. public string Years { get; set; }
  175. [ApiMember(Name = "EnableImages", Description = "Optional, include image information in output", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  176. public bool? EnableImages { get; set; }
  177. [ApiMember(Name = "EnableUserData", Description = "Optional, include user data", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
  178. public bool? EnableUserData { get; set; }
  179. [ApiMember(Name = "ImageTypeLimit", Description = "Optional, the max number of images to return, per image type", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
  180. public int? ImageTypeLimit { get; set; }
  181. [ApiMember(Name = "EnableImageTypes", Description = "Optional. The image types to include in the output.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  182. public string EnableImageTypes { get; set; }
  183. /// <summary>
  184. /// Limit results to items containing a specific person
  185. /// </summary>
  186. /// <value>The person.</value>
  187. [ApiMember(Name = "Person", Description = "Optional. If specified, results will be filtered to include only those containing the specified person.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  188. public string Person { get; set; }
  189. [ApiMember(Name = "PersonIds", Description = "Optional. If specified, results will be filtered to include only those containing the specified person.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  190. public string PersonIds { get; set; }
  191. /// <summary>
  192. /// If the Person filter is used, this can also be used to restrict to a specific person type
  193. /// </summary>
  194. /// <value>The type of the person.</value>
  195. [ApiMember(Name = "PersonTypes", Description = "Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  196. public string PersonTypes { get; set; }
  197. /// <summary>
  198. /// Limit results to items containing specific studios
  199. /// </summary>
  200. /// <value>The studios.</value>
  201. [ApiMember(Name = "Studios", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  202. public string Studios { get; set; }
  203. [ApiMember(Name = "StudioIds", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  204. public string StudioIds { get; set; }
  205. /// <summary>
  206. /// Gets or sets the studios.
  207. /// </summary>
  208. /// <value>The studios.</value>
  209. [ApiMember(Name = "Artists", Description = "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  210. public string Artists { get; set; }
  211. public string ExcludeArtistIds { get; set; }
  212. [ApiMember(Name = "ArtistIds", Description = "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  213. public string ArtistIds { get; set; }
  214. [ApiMember(Name = "Albums", Description = "Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  215. public string Albums { get; set; }
  216. /// <summary>
  217. /// Gets or sets the item ids.
  218. /// </summary>
  219. /// <value>The item ids.</value>
  220. [ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  221. public string Ids { get; set; }
  222. /// <summary>
  223. /// Gets or sets the video types.
  224. /// </summary>
  225. /// <value>The video types.</value>
  226. [ApiMember(Name = "VideoTypes", Description = "Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  227. public string VideoTypes { get; set; }
  228. /// <summary>
  229. /// Gets or sets the air days.
  230. /// </summary>
  231. /// <value>The air days.</value>
  232. [ApiMember(Name = "AirDays", Description = "Optional filter by Series Air Days. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  233. public string AirDays { get; set; }
  234. /// <summary>
  235. /// Gets or sets the user id.
  236. /// </summary>
  237. /// <value>The user id.</value>
  238. [ApiMember(Name = "UserId", Description = "User Id", IsRequired = false, DataType = "string", ParameterType = "path", Verb = "GET")]
  239. public string UserId { get; set; }
  240. /// <summary>
  241. /// Gets or sets the min offical rating.
  242. /// </summary>
  243. /// <value>The min offical rating.</value>
  244. [ApiMember(Name = "MinOfficialRating", Description = "Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  245. public string MinOfficialRating { get; set; }
  246. [ApiMember(Name = "IsLocked", Description = "Optional filter by items that are locked.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  247. public bool? IsLocked { get; set; }
  248. [ApiMember(Name = "IsPlaceHolder", Description = "Optional filter by items that are placeholders", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  249. public bool? IsPlaceHolder { get; set; }
  250. [ApiMember(Name = "HasOfficialRating", Description = "Optional filter by items that have official ratings", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  251. public bool? HasOfficialRating { get; set; }
  252. [ApiMember(Name = "CollapseBoxSetItems", Description = "Whether or not to hide items behind their boxsets.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  253. public bool? CollapseBoxSetItems { get; set; }
  254. /// <summary>
  255. /// Gets or sets the video formats.
  256. /// </summary>
  257. /// <value>The video formats.</value>
  258. [ApiMember(Name = "Is3D", Description = "Optional filter by items that are 3D, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
  259. public bool? Is3D { get; set; }
  260. /// <summary>
  261. /// Gets or sets the series status.
  262. /// </summary>
  263. /// <value>The series status.</value>
  264. [ApiMember(Name = "SeriesStatus", Description = "Optional filter by Series Status. Allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
  265. public string SeriesStatus { get; set; }
  266. [ApiMember(Name = "NameStartsWithOrGreater", Description = "Optional filter by items whose name is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  267. public string NameStartsWithOrGreater { get; set; }
  268. [ApiMember(Name = "NameStartsWith", Description = "Optional filter by items whose name is sorted equally than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  269. public string NameStartsWith { get; set; }
  270. [ApiMember(Name = "NameLessThan", Description = "Optional filter by items whose name is equally or lesser than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  271. public string NameLessThan { get; set; }
  272. [ApiMember(Name = "AlbumArtistStartsWithOrGreater", Description = "Optional filter by items whose album artist is sorted equally or greater than a given input string.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
  273. public string AlbumArtistStartsWithOrGreater { get; set; }
  274. public string[] GetGenres()
  275. {
  276. return (Genres ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  277. }
  278. public string[] GetTags()
  279. {
  280. return (Tags ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  281. }
  282. public string[] GetOfficialRatings()
  283. {
  284. return (OfficialRatings ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  285. }
  286. public string[] GetMediaTypes()
  287. {
  288. return (MediaTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  289. }
  290. public string[] GetIncludeItemTypes()
  291. {
  292. return (IncludeItemTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  293. }
  294. public string[] GetExcludeItemIds()
  295. {
  296. return (ExcludeItemIds ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  297. }
  298. public string[] GetExcludeItemTypes()
  299. {
  300. return (ExcludeItemTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  301. }
  302. public int[] GetYears()
  303. {
  304. return (Years ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(int.Parse).ToArray();
  305. }
  306. public string[] GetStudios()
  307. {
  308. return (Studios ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  309. }
  310. public string[] GetStudioIds()
  311. {
  312. return (StudioIds ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  313. }
  314. public string[] GetGenreIds()
  315. {
  316. return (GenreIds ?? string.Empty).Split(new[] { '|' }, StringSplitOptions.RemoveEmptyEntries);
  317. }
  318. public string[] GetPersonTypes()
  319. {
  320. return (PersonTypes ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  321. }
  322. public string[] GetPersonIds()
  323. {
  324. return (PersonIds ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  325. }
  326. public string[] GetItemIds()
  327. {
  328. return (Ids ?? string.Empty).Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
  329. }
  330. public VideoType[] GetVideoTypes()
  331. {
  332. var val = VideoTypes;
  333. if (string.IsNullOrEmpty(val))
  334. {
  335. return new VideoType[] { };
  336. }
  337. return val.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(v => (VideoType)Enum.Parse(typeof(VideoType), v, true)).ToArray();
  338. }
  339. /// <summary>
  340. /// Gets the filters.
  341. /// </summary>
  342. /// <returns>IEnumerable{ItemFilter}.</returns>
  343. public IEnumerable<ItemFilter> GetFilters()
  344. {
  345. var val = Filters;
  346. if (string.IsNullOrEmpty(val))
  347. {
  348. return new ItemFilter[] { };
  349. }
  350. return val.Split(',').Select(v => (ItemFilter)Enum.Parse(typeof(ItemFilter), v, true));
  351. }
  352. /// <summary>
  353. /// Gets the image types.
  354. /// </summary>
  355. /// <returns>IEnumerable{ImageType}.</returns>
  356. public IEnumerable<ImageType> GetImageTypes()
  357. {
  358. var val = ImageTypes;
  359. if (string.IsNullOrEmpty(val))
  360. {
  361. return new ImageType[] { };
  362. }
  363. return val.Split(',').Select(v => (ImageType)Enum.Parse(typeof(ImageType), v, true));
  364. }
  365. /// <summary>
  366. /// Gets the order by.
  367. /// </summary>
  368. /// <returns>IEnumerable{ItemSortBy}.</returns>
  369. public string[] GetOrderBy()
  370. {
  371. var val = SortBy;
  372. if (string.IsNullOrEmpty(val))
  373. {
  374. return new string[] { };
  375. }
  376. return val.Split(',');
  377. }
  378. }
  379. }