59 lines
3.3 KiB
C#
59 lines
3.3 KiB
C#
using MediaBrowser.Model.Entities;
|
|
using ServiceStack.ServiceHost;
|
|
using System;
|
|
|
|
namespace MediaBrowser.Api.UserLibrary
|
|
{
|
|
public abstract class BaseItemsRequest
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the user id.
|
|
/// </summary>
|
|
/// <value>The user id.</value>
|
|
[ApiMember(Name = "UserId", Description = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
public Guid UserId { get; set; }
|
|
|
|
/// <summary>
|
|
/// Skips over a given number of items within the results. Use for paging.
|
|
/// </summary>
|
|
/// <value>The start index.</value>
|
|
[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")]
|
|
public int? StartIndex { get; set; }
|
|
|
|
/// <summary>
|
|
/// The maximum number of items to return
|
|
/// </summary>
|
|
/// <value>The limit.</value>
|
|
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? Limit { get; set; }
|
|
|
|
/// <summary>
|
|
/// Whether or not to perform the query recursively
|
|
/// </summary>
|
|
/// <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
|
|
[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")]
|
|
public bool Recursive { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the sort order.
|
|
/// </summary>
|
|
/// <value>The sort order.</value>
|
|
[ApiMember(Name = "SortOrder", Description = "Sort Order - Ascending,Descending", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public SortOrder? SortOrder { 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>
|
|
[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")]
|
|
public string ParentId { get; set; }
|
|
|
|
/// <summary>
|
|
/// Fields to return within the items, in addition to basic information
|
|
/// </summary>
|
|
/// <value>The fields.</value>
|
|
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: AudioInfo, Chapters, DateCreated, DisplayMediaType, DisplayPreferences, Genres, ItemCounts, IndexOptions, MediaStreams, Overview, OverviewHtml, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Publishers, SeriesInfo, SortName, Studios, Taglines, TrailerUrls, UserData", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
|
|
public string Fields { get; set; }
|
|
}
|
|
}
|