Class Folder

Inheritance

System.Object

BaseItem

Folder

Implements

IHasProviderIds

IHasLookupInfo<ItemLookupInfo>

IHasFolderGrouping

Inherited Members

BaseItem.PlayCount

BaseItem.LastPlayedDate

BaseItem.Played

BaseItem.AudioStreamIndex

BaseItem.SubtitleStreamIndex

BaseItem.UserDataKey

BaseItem.IsFavorite

BaseItem.UserRating

BaseItem.PlayedPercentage

BaseItem.PlaybackPositionTicks

BaseItem.UserDataSet

BaseItem.InternalId

BaseItem.RemoteTrailers

BaseItem.ListItemEntryId

BaseItem.IsSecondaryMergedItemInSameFolder

BaseItem.IsPublic

BaseItem.CollectionFolders

BaseItem.LibraryOptions

BaseItem.MediaStreams

BaseItem.ChildCount

BaseItem.UnplayedItemCount

BaseItem.AdditionalPartCount

BaseItem.LocalTrailerCount

BaseItem.VideoCodec

BaseItem.AudioCodec

BaseItem.AverageFrameRate

BaseItem.RealFrameRate

BaseItem.SpecialFeatureCount

BaseItem.RecursiveItemCount

BaseItem.SupportedImageExtensions

BaseItem.TrailerFolderName

BaseItem.ThemeSongsFolderName

BaseItem.ThemeSongFilename

BaseItem.ThemeVideosFolderName

BaseItem.ExtrasSubFolders

BaseItem.ParseNameBeforeMetadataRefresh

BaseItem.SupportsUserData

BaseItem.IsPlaceHolder

BaseItem.SupportsExtras

BaseItem.SupportsAdditionalParts

BaseItem.IsCompleteMedia

BaseItem.IsMedia

BaseItem.DisplayExtraTypes

BaseItem.GetDisplayExtraIds()

BaseItem.ThemeSongIds

BaseItem.ThemeVideoIds

BaseItem.LocalTrailerIds

BaseItem.RecursiveChildCountEqualsChildCount

BaseItem.HasPlaceholderMatadata()

BaseItem.SupportsManageAccess()

BaseItem.CanManageAccess(User, UserItemShareLevel)

BaseItem.SupportsMakePublicOrPrivate()

BaseItem.AssertHasMinimumShareLevel(User, UserItemShareLevel, CancellationToken)

BaseItem.GetShareLevel(User, CancellationToken)

BaseItem.CanLeaveSharedContent(User, UserItemShareLevel)

BaseItem.CanMakePublic(User)

BaseItem.CanMakePrivate(User)

BaseItem.CanMakePublic(UserItemShareLevel)

BaseItem.CanMakePrivate(UserItemShareLevel)

BaseItem.GetExtraGuids(ExtraType[])

BaseItem.GetAdditionalParts(DtoOptions, User)

BaseItem.GetAdditionalPartIds()

BaseItem.GetExtraTypes(ExtraType[], CancellationToken)

BaseItem.GetExtraIds(ExtraType[])

BaseItem.GetExtras(ExtraType[])

BaseItem.GetExtras(ExtraType[], DtoOptions)

BaseItem.GetExtras(ExtraType[], DtoOptions, CancellationToken)

BaseItem.GetExtras(Int64, String, ExtraType[], DtoOptions, CancellationToken)

BaseItem.GetExtras(Int64, User, ExtraType[], DtoOptions, CancellationToken)

BaseItem.GetThemeSongs(DtoOptions, CancellationToken)

BaseItem.GetThemeVideos(DtoOptions, CancellationToken)

BaseItem.GetRunTimeTicksForPlayState()

BaseItem.PreferredMetadataCountryCode

BaseItem.PreferredMetadataLanguage

BaseItem.Size

BaseItem.Prefix

BaseItem.ShareLevel

BaseItem.SyncStatus

BaseItem.Container

BaseItem.MediaContainer

BaseItem.Tagline

BaseItem.ImageInfos

BaseItem.IsVirtualItem

BaseItem.InternalAlbumId

BaseItem.AlbumId

BaseItem.GetAlbumId(IDataContext)

BaseItem.SeriesId

BaseItem.Album

BaseItem.AlbumItem

BaseItem.GetAlbumItem(IDataContext)

BaseItem.SetAlbumItem(BaseItem)

BaseItem.SetSeriesItem(BaseItem)

BaseItem.SupportsEditingAlbum

BaseItem.GetStandaloneDisplayName()

BaseItem.GetStandaloneDisplayName(String, String, Nullable<Int32>, Nullable<Int32>)

BaseItem.IsInMixedFolder

BaseItem.OwnsFolder

BaseItem.OriginalParsedName

BaseItem.IsNameParsedFromFolder

BaseItem.ToLinkedItemInfo()

BaseItem.SupportsPlayedStatus()

BaseItem.GetDisplayOrderIntValue()

BaseItem.SetDisplayOrder(String)

BaseItem.GetMediaContainingFolderPath(LibraryOptions)

BaseItem.GetMediaContainingFolderPath(LibraryOptions, CancellationToken)

BaseItem.GetSupportsPositionTicksResume(LibraryOptions)

BaseItem.SupportsRemoteImageDownloading

BaseItem.Name

BaseItem.IsShortcut

BaseItem.IsFileShortcut(String)

BaseItem.IsUnaired

BaseItem.TotalBitrate

BaseItem.ExtraType

BaseItem.IsThemeMedia

BaseItem.OriginalTitle

BaseItem.Id

BaseItem.MediaSourceIdPrefix

BaseItem.GetDefaultMediaSourceId()

BaseItem.IsHD

BaseItem.Width

BaseItem.Height

BaseItem.DisplayPreferencesId

BaseItem.Path

BaseItem.ContainingFolderPath

BaseItem.ExternalId

BaseItem.SeriesPresentationUniqueKey

BaseItem.IsHidden

BaseItem.LocationType

BaseItem.PathProtocol

BaseItem.IsPathProtocol(MediaProtocol)

BaseItem.IsFileProtocol

BaseItem.HasPathProtocol

BaseItem.FileNameWithoutExtension

BaseItem.FileName

BaseItem.EnableAlphaNumericSorting

BaseItem.PrimaryImagePath

BaseItem.IsMetadataFetcherEnabled(LibraryOptions, String)

BaseItem.IsImageFetcherEnabled(LibraryOptions, String)

BaseItem.IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])

BaseItem.CanDelete(User, Folder[])

BaseItem.CanDelete(User, UserItemShareLevel, Folder[])

BaseItem.CanDownload()

BaseItem.IsAuthorizedToDownload(User)

BaseItem.CanDownload(User)

BaseItem.CanDownloadAsSingleMedia()

BaseItem.CanDownloadAsFolder()

BaseItem.DateCreated

BaseItem.DateModified

BaseItem.HasDateModifiedChanged(DateTimeOffset)

BaseItem.HasDateChanged(DateTimeOffset, DateTimeOffset)

BaseItem.HasDateChanged(Nullable<DateTimeOffset>, DateTimeOffset)

BaseItem.HasDateChanged(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

BaseItem.DateLastSaved

BaseItem.DateLastRefreshed

BaseItem.IsGreaterThanDateLastSaved(DateTimeOffset)

BaseItem.Logger

BaseItem.LibraryManager

BaseItem.LiveTvManager

BaseItem.FeatureManager

BaseItem.UserManager

BaseItem.ConfigurationManager

BaseItem.ProviderManager

BaseItem.LocalizationManager

BaseItem.ItemRepository

BaseItem.FileSystem

BaseItem.UserDataManager

BaseItem.ChannelManager

BaseItem.MediaSourceManager

BaseItem.NetworkManager

BaseItem.ApplicationHost

BaseItem.ToString()

BaseItem.IsLocked

BaseItem.LockedFields

BaseItem.MediaType

BaseItem.SortName

BaseItem.SetSortNameDirect(String)

BaseItem.IsFieldLocked(MetadataFields)

BaseItem.AddProviderIdsToName(String, String[])

BaseItem.GetInternalMetadataPath()

BaseItem.GetInternalMetadataPath(String)

BaseItem.GetInternalMetadataPath(Guid, String)

BaseItem.CreateSortName()

BaseItem.CreateSortName(ReadOnlySpan<Char>)

BaseItem.ParentId

BaseItem.Parent

BaseItem.SetParent(BaseItem)

BaseItem.GetCachedParent()

BaseItem.SetCachedParent(BaseItem)

BaseItem.GetParent()

BaseItem.GetParent(IDataContext)

BaseItem.GetParents()

BaseItem.GetParents(IDataContext)

BaseItem.Closest<T>()

BaseItem.FindParent<T>()

BaseItem.FindParent<T>(IDataContext)

BaseItem.DisplayParentId

BaseItem.ImageDisplayParentId

BaseItem.DisplayParent

BaseItem.PremiereDate

BaseItem.EndDate

BaseItem.OfficialRating

BaseItem.CriticRating

BaseItem.CustomRating

BaseItem.Overview

BaseItem.Studios

BaseItem.StudioItems

BaseItem.Genres

BaseItem.GenreItems

BaseItem.Tags

BaseItem.TagItems

BaseItem.SetTagItemsDirect(LinkedItemInfo[])

BaseItem.Collections

BaseItem.ImportedCollections

BaseItem.GetImportedCollections(CancellationToken)

BaseItem.GetAllKnownCollections()

BaseItem.GetAllKnownCollections(CancellationToken)

BaseItem.AddImportedCollections(LinkedItemInfo[])

BaseItem.ContainsTag(String)

BaseItem.SetTags(IEnumerable<String>)

BaseItem.SetCollections(IEnumerable<String>)

BaseItem.SetGenres(IEnumerable<String>)

BaseItem.ProductionLocations

BaseItem.CommunityRating

BaseItem.RunTimeTicks

BaseItem.ProductionYear

BaseItem.IndexNumber

BaseItem.ParentIndexNumber

BaseItem.OfficialRatingForComparison

BaseItem.CustomRatingForComparison

BaseItem.GetMediaStreams()

BaseItem.GetMediaStreams(CancellationToken)

BaseItem.MarkTaggedItemsLoaded()

BaseItem.EnsureTaggedItemsLoaded()

BaseItem.EnsureTaggedItemsLoaded(IDataContext)

BaseItem.GetSupportedItemLinkTypes()

BaseItem.FillItemLinks(List<(T1, T2, T3)<ItemLinkType, String, Int64>>)

BaseItem.IsActiveRecording()

BaseItem.GetMediaSources(Boolean, Boolean, LibraryOptions)

BaseItem.GetMediaSources(User, Boolean, Boolean, Boolean, Boolean, BaseItem[], LibraryOptions, CancellationToken)

BaseItem.GetAllItemsForMediaSources(User, Boolean)

BaseItem.RefreshMetadata(BaseItem[], LibraryOptions, CancellationToken)

BaseItem.RefreshMetadata(CancellationToken)

BaseItem.EnableInternalIdsExternally

BaseItem.GetClientId()

BaseItem.RefreshMetadata(MetadataRefreshOptions, CancellationToken)

BaseItem.RefreshMetadata(MetadataRefreshOptions, BaseItem[], LibraryOptions, CancellationToken)

BaseItem.SupportsOwnedItems

BaseItem.SupportsPeople

BaseItem.SupportsGenres

BaseItem.SupportsStudios

BaseItem.SupportsTags

BaseItem.SupportsCollections

BaseItem.SupportsThemeMedia

BaseItem.SupportsLocalTrailers

BaseItem.GetFileSystemChildren(IDirectoryService)

BaseItem.GetUniquelyIdentifiableProviderIds()

BaseItem.ProviderIds

BaseItem.LatestItemsContainerId

BaseItem.ForceDefaultAspectRatio

BaseItem.GetDefaultPrimaryImageAspectRatio()

BaseItem.CreatePresentationUniqueKey(IDataContext, CancellationToken)

BaseItem.CreatePresentationUniqueKey(BaseItem[], LibraryOptions, IDataContext, CancellationToken)

BaseItem.GetDefaultPresentationUniqueKey()

BaseItem.PresentationUniqueKey

BaseItem.ResolvedPresentationUniqueKey

BaseItem.GetPresentationUniqueKey()

BaseItem.GetPresentationUniqueKey(IDataContext, CancellationToken)

BaseItem.GetPresentationUniqueKey(BaseItem[], LibraryOptions, IDataContext, CancellationToken)

BaseItem.GetUserDataKey(IDataContext)

BaseItem.GetUserDataKeyInternal(IDataContext)

BaseItem.AfterMetadataRefresh()

BaseItem.GetPreferredMetadataLanguage()

BaseItem.GetPreferredMetadataLanguage(LibraryOptions)

BaseItem.GetPreferredMetadataLanguage(LibraryOptions, IDataContext)

BaseItem.GetPreferredImageLanguage(LibraryOptions)

BaseItem.GetPreferredMetadataCountryCode()

BaseItem.GetPreferredMetadataCountryCode(LibraryOptions)

BaseItem.IsLocalMetadataReaderEnabled(LibraryOptions, String)

BaseItem.IsSaveLocalImagesEnabled(LibraryOptions)

BaseItem.GetParentalRatingValue()

BaseItem.GetInheritedParentalRatingValue()

BaseItem.IsVisible(User)

BaseItem.IsVisibleStandalone(User)

BaseItem.GetClientTypeName()

BaseItem.EnableRememberingTrackSelections

BaseItem.AddStudio(String)

BaseItem.SetStudios(IEnumerable<String>)

BaseItem.AddLinkedItem(LinkedItemInfo[], LinkedItemInfo, LinkedItemInfo, Boolean)

BaseItem.AddLinkedItem(LinkedItemInfo[], String, LinkedItemInfo, Boolean)

BaseItem.AddLinkedItem(LinkedItemInfo[], LinkedItemInfo)

BaseItem.AddLinkedItem(LinkedItemInfo[], String)

BaseItem.RemoveLinkedItem(LinkedItemInfo[], LinkedItemInfo)

BaseItem.RemoveLinkedItem(LinkedItemInfo[], String)

BaseItem.AddGenre(String)

BaseItem.AddCollection(String)

BaseItem.AddCollection(LinkedItemInfo)

BaseItem.AddCollectionInfo(LinkedItemInfo)

BaseItem.AddCollection(BoxSet)

BaseItem.RemoveCollection(Int64)

BaseItem.MarkPlayed(User, Nullable<DateTimeOffset>, Boolean)

BaseItem.UpdateHideFromResume(User, UserItemData, Boolean)

BaseItem.UpdateHideFromResume(User, UserItemData, BaseItem[], Boolean)

BaseItem.HasImage(ImageType, Int32)

BaseItem.SetImage(ItemImageInfo, Int32)

BaseItem.SetImage(ItemImageInfo, Int32, Boolean)

BaseItem.AddImage(FileSystemMetadata, ImageType)

BaseItem.DeleteImage(ImageType, Int32)

BaseItem.RemoveImage(ImageType, String)

BaseItem.RemoveImage(ItemImageInfo)

BaseItem.RemoveImages(List<ItemImageInfo>)

BaseItem.UpdateToRepository(ItemUpdateType)

BaseItem.UpdateToRepository(ItemUpdateType, BaseItem)

BaseItem.UpdateToRepository(ItemUpdateType, MetadataRefreshOptions)

BaseItem.UpdateToRepository(ItemUpdateType, BaseItem, MetadataRefreshOptions)

BaseItem.GetImagePath(ImageType, Int32)

BaseItem.GetImageInfo(ImageType, Int32)

BaseItem.GetImages(ImageType)

BaseItem.AddImages(ImageType, List<FileSystemMetadata>, Boolean)

BaseItem.GetDeletePaths(Boolean, BaseItem[])

BaseItem.AllowsMultipleImages(ImageType)

BaseItem.ReorderImage(ImageType, Int32, Int32)

BaseItem.MoveFiles(String[], String[])

BaseItem.IsFavoriteOrLiked(User)

BaseItem.IHasLookupInfo<ItemLookupInfo>.GetLookupInfo(LibraryOptions)

BaseItem.GetItemLookupInfo<T>(LibraryOptions)

BaseItem.GetItemsForAncestorIdsQuery(User, IDataContext, CancellationToken)

BaseItem.GetIdsForAncestorIdsQuery(User, IDataContext, CancellationToken)

BaseItem.GetNameForMetadataLookup()

BaseItem.BeforeMetadataRefresh(Boolean)

BaseItem.GetMappedPath(String, Nullable<MediaProtocol>, LibraryOptions)

BaseItem.GetEtag(User)

BaseItem.GetEtagValues(User)

BaseItem.GetTopParent()

BaseItem.SupportsAncestors

BaseItem.GetRelatedUrls()

BaseItem.UpdateRatingToItems(BaseItem[])

BaseItem.AllowEditingField(MetadataFields)

BaseItem.SupportsResetMetadata

BaseItem.ResetMetadata()

BaseItem.ResetMetadataInternal()

BaseItem.ClearProviderIds()

BaseItem.SetProviderIds(ProviderIdDictionary)

BaseItem.GetChildrenForValidationSorted(CancellationToken)

BaseItem.ValidatesChildren

BaseItem.ValidateChildren(IProgress<Double>, CancellationToken, MetadataRefreshOptions, Boolean)

BaseItem.ResolvedExtras

BaseItem.ValidateChildrenInternal(IProgress<Double>, CancellationToken, Boolean, Boolean, BaseItem[], LibraryOptions, Dictionary<Int64, Boolean>, MetadataRefreshOptions, IDirectoryService)

BaseItem.SortChildrenForValidation(BaseItem[])

BaseItem.EnableImageCaching(LibraryOptions)

BaseItem.GetApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, String)

BaseItem.GetLocalApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, CancellationToken)

BaseItem.GetRemoteApiImageUrl(ItemImageInfo, Int32, ApiImageOptions)

BaseItem.SetAutoSortingIfNeeded(InternalItemsQuery)

Namespace: MediaBrowser.Controller.Entities

Assembly: MediaBrowser.Controller.dll

Syntax

public class Folder : BaseItem, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasFolderGrouping

Properties

AllowRecursiveCounts

Declaration

[IgnoreDataMember]
public override bool AllowRecursiveCounts { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.AllowRecursiveCounts

IsDisplayedAsFolder

Declaration

[IgnoreDataMember]
public override bool IsDisplayedAsFolder { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.IsDisplayedAsFolder

IsFolder

Gets a value indicating whether this instance is folder.

Declaration

[IgnoreDataMember]
public override bool IsFolder { get; }

Property Value

Type	Description
System.Boolean	`true` if this instance is folder; otherwise, `false`.

Overrides

BaseItem.IsFolder

IsPhysicalRoot

Declaration

[IgnoreDataMember]
public virtual bool IsPhysicalRoot { get; }

Property Value

Type	Description
System.Boolean

IsPreSorted

Declaration

[IgnoreDataMember]
public bool IsPreSorted { get; }

Property Value

Type	Description
System.Boolean

IsResolvedToFolder

Declaration

[IgnoreDataMember]
public override bool IsResolvedToFolder { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.IsResolvedToFolder

IsTopParent

Declaration

[IgnoreDataMember]
public override bool IsTopParent { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.IsTopParent

MarkDirectlyAsPlayed

Declaration

[IgnoreDataMember]
protected virtual bool MarkDirectlyAsPlayed { get; }

Property Value

Type	Description
System.Boolean

SupportsCumulativeRunTimeTicks

Declaration

[IgnoreDataMember]
public virtual bool SupportsCumulativeRunTimeTicks { get; }

Property Value

Type	Description
System.Boolean

SupportsExternalTransfer

Declaration

[IgnoreDataMember]
public override bool SupportsExternalTransfer { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsExternalTransfer

SupportsInheritedParentImages

Declaration

[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsInheritedParentImages

UpdateChildrenOnLockStateChange

Declaration

[IgnoreDataMember]
public virtual bool UpdateChildrenOnLockStateChange { get; }

Property Value

Type	Description
System.Boolean

UserViewManager

Declaration

public static IUserViewManager UserViewManager { get; set; }

Property Value

Type	Description
IUserViewManager

Methods

AddChild(BaseItem)

Adds the child.

Declaration

public void AddChild(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item	The item.

AddChild(BaseItem, BaseItem[])

Declaration

public void AddChild(BaseItem item, BaseItem[] collectionFolders)

Parameters

Type	Name	Description
BaseItem	item
BaseItem[]	collectionFolders

CanDelete()

Declaration

public override bool CanDelete()

Returns

Type	Description
System.Boolean

Overrides

BaseItem.CanDelete()

FillUserDataDtoValues(UserItemDataDto, User, DtoOptions, LibraryOptions, CancellationToken)

Declaration

public override void FillUserDataDtoValues(UserItemDataDto dto, User user, DtoOptions options, LibraryOptions libraryOptions, CancellationToken cancellationToken)

Parameters

Type	Name	Description
UserItemDataDto	dto
User	user
DtoOptions	options
LibraryOptions	libraryOptions
System.Threading.CancellationToken	cancellationToken

Overrides

BaseItem.FillUserDataDtoValues(UserItemDataDto, User, DtoOptions, LibraryOptions, CancellationToken)

FillUserDataValues(User, DtoOptions, LibraryOptions, IDataContext, CancellationToken)

Declaration

public override void FillUserDataValues(User user, DtoOptions options, LibraryOptions libraryOptions, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
User	user
DtoOptions	options
LibraryOptions	libraryOptions
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Overrides

BaseItem.FillUserDataValues(User, DtoOptions, LibraryOptions, IDataContext, CancellationToken)

GetChildCount(User, IDataContext, CancellationToken)

Declaration

public override int GetChildCount(User user, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
User	user
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Int32

Overrides

BaseItem.GetChildCount(User, IDataContext, CancellationToken)

GetChildCountQuery(User)

Declaration

protected virtual InternalItemsQuery GetChildCountQuery(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
InternalItemsQuery

GetChildren(InternalItemsQuery)

Declaration

public BaseItem[] GetChildren(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
BaseItem[]

GetChildren(InternalItemsQuery, IDataContext, CancellationToken)

Declaration

public BaseItem[] GetChildren(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
BaseItem[]

GetChildren(InternalItemsQuery, CancellationToken)

Declaration

public BaseItem[] GetChildren(InternalItemsQuery query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
BaseItem[]

GetChildren(User)

Declaration

public BaseItem[] GetChildren(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
BaseItem[]

GetChildrenForValidation(CancellationToken)

Declaration

protected override BaseItem[] GetChildrenForValidation(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
BaseItem[]

Overrides

BaseItem.GetChildrenForValidation(CancellationToken)

GetChildrenIds(InternalItemsQuery)

Declaration

public long[] GetChildrenIds(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.Int64[]

GetItemIdList(InternalItemsQuery)

Declaration

public long[] GetItemIdList(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.Int64[]

GetItemIdList(InternalItemsQuery, IDataContext, CancellationToken)

Declaration

public long[] GetItemIdList(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Int64[]

GetItemIdList(InternalItemsQuery, CancellationToken)

Declaration

public long[] GetItemIdList(InternalItemsQuery query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Int64[]

GetItemIdsInternal(InternalItemsQuery, IDataContext, CancellationToken)

Declaration

protected virtual long[] GetItemIdsInternal(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Int64[]

GetItemList(InternalItemsQuery)

Declaration

public BaseItem[] GetItemList(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
BaseItem[]

GetItemList(InternalItemsQuery, IDataContext, CancellationToken)

Declaration

public BaseItem[] GetItemList(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
BaseItem[]

GetItemList(InternalItemsQuery, CancellationToken)

Declaration

public BaseItem[] GetItemList(InternalItemsQuery query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
BaseItem[]

GetItems(InternalItemsQuery)

Declaration

public QueryResult<BaseItem> GetItems(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<BaseItem>

GetItems(InternalItemsQuery, IDataContext, CancellationToken)

Declaration

public QueryResult<BaseItem> GetItems(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
QueryResult<BaseItem>

GetItems(InternalItemsQuery, CancellationToken)

Declaration

public QueryResult<BaseItem> GetItems(InternalItemsQuery query, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
QueryResult<BaseItem>

GetItemsInternal(InternalItemsQuery, IDataContext, CancellationToken)

Declaration

protected virtual QueryResult<BaseItem> GetItemsInternal(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
QueryResult<BaseItem>

GetNonCachedChildren(IDirectoryService, BaseItem[], LibraryOptions)

Get the children of this folder from the actual file system

Declaration

protected override List<BaseItem> GetNonCachedChildren(IDirectoryService directoryService, BaseItem[] collectionFolders, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
IDirectoryService	directoryService
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions

Returns

Type	Description
System.Collections.Generic.List<BaseItem>

Overrides

BaseItem.GetNonCachedChildren(IDirectoryService, BaseItem[], LibraryOptions)

GetRecursiveChildCount(User)

Declaration

public int GetRecursiveChildCount(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Int32

GetRecursiveChildCount(User, IDataContext, CancellationToken)

Declaration

public override int GetRecursiveChildCount(User user, IDataContext dataContext, CancellationToken cancellationToken)

Parameters

Type	Name	Description
User	user
IDataContext	dataContext
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Int32

Overrides

BaseItem.GetRecursiveChildCount(User, IDataContext, CancellationToken)

GetRecursiveChildren()

Gets the recursive children.

Declaration

public BaseItem[] GetRecursiveChildren()

Returns

Type	Description
BaseItem[]	IList{BaseItem}.

GetRefreshProgress()

Declaration

public override double? GetRefreshProgress()

Returns

Type	Description
System.Nullable<System.Double>

Overrides

BaseItem.GetRefreshProgress()

IsPlayed(User)

Declaration

public override bool IsPlayed(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

Overrides

BaseItem.IsPlayed(User)

IsUnplayed(User)

Declaration

public override bool IsUnplayed(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

Overrides

BaseItem.IsUnplayed(User)

MarkPlayed(User, BaseItem[], Nullable<DateTimeOffset>, Boolean)

Marks the played.

Declaration

public override void MarkPlayed(User user, BaseItem[] collectionFolders, DateTimeOffset? datePlayed, bool resetPosition)

Parameters

Type	Name	Description
User	user
BaseItem[]	collectionFolders
System.Nullable<System.DateTimeOffset>	datePlayed
System.Boolean	resetPosition

Overrides

BaseItem.MarkPlayed(User, BaseItem[], Nullable<DateTimeOffset>, Boolean)

MarkUnplayed(User)

Marks the unplayed.

Declaration

public override void MarkUnplayed(User user)

Parameters

Type	Name	Description
User	user	The user.

Overrides

BaseItem.MarkUnplayed(User)

SetAutoSorting(InternalItemsQuery, List<(String, SortOrder)>)

Declaration

protected override void SetAutoSorting(InternalItemsQuery query, List<(string, SortOrder)> orderBy)

Parameters

Type	Name	Description
InternalItemsQuery	query
System.Collections.Generic.List<System.ValueTuple<System.String, SortOrder>>	orderBy

Overrides

BaseItem.SetAutoSorting(InternalItemsQuery, List<(String, SortOrder)>)

TriggerOnRefreshComplete()

Declaration

protected override void TriggerOnRefreshComplete()

Overrides

BaseItem.TriggerOnRefreshComplete()

TriggerOnRefreshStart()

Declaration

protected override void TriggerOnRefreshStart()