jellyfin-server/MediaBrowser.Model/Querying/ItemsByNameQuery.cs

137 lines
4.7 KiB
C#
Raw Normal View History

2013-03-11 05:06:55 +00:00
using MediaBrowser.Model.Entities;
2013-03-02 07:16:52 +00:00
2013-03-10 05:36:39 +00:00
namespace MediaBrowser.Model.Querying
2013-03-02 07:16:52 +00:00
{
/// <summary>
/// Class ItemsByNameQuery
/// </summary>
public class ItemsByNameQuery
{
/// <summary>
/// Gets or sets the user id.
/// </summary>
/// <value>The user id.</value>
public string UserId { get; set; }
2013-03-02 07:16:52 +00:00
/// <summary>
/// Gets or sets the start index.
/// </summary>
/// <value>The start index.</value>
public int? StartIndex { get; set; }
/// <summary>
/// Gets or sets the size of the page.
/// </summary>
/// <value>The size of the page.</value>
public int? Limit { get; set; }
2013-03-02 07:16:52 +00:00
/// <summary>
2013-04-21 01:17:59 +00:00
/// Gets or sets a value indicating whether this <see cref="ItemsByNameQuery" /> is recursive.
2013-03-02 07:16:52 +00:00
/// </summary>
/// <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
public bool Recursive { get; set; }
/// <summary>
/// Gets or sets the sort order.
/// </summary>
/// <value>The sort order.</value>
public SortOrder? SortOrder { get; set; }
/// <summary>
2013-03-11 05:06:55 +00:00
/// Gets or sets the parent id.
2013-03-02 07:16:52 +00:00
/// </summary>
2013-03-11 05:06:55 +00:00
/// <value>The parent id.</value>
public string ParentId { get; set; }
2013-03-02 07:16:52 +00:00
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { get; set; }
2013-04-21 01:17:59 +00:00
2013-10-21 01:51:57 +00:00
/// <summary>
/// Gets or sets the filters.
/// </summary>
/// <value>The filters.</value>
public ItemFilter[] Filters { get; set; }
2013-04-24 22:34:38 +00:00
/// <summary>
/// Gets or sets the exclude item types.
/// </summary>
/// <value>The exclude item types.</value>
public string[] ExcludeItemTypes { get; set; }
/// <summary>
/// Gets or sets the include item types.
/// </summary>
/// <value>The include item types.</value>
public string[] IncludeItemTypes { get; set; }
/// <summary>
/// Gets or sets the media types.
/// </summary>
/// <value>The media types.</value>
public string[] MediaTypes { get; set; }
/// <summary>
/// What to sort the results by
/// </summary>
/// <value>The sort by.</value>
public string[] SortBy { get; set; }
2013-10-04 15:22:03 +00:00
/// <summary>
/// Gets or sets the image types.
/// </summary>
/// <value>The image types.</value>
2013-09-07 15:59:47 +00:00
public ImageType[] ImageTypes { get; set; }
2013-04-21 01:17:59 +00:00
/// <summary>
2013-10-04 15:22:03 +00:00
/// Gets or sets the name starts with or greater.
/// </summary>
/// <value>The name starts with or greater.</value>
public string NameStartsWithOrGreater { get; set; }
/// <summary>
2014-03-05 21:46:32 +00:00
/// Gets or sets the name starts with
/// </summary>
/// <value>The name starts with or greater.</value>
public string NameStartsWith { get; set; }
2014-06-23 16:05:19 +00:00
/// <summary>
2013-10-04 15:22:03 +00:00
/// Gets or sets the name less than.
/// </summary>
/// <value>The name less than.</value>
public string NameLessThan { get; set; }
2014-01-19 19:25:29 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance is played.
/// </summary>
/// <value><c>null</c> if [is played] contains no value, <c>true</c> if [is played]; otherwise, <c>false</c>.</value>
public bool? IsPlayed { get; set; }
2014-12-01 12:43:34 +00:00
/// <summary>
/// Gets or sets a value indicating whether [enable images].
/// </summary>
/// <value><c>null</c> if [enable images] contains no value, <c>true</c> if [enable images]; otherwise, <c>false</c>.</value>
public bool? EnableImages { get; set; }
/// <summary>
/// Gets or sets the image type limit.
/// </summary>
/// <value>The image type limit.</value>
public int? ImageTypeLimit { get; set; }
/// <summary>
/// Gets or sets the enable image types.
/// </summary>
/// <value>The enable image types.</value>
2014-12-03 03:13:03 +00:00
public ImageType[] EnableImageTypes { get; set; }
2013-10-04 15:22:03 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="ItemsByNameQuery" /> class.
2013-04-21 01:17:59 +00:00
/// </summary>
public ItemsByNameQuery()
{
2013-09-07 15:59:47 +00:00
ImageTypes = new ImageType[] { };
2013-10-21 01:51:57 +00:00
Filters = new ItemFilter[] { };
2013-09-07 15:59:47 +00:00
Fields = new ItemFields[] { };
2013-04-24 22:34:38 +00:00
Recursive = true;
MediaTypes = new string[] { };
SortBy = new string[] { };
ExcludeItemTypes = new string[] { };
IncludeItemTypes = new string[] { };
2014-12-03 03:13:03 +00:00
EnableImageTypes = new ImageType[] { };
2013-04-21 01:17:59 +00:00
}
2013-03-02 07:16:52 +00:00
}
}