Click or drag to resize
MediaFileInfoProvider Class
Class providing media file info management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderMediaFileInfo, MediaFileInfoProvider, ObjectQueryMediaFileInfo
    CMS.DataEngineAbstractInfoProviderMediaFileInfo, MediaFileInfoProvider
      CMS.MediaLibraryMediaFileInfoProvider

Namespace: CMS.MediaLibrary
Assembly: CMS.MediaLibrary (in CMS.MediaLibrary.dll) Version: 12.0.0
Syntax
C#
public class MediaFileInfoProvider : AbstractInfoProvider<MediaFileInfo, MediaFileInfoProvider>

The MediaFileInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodMediaFileInfoProvider
Top
Fields
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberMaxStagingFileSize
Gets the maximal file size in bytes which is allowed for media files staging synchronization.
Public propertyStatic memberMaxVersioningFileSize
Gets the maximal file size in bytes which is allowed for media files versioning.
Public propertyStatic memberThumbnailQuality
Thumbnail quality.
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberCanResizeImage(String, Int32, Int32, Int32)
Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public methodStatic memberCanResizeImage(MediaFileInfo, Int32, Int32, Int32)
Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberCopyMediaFile
Copy media file.
Protected methodCopyMediaFileInternal
Copy media file.
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteMediaFile
Deletes media file from file system.
Public methodStatic memberDeleteMediaFileInfo(Int32)
Deletes specified media file.
Public methodStatic memberDeleteMediaFileInfo(MediaFileInfo)
Deletes specified media file.
Protected methodDeleteMediaFileInfoInternal
Deletes specified media file.
Protected methodDeleteMediaFileInternal
Deletes media file from filesystem.
Public methodStatic memberDeleteMediaFilePreview
Deletes media file preview from file system.
Protected methodDeleteMediaFilePreviewInternal
Deletes media file preview from filesystem.
Public methodStatic memberDeleteMediaFilePreviewThumbnails
Deletes media file preview thumbnails.
Protected methodDeleteMediaFilePreviewThumbnailsInternal
Deletes media file preview thumbnails.
Public methodStatic memberDeleteMediaFiles
Deletes file records of files matching specified criteria.
Protected methodDeleteMediaFilesInternal
Deletes file records of files matching specified criteria.
Public methodStatic memberDeleteMediaFileThumbnails
Deletes media file thumbnails.
Protected methodDeleteMediaFileThumbnailsInternal
Deletes media file thumbnails.
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberEnsureThumbnailFile
Ensures the thumbnail file.
Protected methodEnsureThumbnailFileInternal
Ensures the thumbnail file.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetDependencyCacheKeys
Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).
Protected methodGetDependencyCacheKeysInternal
Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).
Public methodStatic memberGetFile
Returns the file from disk or (if not available on the disk) from database.
Protected methodGetFileInternal
Returns the file from disk or (if not available on the disk) from database.
Public methodStatic memberGetImageThumbnail
Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Protected methodGetImageThumbnailInternal
Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetMediaFileAbsoluteUrl(Guid, String) Obsolete.
Returns absolute URL path for current domain to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked
Public methodStatic memberGetMediaFileAbsoluteUrl(String, Guid, String) Obsolete.
Returns absolute URL path to the media file including http:// which is rewritten to calling GetMediaFile.aspx page where user permissions are checked
Public methodStatic memberGetMediaFileAbsoluteUrl(String, String, String) Obsolete.
Returns absolute URL path to the media file including http://, user permissions are not checked
Public methodStatic memberGetMediaFileInfo(Int32)
Returns the MediaFileInfo structure for the specified media file.
Public methodStatic memberGetMediaFileInfo(Guid, String)
Returns media file with specified GUID.
Public methodStatic memberGetMediaFileInfo(Int32, String)
Returns the MediaFileInfo structure for the specified media file.
Public methodStatic memberGetMediaFileInfo(String, String, String)
Returns the MediaFileInfo structure for the specified media file.
Protected methodGetMediaFileInfoInternal(Guid, String)
Returns media file with specified GUID.
Protected methodGetMediaFileInfoInternal(Int32, String)
Returns the MediaFileInfo structure for the specified media file.
Protected methodGetMediaFileInfoInternal(String, String, String)
Returns the MediaFileInfo structure for the specified media file.
Public methodStatic memberGetMediaFilePath(Int32, String)
Returns physical path to the media file.
Public methodStatic memberGetMediaFilePath(Int32, String, String)
Returns physical path to the media file.
Public methodStatic memberGetMediaFilePath(MediaFileInfo, String, String)
Returns physical path to the media file.
Public methodStatic memberGetMediaFilePath(String, Int32, String, String)
Returns physical path to the given file path and library.
Public methodStatic memberGetMediaFilePath(String, String, String, String)
Returns physical path to the media file.
Protected methodGetMediaFilePathInternal
Returns physical path to the media file.
Public methodStatic memberGetMediaFiles
Returns the query for all media files.
Public methodStatic memberGetMediaFiles(String, String, Int32, String)
Returns dataset of files matching given criteria from database.
Protected methodGetMediaFilesInternal
Returns the query for all media files.
Public methodStatic memberGetMediaFileUrl(Guid, String) Obsolete.
Returns relative URL path to the media file which is rewritten to calling GetMediaFile.aspx page where user permissions are checked.
Public methodStatic memberGetMediaFileUrl(String, String, String) Obsolete.
Returns relative URL path to the media file, user permissions are not checked.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetPreviewFilePath(MediaFileInfo)
Returns preview file path for media file info. If no preview found returns NULL
Public methodStatic memberGetPreviewFilePath(String, String, Int32)
Returns preview file path for search pattern (.* as extension).
Protected methodGetPreviewFilePathInternal
Returns preview file path for search pattern (.* as extension).
Public methodStatic memberGetThumbnail
Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Protected methodGetThumbnailInternal
Returns image thumbnail from the disk or create a new one if doesn't exist yet.
Public methodStatic memberGetThumbnailPath(Int32, String)
Returns physical path to the thumbnail folder.
Public methodStatic memberGetThumbnailPath(String, String, Int32, String)
Returns physical path to the thumbnail folder.
Public methodStatic memberGetThumbnailPath(String, String, String, String, Int32, Int32, Boolean, Boolean)
Returns physical path to the thumbnail.
Protected methodGetThumbnailPathInternal(String, String, Int32, String)
Returns physical path to the thumbnail folder.
Protected methodGetThumbnailPathInternal(String, String, String, String, Int32, Int32, Boolean, Boolean)
Returns physical path to the thumbnail.
Public methodStatic memberImportMediaFileInfo
Import media file into database.
Protected methodImportMediaFileInfoInternal
Import media file into database.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberMoveMediaFile(String, Int32, String, String, Boolean)
Moves media file within one library.
Public methodStatic memberMoveMediaFile(String, Int32, Int32, String, String, Boolean)
Moves media file.
Protected methodMoveMediaFileInternal
Moves media file.
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSaveFileToDisk
Saves media file to disk and returns the applied file path.
Protected methodSaveFileToDiskInternal
Saves media file to disk and returns the applied file path.
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetMediaFileInfo
Sets (updates or inserts) specified media file.
Protected methodSetMediaFileInfoInternal
Sets MediaFileInfo internal.
Public methodStatic memberShouldResize
Returns true if image should be scaled down.
Protected methodShouldResizeInternal
Returns true if image should be scaled down.
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also