jellyfin-server/MediaBrowser.Model/LiveTv/ProgramQuery.cs

124 lines
4.2 KiB
C#
Raw Normal View History

2015-03-14 20:00:32 +00:00
using MediaBrowser.Model.Entities;
using System;
2015-08-02 17:02:23 +00:00
using MediaBrowser.Model.Querying;
2014-01-06 01:59:21 +00:00
namespace MediaBrowser.Model.LiveTv
2013-11-25 16:15:31 +00:00
{
/// <summary>
/// Class ProgramQuery.
/// </summary>
public class ProgramQuery
{
2015-03-14 20:00:32 +00:00
public ProgramQuery()
{
ChannelIds = new string[] { };
SortBy = new string[] { };
Genres = new string[] { };
2016-05-09 03:13:38 +00:00
EnableTotalRecordCount = true;
2016-08-17 19:28:43 +00:00
EnableUserData = true;
2015-03-14 20:00:32 +00:00
}
2016-05-09 03:13:38 +00:00
public bool EnableTotalRecordCount { get; set; }
2016-08-17 19:28:43 +00:00
public bool EnableUserData { get; set; }
2016-05-09 03:13:38 +00:00
2015-08-02 17:02:23 +00:00
/// <summary>
/// Fields to return within the items, in addition to basic information
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { get; set; }
public bool? EnableImages { get; set; }
public int? ImageTypeLimit { get; set; }
public ImageType[] EnableImageTypes { get; set; }
2013-11-25 16:15:31 +00:00
/// <summary>
2015-03-14 20:00:32 +00:00
/// Gets or sets the channel ids.
2013-11-25 16:15:31 +00:00
/// </summary>
2015-03-14 20:00:32 +00:00
/// <value>The channel ids.</value>
public string[] ChannelIds { get; set; }
2013-11-25 16:15:31 +00:00
2013-11-26 02:53:48 +00:00
/// <summary>
/// Gets or sets the user identifier.
/// </summary>
/// <value>The user identifier.</value>
public string UserId { get; set; }
2016-10-01 07:06:00 +00:00
public string SeriesTimerId { get; set; }
2013-11-26 02:53:48 +00:00
2015-03-14 20:00:32 +00:00
/// <summary>
/// The earliest date for which a program starts to return
/// </summary>
2014-01-06 01:59:21 +00:00
public DateTime? MinStartDate { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// The latest date for which a program starts to return
/// </summary>
2014-01-06 01:59:21 +00:00
public DateTime? MaxStartDate { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// The earliest date for which a program ends to return
/// </summary>
2014-01-06 01:59:21 +00:00
public DateTime? MinEndDate { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// The latest date for which a program ends to return
/// </summary>
2014-01-06 01:59:21 +00:00
public DateTime? MaxEndDate { get; set; }
2015-03-07 03:53:31 +00:00
2016-09-29 12:55:49 +00:00
/// <summary>
/// Used to specific whether to return news or not
/// </summary>
/// <remarks>If set to null, all programs will be returned</remarks>
public bool? IsNews { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// Used to specific whether to return movies or not
/// </summary>
/// <remarks>If set to null, all programs will be returned</remarks>
public bool? IsMovie { get; set; }
2015-08-04 14:26:36 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance is kids.
/// </summary>
/// <value><c>null</c> if [is kids] contains no value, <c>true</c> if [is kids]; otherwise, <c>false</c>.</value>
public bool? IsKids { get; set; }
2015-04-03 16:31:56 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance is sports.
/// </summary>
/// <value><c>null</c> if [is sports] contains no value, <c>true</c> if [is sports]; otherwise, <c>false</c>.</value>
public bool? IsSports { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
public int? StartIndex { get; set; }
2016-09-29 12:55:49 +00:00
public bool? IsSeries { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// Gets or sets a value indicating whether this instance has aired.
/// </summary>
/// <value><c>null</c> if [has aired] contains no value, <c>true</c> if [has aired]; otherwise, <c>false</c>.</value>
2015-03-07 03:53:31 +00:00
public bool? HasAired { get; set; }
2015-03-14 20:00:32 +00:00
/// <summary>
/// The maximum number of items to return
/// </summary>
public int? Limit { get; set; }
/// <summary>
/// What to sort the results by
/// </summary>
/// <value>The sort by.</value>
public string[] SortBy { get; set; }
/// <summary>
/// The sort order to return results with
/// </summary>
/// <value>The sort order.</value>
public SortOrder? SortOrder { get; set; }
/// <summary>
/// Limit results to items containing specific genres
/// </summary>
/// <value>The genres.</value>
public string[] Genres { get; set; }
2013-11-25 16:15:31 +00:00
}
2015-03-14 20:00:32 +00:00
}