Class BoxSet
Inherited Members
Namespace: MediaBrowser.Controller.Entities
Assembly: MediaBrowser.Controller.dll
Syntax
public class BoxSet : Folder, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IItemByName, IHasFolderGroupingProperties
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.String | The containing folder path. |
Overrides
DisplayOrder
Declaration
[IgnoreDataMember]
public CollectionDisplayOrder DisplayOrder { get; set; }Property Value
| Type | Description |
|---|---|
| CollectionDisplayOrder |
IsDisplayedAsFolder
Declaration
[IgnoreDataMember]
public override bool IsDisplayedAsFolder { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsAncestors
Declaration
[IgnoreDataMember]
public override bool SupportsAncestors { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsCollections
Declaration
[IgnoreDataMember]
public override bool SupportsCollections { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsExternalTransfer
Declaration
[IgnoreDataMember]
public override bool SupportsExternalTransfer { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsGenres
Declaration
[IgnoreDataMember]
public override bool SupportsGenres { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsInheritedParentImages
Declaration
[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsPeople
Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsResetMetadata
Declaration
[IgnoreDataMember]
public override bool SupportsResetMetadata { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsTags
Declaration
[IgnoreDataMember]
public override bool SupportsTags { 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
Methods
AllowEditingField(MetadataFields)
Declaration
public override bool AllowEditingField(MetadataFields field)Parameters
| Type | Name | Description |
|---|---|---|
| MetadataFields | field |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
CanDelete()
Declaration
public override bool CanDelete()Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
EnableImageCaching(LibraryOptions)
Declaration
public override bool EnableImageCaching(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
GetDefaultPrimaryImageAspectRatio()
Declaration
public override double GetDefaultPrimaryImageAspectRatio()Returns
| Type | Description |
|---|---|
| System.Double |
Overrides
GetDisplayOrderIntValue()
Declaration
public override int? GetDisplayOrderIntValue()Returns
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Overrides
GetInternalMetadataPath(String)
Declaration
protected override string GetInternalMetadataPath(string basePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | basePath |
Returns
| Type | Description |
|---|---|
| System.String |
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
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
GetMediaContainingFolderPath(LibraryOptions)
Declaration
public override string GetMediaContainingFolderPath(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])
Declaration
public override bool IsAuthorizedToDelete(User user, UserItemShareLevel shareLevel, Folder[] collectionFolders)Parameters
| Type | Name | Description |
|---|---|---|
| User | user | |
| UserItemShareLevel | shareLevel | |
| Folder[] | collectionFolders |
Returns
| Type | Description |
|---|---|
| System.Boolean |