Class CollectionFolder

Specialized Folder class that points to a subset of the physical folders in the system. It is created from the user-specific folders within the system root

Inheritance
System.Object
BaseItem
Folder
CollectionFolder
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public sealed class CollectionFolder : Folder, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasFolderGrouping, ICollectionFolder, IHasCollectionType

Properties

CollectionType

Declaration
[IgnoreDataMember]
public string CollectionType { get; }
Property Value
Type Description
System.String

DisplayPreferencesId

Allow different display preferences for each collection folder

Declaration
[IgnoreDataMember]
public override Guid DisplayPreferencesId { get; }
Property Value
Type Description
System.Guid

The display prefs id.
Overrides

EnableItemChangeEvents

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

ForceDefaultAspectRatio

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

IsHidden

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

JsonSerializer

Declaration
public static IJsonSerializer JsonSerializer { get; set; }
Property Value
Type Description
IJsonSerializer

PhysicalFolderIds

Gets or sets the tags.

Declaration
[IgnoreDataMember]
public long[] PhysicalFolderIds { get; set; }
Property Value
Type Description
System.Int64[]

The tags.

SupportsCollections

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

SupportsInheritedParentImages

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

SupportsOwnedItems

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

SupportsPeople

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

SupportsTags

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

SupportsThemeMedia

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

SupportsUserData

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

UpdateChildrenOnLockStateChange

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

ValidatesChildren

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

XmlSerializer

Declaration
public static IXmlSerializer XmlSerializer { get; set; }
Property Value
Type Description
IXmlSerializer

Methods

CanDelete()

Declaration
public override bool CanDelete()
Returns
Type Description
System.Boolean
Overrides

ClearCachedUserPermissions(Int64)

Declaration
public void ClearCachedUserPermissions(long userId)
Parameters
Type Name Description
System.Int64 userId

FillItemLinks(List<(ItemLinkType, String, Int64)>)

Declaration
public override void FillItemLinks(List<(ItemLinkType, string, long)> itemLinks)
Parameters
Type Name Description
System.Collections.Generic.List<System.ValueTuple<ItemLinkType, System.String, System.Int64>> itemLinks
Overrides

GetDefaultPrimaryImageAspectRatio()

Declaration
public override double GetDefaultPrimaryImageAspectRatio()
Returns
Type Description
System.Double
Overrides

GetIdsForAncestorIdsQuery(User, IDataContext)

Declaration
public override long[] GetIdsForAncestorIdsQuery(User user, IDataContext dataContext)
Parameters
Type Name Description
User user
IDataContext dataContext
Returns
Type Description
System.Int64[]
Overrides

GetItemIdsInternal(InternalItemsQuery, IDataContext)

Declaration
protected override long[] GetItemIdsInternal(InternalItemsQuery query, IDataContext dataContext)
Parameters
Type Name Description
InternalItemsQuery query
IDataContext dataContext
Returns
Type Description
System.Int64[]
Overrides

GetItemsForAncestorIdsQuery(User, IDataContext)

Declaration
public override BaseItem[] GetItemsForAncestorIdsQuery(User user, IDataContext dataContext)
Parameters
Type Name Description
User user
IDataContext dataContext
Returns
Type Description
BaseItem[]
Overrides

GetItemsInternal(InternalItemsQuery, IDataContext)

Declaration
protected override QueryResult<BaseItem> GetItemsInternal(InternalItemsQuery query, IDataContext dataContext)
Parameters
Type Name Description
InternalItemsQuery query
IDataContext dataContext
Returns
Type Description
QueryResult<BaseItem>
Overrides

GetLatestItemsOrderBy()

Declaration
public (string, SortOrder)[] GetLatestItemsOrderBy()
Returns
Type Description
System.ValueTuple<System.String, SortOrder>[]

GetLibraryOptions()

Declaration
public LibraryOptions GetLibraryOptions()
Returns
Type Description
LibraryOptions

GetLibraryOptions(IDataContext)

Declaration
public LibraryOptions GetLibraryOptions(IDataContext dataContext)
Parameters
Type Name Description
IDataContext dataContext
Returns
Type Description
LibraryOptions

GetLibraryOptions(Int64, IDataContext)

Declaration
public static LibraryOptions GetLibraryOptions(long libraryItemId, IDataContext dataContext)
Parameters
Type Name Description
System.Int64 libraryItemId
IDataContext dataContext
Returns
Type Description
LibraryOptions

GetPhysicalFolderIds(IDataContext)

Declaration
public long[] GetPhysicalFolderIds(IDataContext dataContext)
Parameters
Type Name Description
IDataContext dataContext
Returns
Type Description
System.Int64[]

GetPhysicalFolderItems(InternalItemsQuery)

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

GetPhysicalFolders(InternalItemsQuery, IDataContext)

Declaration
public QueryResult<BaseItem> GetPhysicalFolders(InternalItemsQuery query, IDataContext dataContext)
Parameters
Type Name Description
InternalItemsQuery query
IDataContext dataContext
Returns
Type Description
QueryResult<BaseItem>

GetRefreshProgress()

Declaration
public override double? GetRefreshProgress()
Returns
Type Description
System.Nullable<System.Double>
Overrides

GetSupportedItemLinkTypes()

Declaration
public override List<ItemLinkType> GetSupportedItemLinkTypes()
Returns
Type Description
System.Collections.Generic.List<ItemLinkType>
Overrides

IsSaveLocalImagesEnabled(LibraryOptions)

Declaration
public override bool IsSaveLocalImagesEnabled(LibraryOptions libraryOptions)
Parameters
Type Name Description
LibraryOptions libraryOptions
Returns
Type Description
System.Boolean
Overrides

IsVisible(User)

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

OnCollectionFolderChange(Int64)

Declaration
public static void OnCollectionFolderChange(long libraryItemId)
Parameters
Type Name Description
System.Int64 libraryItemId

SaveLibraryOptions(Int64, LibraryOptions)

Declaration
public static void SaveLibraryOptions(long libraryItemId, LibraryOptions options)
Parameters
Type Name Description
System.Int64 libraryItemId
LibraryOptions options

UpdateLibraryOptions(LibraryOptions)

Declaration
public void UpdateLibraryOptions(LibraryOptions options)
Parameters
Type Name Description
LibraryOptions options

Events

LibraryOptionsUpdated

Declaration
public static event EventHandler<GenericEventArgs<Tuple<CollectionFolder, LibraryOptions>>> LibraryOptionsUpdated
Event Type
Type Description
System.EventHandler<GenericEventArgs<System.Tuple<CollectionFolder, LibraryOptions>>>

Implements

Extension Methods