Class BoxSet
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public class BoxSet : Folder, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IItemByName, IHasFolderGrouping
Properties
ContainingFolderPath
Returns the folder containing the item. If the item is a folder, it returns the folder itself
Declaration
[IgnoreDataMember]
public override string ContainingFolderPath { get; }
Property Value
Type | Description |
---|---|
System. |
The containing folder path. |
Overrides
DisplayOrder
Declaration
[IgnoreDataMember]
public CollectionDisplayOrder DisplayOrder { get; set; }
Property Value
Type | Description |
---|---|
Collection |
IsDisplayedAsFolder
Declaration
[IgnoreDataMember]
public override bool IsDisplayedAsFolder { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsAncestors
Declaration
[IgnoreDataMember]
public override bool SupportsAncestors { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsCollections
Declaration
[IgnoreDataMember]
public override bool SupportsCollections { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsExternalTransfer
Declaration
[IgnoreDataMember]
public override bool SupportsExternalTransfer { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsGenres
Declaration
[IgnoreDataMember]
public override bool SupportsGenres { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsInheritedParentImages
Declaration
[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsPeople
Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsResetMetadata
Declaration
[IgnoreDataMember]
public override bool SupportsResetMetadata { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
SupportsTags
Declaration
[IgnoreDataMember]
public override bool SupportsTags { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
UpdateChildrenOnLockStateChange
Declaration
[IgnoreDataMember]
public override bool UpdateChildrenOnLockStateChange { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
ValidatesChildren
Declaration
[IgnoreDataMember]
protected override bool ValidatesChildren { get; }
Property Value
Type | Description |
---|---|
System. |
Overrides
Methods
AllowEditingField(MetadataFields)
Declaration
public override bool AllowEditingField(MetadataFields field)
Parameters
Type | Name | Description |
---|---|---|
Metadata |
field |
Returns
Type | Description |
---|---|
System. |
Overrides
CanDelete()
Declaration
public override bool CanDelete()
Returns
Type | Description |
---|---|
System. |
Overrides
EnableImageCaching(LibraryOptions)
Declaration
public override bool EnableImageCaching(LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
Library |
libraryOptions |
Returns
Type | Description |
---|---|
System. |
Overrides
GetDefaultPrimaryImageAspectRatio()
Declaration
public override double GetDefaultPrimaryImageAspectRatio()
Returns
Type | Description |
---|---|
System. |
Overrides
GetDisplayOrderIntValue()
Declaration
public override int? GetDisplayOrderIntValue()
Returns
Type | Description |
---|---|
System. |
Overrides
GetInternalMetadataPath(String)
Declaration
protected override string GetInternalMetadataPath(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System. |
basePath |
Returns
Type | Description |
---|---|
System. |
Overrides
GetItemIdsInternal(InternalItemsQuery, IDataContext, CancellationToken)
Declaration
protected override long[] GetItemIdsInternal(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
Internal |
query | |
IData |
dataContext | |
System. |
cancellationToken |
Returns
Type | Description |
---|---|
System. |
Overrides
GetItemsInternal(InternalItemsQuery, IDataContext, CancellationToken)
Declaration
protected override QueryResult<BaseItem> GetItemsInternal(InternalItemsQuery query, IDataContext dataContext, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
Internal |
query | |
IData |
dataContext | |
System. |
cancellationToken |
Returns
Type | Description |
---|---|
Query |
Overrides
GetMediaContainingFolderPath(LibraryOptions, CancellationToken)
Declaration
public override string GetMediaContainingFolderPath(LibraryOptions libraryOptions, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
Library |
libraryOptions | |
System. |
cancellationToken |
Returns
Type | Description |
---|---|
System. |
Overrides
IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])
Declaration
public override bool IsAuthorizedToDelete(User user, UserItemShareLevel shareLevel, Folder[] collectionFolders)
Parameters
Type | Name | Description |
---|---|---|
User | user | |
User |
shareLevel | |
Folder[] | collectionFolders |
Returns
Type | Description |
---|---|
System. |