Class Folder

Class Folder

Inheritance
System.Object
BaseItem
Folder
Channel
AggregateFolder
MusicAlbum
MusicArtist
BoxSet
CollectionFolder
GameSystem
PhotoAlbum
Season
Series
UserRootFolder
UserView
Playlist
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public class Folder : BaseItem, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasFolderGrouping

Properties

AllowRecursiveCounts

Declaration
[IgnoreDataMember]
public bool AllowRecursiveCounts { get; }
Property Value
Type Description
System.Boolean

IsDisplayedAsFolder

Declaration
[IgnoreDataMember]
public override bool IsDisplayedAsFolder { get; }
Property Value
Type Description
System.Boolean
Overrides

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

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

IsTopParent

Declaration
[IgnoreDataMember]
public override bool IsTopParent { get; }
Property Value
Type Description
System.Boolean
Overrides

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

SupportsInheritedParentImages

Declaration
[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }
Property Value
Type Description
System.Boolean
Overrides

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

FillPlayedStatus(UserItemDataDto, Nullable<Int32>, User, DtoOptions)

Declaration
protected virtual void FillPlayedStatus(UserItemDataDto dto, int? recursiveItemCount, User user, DtoOptions options)
Parameters
Type Name Description
UserItemDataDto dto
System.Nullable<System.Int32> recursiveItemCount
User user
DtoOptions options

FillUserDataDtoValues(UserItemDataDto, BaseItemDto, User, DtoOptions)

Declaration
public override void FillUserDataDtoValues(UserItemDataDto dto, BaseItemDto itemDto, User user, DtoOptions options)
Parameters
Type Name Description
UserItemDataDto dto
BaseItemDto itemDto
User user
DtoOptions options
Overrides

GetChildCount(User)

Declaration
public virtual int GetChildCount(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Int32

GetChildren(InternalItemsQuery)

Declaration
public BaseItem[] GetChildren(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
BaseItem[]

GetChildren(User)

Declaration
public BaseItem[] GetChildren(User user)
Parameters
Type Name Description
User user
Returns
Type Description
BaseItem[]

GetChildrenForValidation()

Declaration
protected override BaseItem[] GetChildrenForValidation()
Returns
Type Description
BaseItem[]
Overrides

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[]

GetItemIdsInternal(InternalItemsQuery)

Declaration
protected virtual long[] GetItemIdsInternal(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
System.Int64[]

GetItemList(InternalItemsQuery)

Declaration
public BaseItem[] GetItemList(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
BaseItem[]

GetItems(InternalItemsQuery)

Declaration
public QueryResult<BaseItem> GetItems(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<BaseItem>

GetItemsInternal(InternalItemsQuery)

Declaration
protected virtual QueryResult<BaseItem> GetItemsInternal(InternalItemsQuery query)
Parameters
Type Name Description
InternalItemsQuery query
Returns
Type Description
QueryResult<BaseItem>

GetNonCachedChildren(IDirectoryService, LibraryOptions)

Get the children of this folder from the actual file system

Declaration
protected override List<BaseItem> GetNonCachedChildren(IDirectoryService directoryService, LibraryOptions libraryOptions)
Parameters
Type Name Description
IDirectoryService directoryService
LibraryOptions libraryOptions
Returns
Type Description
System.Collections.Generic.List<BaseItem>
Overrides

GetRecursiveChildCount(User)

Declaration
public virtual int GetRecursiveChildCount(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Int32

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

IsPlayed(User)

Declaration
public override bool IsPlayed(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean
Overrides

IsUnplayed(User)

Declaration
public override bool IsUnplayed(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean
Overrides

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

The user.
BaseItem[] collectionFolders
System.Nullable<System.DateTimeOffset> datePlayed

The date played.
System.Boolean resetPosition

if set to true [reset position].
Overrides

MarkUnplayed(User)

Marks the unplayed.

Declaration
public override void MarkUnplayed(User user)
Parameters
Type Name Description
User user

The user.
Overrides

TriggerOnRefreshComplete()

Declaration
protected override void TriggerOnRefreshComplete()
Overrides

TriggerOnRefreshStart()

Declaration
protected override void TriggerOnRefreshStart()
Overrides

Implements

Extension Methods