Class BaseItemResolver<T>
Inheritance
System.Object
BaseItemResolver<T>
Namespace: MediaBrowser.Controller.Resolvers
Assembly: MediaBrowser.Controller.dll
Syntax
public abstract class BaseItemResolver<T> : IItemResolver, IMultiItemResolver where T : BaseItem, new()
Type Parameters
Name | Description |
---|---|
T |
Constructors
BaseItemResolver(ILibraryManager, ILogger)
Declaration
protected BaseItemResolver(ILibraryManager libraryManager, ILogger logger)
Parameters
Type | Name | Description |
---|---|---|
ILibraryManager | libraryManager | |
ILogger | logger |
Fields
LibraryManager
Declaration
protected readonly ILibraryManager LibraryManager
Field Value
Type | Description |
---|---|
ILibraryManager |
Logger
Declaration
protected ILogger Logger
Field Value
Type | Description |
---|---|
ILogger |
MixedContentIgnoreFolders
Declaration
protected Dictionary<string, string> MixedContentIgnoreFolders
Field Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.String> |
Properties
ForceMixedFolder
Declaration
protected virtual bool ForceMixedFolder { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Priority
Gets the priority.
Declaration
public virtual ResolverPriority Priority { get; }
Property Value
Type | Description |
---|---|
ResolverPriority | The priority. |
Methods
ContainsIgnoreFile(FileSystemMetadata[], IDirectoryService)
Declaration
protected bool ContainsIgnoreFile(FileSystemMetadata[] subChildren, IDirectoryService directoryService)
Parameters
Type | Name | Description |
---|---|---|
FileSystemMetadata[] | subChildren | |
IDirectoryService | directoryService |
Returns
Type | Description |
---|---|
System.Boolean |
CreateItem<TItem>()
Declaration
protected TItem CreateItem<TItem>()
where TItem : BaseItem, new()
Returns
Type | Description |
---|---|
TItem |
Type Parameters
Name | Description |
---|---|
TItem |
DontCollapseSingleItemFolders(LibraryOptions)
Declaration
protected virtual bool DontCollapseSingleItemFolders(LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
LibraryOptions | libraryOptions |
Returns
Type | Description |
---|---|
System.Boolean |
FilterOriginalFiles(List<FileSystemMetadata>, LibraryOptions)
Declaration
protected virtual List<FileSystemMetadata> FilterOriginalFiles(List<FileSystemMetadata> files, LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<FileSystemMetadata> | files | |
LibraryOptions | libraryOptions |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<FileSystemMetadata> |
GetFileSystemEntries(IDirectoryService, String)
Declaration
protected FileSystemMetadata[] GetFileSystemEntries(IDirectoryService directoryService, string path)
Parameters
Type | Name | Description |
---|---|---|
IDirectoryService | directoryService | |
System.String | path |
Returns
Type | Description |
---|---|
FileSystemMetadata[] |
IgnoreFile(FileSystemMetadata, BaseItem, LibraryOptions)
Declaration
protected bool IgnoreFile(FileSystemMetadata file, BaseItem parent, LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
FileSystemMetadata | file | |
BaseItem | parent | |
LibraryOptions | libraryOptions |
Returns
Type | Description |
---|---|
System.Boolean |
IsSupportedFile(FileSystemMetadata, LibraryOptions)
Declaration
protected virtual bool IsSupportedFile(FileSystemMetadata file, LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
FileSystemMetadata | file | |
LibraryOptions | libraryOptions |
Returns
Type | Description |
---|---|
System.Boolean |
IsSupportedFile(FileSystemMetadata, List<FileSystemMetadata>, LibraryOptions)
Declaration
protected virtual bool IsSupportedFile(FileSystemMetadata file, List<FileSystemMetadata> allFiles, LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
FileSystemMetadata | file | |
System.Collections.Generic.List<FileSystemMetadata> | allFiles | |
LibraryOptions | libraryOptions |
Returns
Type | Description |
---|---|
System.Boolean |
LeaveFileInLeftOverFiles(FileSystemMetadata, NamingOptions)
Declaration
protected bool LeaveFileInLeftOverFiles(FileSystemMetadata file, NamingOptions namingOptions)
Parameters
Type | Name | Description |
---|---|---|
FileSystemMetadata | file | |
NamingOptions | namingOptions |
Returns
Type | Description |
---|---|
System.Boolean |
OnItemFound<TItem>(TItem, Folder)
Declaration
protected virtual void OnItemFound<TItem>(TItem item, Folder parent)
where TItem : BaseItem
Parameters
Type | Name | Description |
---|---|---|
TItem | item | |
Folder | parent |
Type Parameters
Name | Description |
---|---|
TItem |
Resolve(ItemResolveArgs)
Resolves the specified args.
Declaration
protected virtual T Resolve(ItemResolveArgs args)
Parameters
Type | Name | Description |
---|---|---|
ItemResolveArgs | args | The args. |
Returns
Type | Description |
---|---|
T | `0. |
ResolveItem(ItemResolveArgs, Boolean)
Declaration
protected virtual T ResolveItem(ItemResolveArgs args, bool parseName)
Parameters
Type | Name | Description |
---|---|---|
ItemResolveArgs | args | |
System.Boolean | parseName |
Returns
Type | Description |
---|---|
T |
ResolveMultiple(Folder, List<FileSystemMetadata>, List<FileSystemMetadata>, LibraryOptions, IDirectoryService)
Declaration
public MultiItemResolverResult ResolveMultiple(Folder parent, List<FileSystemMetadata> files, List<FileSystemMetadata> originalFiles, LibraryOptions libraryOptions, IDirectoryService directoryService)
Parameters
Type | Name | Description |
---|---|---|
Folder | parent | |
System.Collections.Generic.List<FileSystemMetadata> | files | |
System.Collections.Generic.List<FileSystemMetadata> | originalFiles | |
LibraryOptions | libraryOptions | |
IDirectoryService | directoryService |
Returns
Type | Description |
---|---|
MultiItemResolverResult |
ResolveMultipleInternal(Folder, List<FileSystemMetadata>, List<FileSystemMetadata>, LibraryOptions, IDirectoryService)
Declaration
protected virtual MultiItemResolverResult ResolveMultipleInternal(Folder parent, List<FileSystemMetadata> files, List<FileSystemMetadata> originalFiles, LibraryOptions libraryOptions, IDirectoryService directoryService)
Parameters
Type | Name | Description |
---|---|---|
Folder | parent | |
System.Collections.Generic.List<FileSystemMetadata> | files | |
System.Collections.Generic.List<FileSystemMetadata> | originalFiles | |
LibraryOptions | libraryOptions | |
IDirectoryService | directoryService |
Returns
Type | Description |
---|---|
MultiItemResolverResult |
SupportsLibrary(LibraryOptions)
Declaration
protected virtual bool SupportsLibrary(LibraryOptions libraryOptions)
Parameters
Type | Name | Description |
---|---|---|
LibraryOptions | libraryOptions |
Returns
Type | Description |
---|---|
System.Boolean |
Explicit Interface Implementations
IItemResolver.ResolvePath(ItemResolveArgs)
Resolves the path.
Declaration
BaseItem IItemResolver.ResolvePath(ItemResolveArgs args)
Parameters
Type | Name | Description |
---|---|---|
ItemResolveArgs | args | The args. |
Returns
Type | Description |
---|---|
BaseItem | BaseItem. |