Class BaseItemsRequest

Inheritance

System.Object

BaseItemsRequest

Implements

IHasDtoOptions

IHasItemFields

Namespace: MediaBrowser.Controller.Api

Assembly: MediaBrowser.Controller.dll

Syntax

public abstract class BaseItemsRequest : IHasDtoOptions, IHasItemFields

Constructors

BaseItemsRequest()

Declaration

protected BaseItemsRequest()

Properties

AdjacentTo

Declaration

public string AdjacentTo { get; set; }

Property Value

Type	Description
System.String

AirDays

Declaration

public DayOfWeek[] AirDays { get; set; }

Property Value

Type	Description
System.DayOfWeek[]

AiredDuringSeason

Declaration

public int? AiredDuringSeason { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

AlbumArtistIds

Declaration

public string AlbumArtistIds { get; set; }

Property Value

Type	Description
System.String

AlbumArtistStartsWithOrGreater

Declaration

public string AlbumArtistStartsWithOrGreater { get; set; }

Property Value

Type	Description
System.String

AlbumIds

Declaration

public string AlbumIds { get; set; }

Property Value

Type	Description
System.String

Albums

Declaration

public string Albums { get; set; }

Property Value

Type	Description
System.String

AnyProviderIdEquals

Provider IDs to match at least one of.

Declaration

public string AnyProviderIdEquals { get; set; }

Property Value

Type	Description
System.String	The any provider id equals filter.

ArtistIds

Declaration

public string ArtistIds { get; set; }

Property Value

Type	Description
System.String

Artists

Gets or sets the studios.

Declaration

public string Artists { get; set; }

Property Value

Type	Description
System.String	The studios.

ArtistStartsWithOrGreater

Declaration

public string ArtistStartsWithOrGreater { get; set; }

Property Value

Type	Description
System.String

ArtistType

Declaration

public string ArtistType { get; set; }

Property Value

Type	Description
System.String

AudioCodecs

Declaration

public string AudioCodecs { get; set; }

Property Value

Type	Description
System.String

AudioLanguages

Declaration

public string AudioLanguages { get; set; }

Property Value

Type	Description
System.String

AudioLayouts

Declaration

public string AudioLayouts { get; set; }

Property Value

Type	Description
System.String

CanEditItems

Declaration

public bool? CanEditItems { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

CollectionIds

Declaration

public string CollectionIds { get; set; }

Property Value

Type	Description
System.String

Containers

Declaration

public string Containers { get; set; }

Property Value

Type	Description
System.String

ContributingArtistIds

Declaration

public string ContributingArtistIds { get; set; }

Property Value

Type	Description
System.String

EnableImages

Declaration

public bool? EnableImages { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

EnableImageTypes

Declaration

public string EnableImageTypes { get; set; }

Property Value

Type	Description
System.String

EnableTotalRecordCount

Declaration

public bool EnableTotalRecordCount { get; set; }

Property Value

Type	Description
System.Boolean

EnableUserData

Declaration

public bool? EnableUserData { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ExcludeArtistIds

Declaration

public string ExcludeArtistIds { get; set; }

Property Value

Type	Description
System.String

ExcludeItemIds

Declaration

public string ExcludeItemIds { get; set; }

Property Value

Type	Description
System.String

ExcludeItemTypes

Gets or sets the exclude item types.

Declaration

public string ExcludeItemTypes { get; set; }

Property Value

Type	Description
System.String	The exclude item types.

ExcludeTagIds

Declaration

public string ExcludeTagIds { get; set; }

Property Value

Type	Description
System.String

ExcludeTags

Declaration

public string ExcludeTags { get; set; }

Property Value

Type	Description
System.String

ExtendedVideoTypes

Declaration

public string ExtendedVideoTypes { get; set; }

Property Value

Type	Description
System.String

Fields

Fields to return within the items, in addition to basic information

Declaration

public string Fields { get; set; }

Property Value

Type	Description
System.String	The fields.

Filters

Filters to apply to the results

Declaration

public string Filters { get; set; }

Property Value

Type	Description
System.String	The filters.

GenreIds

Declaration

public string GenreIds { get; set; }

Property Value

Type	Description
System.String

Genres

Limit results to items containing specific genres

Declaration

public string Genres { get; set; }

Property Value

Type	Description
System.String	The genres.

GroupItemsInto

Declaration

public ItemLinkType? GroupItemsInto { get; set; }

Property Value

Type	Description
System.Nullable<ItemLinkType>

GroupItemsIntoCollections

Declaration

public bool GroupItemsIntoCollections { get; set; }

Property Value

Type	Description
System.Boolean

GroupProgramsBySeries

Declaration

public bool GroupProgramsBySeries { get; set; }

Property Value

Type	Description
System.Boolean

HasAired

Declaration

public bool? HasAired { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasImdbId

Declaration

public bool? HasImdbId { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasOfficialRating

Declaration

public bool? HasOfficialRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasOverview

Declaration

public bool? HasOverview { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasParentalRating

Declaration

public bool? HasParentalRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasSpecialFeature

Declaration

public bool? HasSpecialFeature { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasSubtitles

Declaration

public bool? HasSubtitles { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasThemeSong

Declaration

public bool? HasThemeSong { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasThemeVideo

Declaration

public bool? HasThemeVideo { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasTmdbId

Declaration

public bool? HasTmdbId { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasTrailer

Declaration

public bool? HasTrailer { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

HasTvdbId

Declaration

public bool? HasTvdbId { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Ids

Gets or sets the item ids.

Declaration

public string Ids { get; set; }

Property Value

Type	Description
System.String	The item ids.

ImageTypeLimit

Declaration

public int? ImageTypeLimit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ImageTypes

Gets or sets the image types.

Declaration

public string ImageTypes { get; set; }

Property Value

Type	Description
System.String	The image types.

IncludeItemTypes

Gets or sets the include item types.

Declaration

public string IncludeItemTypes { get; set; }

Property Value

Type	Description
System.String	The include item types.

Is3D

Gets or sets the video formats.

Declaration

public bool? Is3D { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The video formats.

Is4K

Declaration

public bool? Is4K { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsAiring

Declaration

public bool? IsAiring { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsFavorite

Gets or sets the Isfavorite option

Declaration

public bool? IsFavorite { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	IsFavorite

IsFolder

Declaration

public bool? IsFolder { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsHD

Declaration

public bool? IsHD { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsKids

Declaration

public bool? IsKids { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsLocked

Declaration

public bool? IsLocked { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsMovie

Declaration

public bool? IsMovie { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsNew

Declaration

public bool? IsNew { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsNewOrPremiere

Declaration

public bool? IsNewOrPremiere { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsNews

Declaration

public bool? IsNews { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsPlaceHolder

Declaration

public bool? IsPlaceHolder { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsPlayed

Declaration

public bool? IsPlayed { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsPremiere

Declaration

public bool? IsPremiere { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsRepeat

Declaration

public bool? IsRepeat { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsSeries

Declaration

public bool? IsSeries { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsSports

Declaration

public bool? IsSports { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IsUnaired

Declaration

public bool? IsUnaired { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Limit

The maximum number of items to return

Declaration

public int? Limit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The limit.

ListItemIds

Declaration

public string ListItemIds { get; set; }

Property Value

Type	Description
System.String

MaxEndDate

Declaration

public string MaxEndDate { get; set; }

Property Value

Type	Description
System.String

MaxHeight

Declaration

public int? MaxHeight { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxOfficialRating

Gets or sets the max offical rating.

Declaration

public string MaxOfficialRating { get; set; }

Property Value

Type	Description
System.String	The max offical rating.

MaxPlayers

Declaration

public int? MaxPlayers { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxPremiereDate

Declaration

public string MaxPremiereDate { get; set; }

Property Value

Type	Description
System.String

MaxStartDate

Declaration

public string MaxStartDate { get; set; }

Property Value

Type	Description
System.String

MaxWidth

Declaration

public int? MaxWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MediaTypes

Gets or sets the media types.

Declaration

public string MediaTypes { get; set; }

Property Value

Type	Description
System.String	The media types.

MinCommunityRating

Declaration

public double? MinCommunityRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

MinCriticRating

Declaration

public double? MinCriticRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

MinDateLastSaved

Declaration

public string MinDateLastSaved { get; set; }

Property Value

Type	Description
System.String

MinDateLastSavedForUser

Declaration

public string MinDateLastSavedForUser { get; set; }

Property Value

Type	Description
System.String

MinEndDate

Declaration

public string MinEndDate { get; set; }

Property Value

Type	Description
System.String

MinHeight

Declaration

public int? MinHeight { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MinIndexNumber

Declaration

public int? MinIndexNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MinOfficialRating

Gets or sets the min offical rating.

Declaration

public string MinOfficialRating { get; set; }

Property Value

Type	Description
System.String	The min offical rating.

MinPlayers

Declaration

public int? MinPlayers { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MinPremiereDate

Declaration

public string MinPremiereDate { get; set; }

Property Value

Type	Description
System.String

MinStartDate

Declaration

public string MinStartDate { get; set; }

Property Value

Type	Description
System.String

MinWidth

Declaration

public int? MinWidth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

NameLessThan

Declaration

public string NameLessThan { get; set; }

Property Value

Type	Description
System.String

NameStartsWith

Declaration

public string NameStartsWith { get; set; }

Property Value

Type	Description
System.String

NameStartsWithOrGreater

Declaration

public string NameStartsWithOrGreater { get; set; }

Property Value

Type	Description
System.String

OfficialRatings

Declaration

public string OfficialRatings { get; set; }

Property Value

Type	Description
System.String

OuterIds

Declaration

public string OuterIds { get; set; }

Property Value

Type	Description
System.String

ParentId

Specify this to localize the search to a specific item or folder. Omit to use the root.

Declaration

public string ParentId { get; set; }

Property Value

Type	Description
System.String	The parent id.

ParentIndexNumber

Declaration

public int? ParentIndexNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Path

Declaration

public string Path { get; set; }

Property Value

Type	Description
System.String

Person

Limit results to items containing a specific person

Declaration

public string Person { get; set; }

Property Value

Type	Description
System.String	The person.

PersonIds

Declaration

public string PersonIds { get; set; }

Property Value

Type	Description
System.String

PersonTypes

If the Person filter is used, this can also be used to restrict to a specific person type

Declaration

public string PersonTypes { get; set; }

Property Value

Type	Description
System.String	The type of the person.

ProjectToMedia

Declaration

public bool ProjectToMedia { get; set; }

Property Value

Type	Description
System.Boolean

RandomSeed

Declaration

public int RandomSeed { get; set; }

Property Value

Type	Description
System.Int32

RecordingKeyword

Declaration

public string RecordingKeyword { get; set; }

Property Value

Type	Description
System.String

RecordingKeywordType

Declaration

public KeywordType? RecordingKeywordType { get; set; }

Property Value

Type	Description
System.Nullable<KeywordType>

Recursive

Whether or not to perform the query recursively

Declaration

public bool Recursive { get; set; }

Property Value

Type	Description
System.Boolean	true if recursive; otherwise, false.

SearchTerm

Declaration

public string SearchTerm { get; set; }

Property Value

Type	Description
System.String

SeriesStatus

Gets or sets the series status.

Declaration

public string SeriesStatus { get; set; }

Property Value

Type	Description
System.String	The series status.

SortBy

What to sort the results by

Declaration

public string SortBy { get; set; }

Property Value

Type	Description
System.String	The sort by.

SortOrder

Gets or sets the sort order.

Declaration

public string SortOrder { get; set; }

Property Value

Type	Description
System.String	The sort order.

StartIndex

Skips over a given number of items within the results. Use for paging.

Declaration

public int? StartIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The start index.

StudioIds

Declaration

public string StudioIds { get; set; }

Property Value

Type	Description
System.String

Studios

Limit results to items containing specific studios

Declaration

public string Studios { get; set; }

Property Value

Type	Description
System.String	The studios.

SubtitleCodecs

Declaration

public string SubtitleCodecs { get; set; }

Property Value

Type	Description
System.String

SubtitleLanguages

Declaration

public string SubtitleLanguages { get; set; }

Property Value

Type	Description
System.String

TagIds

Declaration

public string TagIds { get; set; }

Property Value

Type	Description
System.String

Tags

Declaration

public string Tags { get; set; }

Property Value

Type	Description
System.String

UserId

Gets or sets the user id.

Declaration

public Guid UserId { get; set; }

Property Value

Type	Description
System.Guid	The user id.

VideoCodecs

Declaration

public string VideoCodecs { get; set; }

Property Value

Type	Description
System.String

VideoTypes

Gets or sets the video types.

Declaration

public string VideoTypes { get; set; }

Property Value

Type	Description
System.String	The video types.

Years

Limit results to items containing specific years

Declaration

public string Years { get; set; }

Property Value

Type	Description
System.String	The years.

Methods

GetAnyProviderIdEquals()

Gets the AnyProviderIdEquals filter.

Declaration

public List<KeyValuePair<string, string>> GetAnyProviderIdEquals()

Returns

Type	Description
System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<System.String, System.String>>	Dictionary{string, string}.

GetAudioCodecs()

Declaration

public string[] GetAudioCodecs()

Returns

Type	Description
System.String[]

GetAudioLanguages()

Declaration

public string[] GetAudioLanguages()

Returns

Type	Description
System.String[]

GetAudioLayouts()

Declaration

public string[] GetAudioLayouts()

Returns

Type	Description
System.String[]

GetContainers()

Declaration

public string[] GetContainers()

Returns

Type	Description
System.String[]

GetExcludeItemTypes()

Declaration

public string[] GetExcludeItemTypes()

Returns

Type	Description
System.String[]

GetExcludeTags()

Declaration

public string[] GetExcludeTags()

Returns

Type	Description
System.String[]

GetExtendedVideoTypes()

Declaration

public ExtendedVideoTypes[] GetExtendedVideoTypes()

Returns

Type	Description
ExtendedVideoTypes[]

GetFilters()

Gets the filters.

Declaration

public ItemFilter[] GetFilters()

Returns

Type	Description
ItemFilter[]	IEnumerable{ItemFilter}.

GetGenres()

Declaration

public string[] GetGenres()

Returns

Type	Description
System.String[]

GetImageTypes()

Gets the image types.

Declaration

public ImageType[] GetImageTypes()

Returns

Type	Description
ImageType[]	IEnumerable{ImageType}.

GetIncludeItemTypes()

Declaration

public string[] GetIncludeItemTypes()

Returns

Type	Description
System.String[]

GetMediaTypes()

Declaration

public string[] GetMediaTypes()

Returns

Type	Description
System.String[]

GetOfficialRatings()

Declaration

public string[] GetOfficialRatings()

Returns

Type	Description
System.String[]

GetOrderBy()

Gets the order by.

Declaration

public (string, SortOrder)[] GetOrderBy()

Returns

Type	Description
System.ValueTuple<System.String, SortOrder>[]	IEnumerable{ItemSortBy}.

GetOrderBy(String, String)

Declaration

public static (string, SortOrder)[] GetOrderBy(string sortBy, string requestedSortOrder)

Parameters

Type	Name	Description
System.String	sortBy
System.String	requestedSortOrder

Returns

Type	Description
System.ValueTuple<System.String, SortOrder>[]

GetPersonTypes()

Declaration

public PersonType[] GetPersonTypes()

Returns

Type	Description
PersonType[]

GetStudios()

Declaration

public string[] GetStudios()

Returns

Type	Description
System.String[]

GetSubtitleCodecs()

Declaration

public string[] GetSubtitleCodecs()

Returns

Type	Description
System.String[]

GetSubtitleLanguages()

Declaration

public string[] GetSubtitleLanguages()

Returns

Type	Description
System.String[]

GetTags()

Declaration

public string[] GetTags()

Returns

Type	Description
System.String[]

GetVideoCodecs()

Declaration

public string[] GetVideoCodecs()

Returns

Type	Description
System.String[]

GetYears()

Declaration

public int[] GetYears()

Returns

Type	Description
System.Int32[]

Implements

IHasDtoOptions

IHasItemFields

Extension Methods

ItemFieldsExtensions.GetItemFields(IHasItemFields)

Extensions.JsonClone<T>(T, IJsonSerializer)