MediaFileInfoProvider Class

Class providing media file info management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<MediaFileInfo, MediaFileInfoProvider, ObjectQuery<MediaFileInfo>>
    CMS.DataEngine.AbstractInfoProvider<MediaFileInfo, MediaFileInfoProvider>
      CMS.MediaLibrary.MediaFileInfoProvider

Namespace: CMS.MediaLibrary
Assembly: CMS.MediaLibrary (in CMS.MediaLibrary.dll) Version: 13.0.131

Syntax

public class MediaFileInfoProvider : AbstractInfoProvider<MediaFileInfo, MediaFileInfoProvider>, 
	IMediaFileInfoProvider, IInfoProvider<MediaFileInfo>, IInfoByIdProvider<MediaFileInfo>, 
	IInfoBySiteAndGuidProvider<MediaFileInfo>

The MediaFileInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	MediaFileInfoProvider

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	MaxStagingFileSize	Gets the maximal file size in bytes which is allowed for media files staging synchronization.
Public property Static member	MaxVersioningFileSize	Gets the maximal file size in bytes which is allowed for media files versioning.
Public property Static member	ThumbnailQuality	Thumbnail quality.
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CanResizeImage(String, Int32, Int32, Int32)	Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public method Static member	CanResizeImage(MediaFileInfo, Int32, Int32, Int32)	Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CopyMediaFile	Copy media file.
Protected method	CopyMediaFileInternal	Copy media file.
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Delete(TInfo).)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteMediaFile	Deletes media file from file system.
Public method Static member	DeleteMediaFileInfo(Int32)	Obsolete. Deletes specified media file.
Public method Static member	DeleteMediaFileInfo(MediaFileInfo)	Obsolete. Deletes specified media file.
Protected method	DeleteMediaFileInfoInternal	Obsolete. Deletes specified media file.
Protected method	DeleteMediaFileInternal	Deletes media file from filesystem.
Public method Static member	DeleteMediaFilePreview	Deletes media file preview from file system.
Protected method	DeleteMediaFilePreviewInternal	Deletes media file preview from filesystem.
Public method Static member	DeleteMediaFilePreviewThumbnails	Deletes media file preview thumbnails.
Protected method	DeleteMediaFilePreviewThumbnailsInternal	Deletes media file preview thumbnails.
Public method Static member	DeleteMediaFiles	Deletes file records of files matching specified criteria.
Protected method	DeleteMediaFilesInternal	Deletes file records of files matching specified criteria.
Public method Static member	DeleteMediaFileThumbnails	Deletes media file thumbnails.
Protected method	DeleteMediaFileThumbnailsInternal	Deletes media file thumbnails.
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	EnsureThumbnailFile	Ensures the thumbnail file.
Protected method	EnsureThumbnailFileInternal	Ensures the thumbnail file.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetDependencyCacheKeys	Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).
Protected method	GetDependencyCacheKeysInternal	Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).
Public method Static member	GetFile	Returns the file from disk or (if not available on the disk) from database.
Protected method	GetFileInternal	Returns the file from disk or (if not available on the disk) from database.
Public method Static member	GetImageThumbnail	Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Protected method	GetImageThumbnailInternal	Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetMediaFileInfo(Int32)	Obsolete. Returns the MediaFileInfo structure for the specified media file.
Public method Static member	GetMediaFileInfo(Guid, String)	Obsolete. Returns media file with specified GUID.
Public method Static member	GetMediaFileInfo(Int32, String)	Returns the MediaFileInfo structure for the specified media file.
Public method Static member	GetMediaFileInfo(String, String, String)	Returns the MediaFileInfo structure for the specified media file.
Protected method	GetMediaFileInfoInternal(Guid, String)	Returns media file with specified GUID.
Protected method	GetMediaFileInfoInternal(Int32, String)	Returns the MediaFileInfo structure for the specified media file.
Protected method	GetMediaFileInfoInternal(String, String, String)	Returns the MediaFileInfo structure for the specified media file.
Public method Static member	GetMediaFilePath(Int32, String)	Returns physical path to the media file.
Public method Static member	GetMediaFilePath(Int32, String, String)	Returns physical path to the media file.
Public method Static member	GetMediaFilePath(MediaFileInfo, String, String)	Returns physical path to the media file.
Public method Static member	GetMediaFilePath(String, Int32, String, String)	Returns physical path to the given file path and library.
Public method Static member	GetMediaFilePath(String, String, String, String)	Returns physical path to the media file.
Protected method	GetMediaFilePathInternal	Returns physical path to the media file.
Public method Static member	GetMediaFiles()	Obsolete. Returns the query for all media files.
Public method Static member	GetMediaFiles(String, String, Int32, String)	Returns dataset of files matching given criteria from database.
Protected method	GetMediaFilesInternal	Returns the query for all media files.
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetPreviewFilePath(MediaFileInfo)	Returns preview file path for media file info. If no preview found returns NULL
Public method Static member	GetPreviewFilePath(String, String, Int32)	Returns preview file path for search pattern (.* as extension).
Protected method	GetPreviewFilePathInternal	Returns preview file path for search pattern (.* as extension).
Public method Static member	GetThumbnail	Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Protected method	GetThumbnailInternal	Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Public method Static member	GetThumbnailPath(Int32, String)	Returns physical path to the thumbnail folder.
Public method Static member	GetThumbnailPath(String, String, Int32, String)	Returns physical path to the thumbnail folder.
Public method Static member	GetThumbnailPath(String, String, String, String, Int32, Int32, Boolean, Boolean)	Returns physical path to the thumbnail.
Protected method	GetThumbnailPathInternal(String, String, Int32, String)	Returns physical path to the thumbnail folder.
Protected method	GetThumbnailPathInternal(String, String, String, String, Int32, Int32, Boolean, Boolean)	Returns physical path to the thumbnail.
Public method Static member	ImportMediaFileInfo	Import media file into database.
Protected method	ImportMediaFileInfoInternal	Import media file into database.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	MoveMediaFile(String, Int32, String, String, Boolean)	Moves media file within one library.
Public method Static member	MoveMediaFile(String, Int32, Int32, String, String, Boolean)	Moves media file.
Protected method	MoveMediaFileInternal	Moves media file.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SaveFileToDisk	Saves media file to disk and returns the applied file path.
Protected method	SaveFileToDiskInternal	Saves media file to disk and returns the applied file path.
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetMediaFileInfo	Obsolete. Sets (updates or inserts) specified media file.
Protected method	SetMediaFileInfoInternal	Obsolete. Sets MediaFileInfo internal.
Public method Static member	ShouldResize	Returns true if image should be scaled down.
Protected method	ShouldResizeInternal	Returns true if image should be scaled down.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)