jellyfin/MediaBrowser.Model/Querying/LatestItemsQuery.cs

83 lines
2.7 KiB
C#
Raw Normal View History

#nullable disable
2020-02-03 17:49:27 -07:00
#pragma warning disable CS1591
using System;
2018-12-27 16:27:57 -07:00
using MediaBrowser.Model.Entities;
namespace MediaBrowser.Model.Querying
{
public class LatestItemsQuery
{
public LatestItemsQuery()
{
EnableImageTypes = Array.Empty<ImageType>();
}
2018-12-27 16:27:57 -07:00
/// <summary>
/// The user to localize search results for.
2018-12-27 16:27:57 -07:00
/// </summary>
/// <value>The user id.</value>
public Guid UserId { get; set; }
/// <summary>
/// Specify this to localize the search to a specific item or folder. Omit to use the root.
/// </summary>
/// <value>The parent id.</value>
public Guid ParentId { get; set; }
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
/// <value>The start index.</value>
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return.
2018-12-27 16:27:57 -07:00
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }
/// <summary>
/// Fields to return within the items, in addition to basic information.
2018-12-27 16:27:57 -07:00
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { 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 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; }
/// <summary>
/// Gets or sets a value indicating whether [group items].
/// </summary>
/// <value><c>true</c> if [group items]; otherwise, <c>false</c>.</value>
public bool GroupItems { get; set; }
2018-12-27 16:27:57 -07: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; }
2018-12-27 16:27:57 -07:00
/// <summary>
/// Gets or sets the image type limit.
/// </summary>
/// <value>The image type limit.</value>
public int? ImageTypeLimit { get; set; }
2018-12-27 16:27:57 -07:00
/// <summary>
/// Gets or sets the enable image types.
/// </summary>
/// <value>The enable image types.</value>
public ImageType[] EnableImageTypes { get; set; }
}
}