MediaLibraryHelper Class

Class providing helper methods for media library.

Inheritance Hierarchy

System.Object
  CMS.MediaLibrary.MediaLibraryHelper

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

Syntax

public class MediaLibraryHelper

The MediaLibraryHelper type exposes the following members.

Constructors

	Name	Description
Public method	MediaLibraryHelper

Fields

	Name	Description
Public field Static member	OBJECT_TYPE_FOLDER	Object type for abstract media folder.
Public field Static member	URL_PARAMETER_USE_THUMBNAIL_FOR_NON_RESIZABLE_IMAGE	This parameter is added to the url to retrieve thumbnail of non-editable image for which we cannot get dimensions (e.g. webp or svg files).

Properties

	Name	Description
Public property Static member	MediaLibraryCustomPath	Custom path to media library.
Public property Static member	SuffixRegex	Suffix regex for files and folders.

Methods

	Name	Description
Public method Static member	CloneLibraryFiles	Clone media library files and folder to new media library.
Public method Static member	CopyRecursive(Int32, DirectoryInfo, String, String, Int32, String, Boolean, Int32)	Recursive copy media library directory.
Public method Static member	CopyRecursive(Int32, Int32, DirectoryInfo, String, String, Int32, String, Boolean, Int32, Boolean, CloneSettings, CloneResult)	Recursive copy media library directory.
Public method Static member	EnsurePhysicalPath	Returns file path with slashes by DirectorySeparatorChar.
Public method Static member	EnsureUniqueDirectory	Ensures unique path for the specified directory. If the directory with the specified name already exist in the target location new path with the added suffix is returned. The suffix consist of '_' sign and the number.
Public method Static member	EnsureUniqueFileName	Ensures unique path for the specified file. If the directory with the specified name already exist in the target location new path with the added suffix is returned. The suffix consist of '_' sign and the number.
Public method Static member	GetAccessDeniedMessage	Returns access denied message for specified permission.
Public method Static member	GetAllowedExtensions	Returns allowed extensions list from settings.
Public method Static member	GetDirectUrl	Returns a direct URL to the media file.
Public method Static member	GetMediaFileHiddenFolder	Returns media file hidden folder name from settings.
Public method Static member	GetMediaFilePreviewSuffix	Returns media file preview suffix from settings.
Public method Static member	GetMediaLibrariesFolder	Returns root folder from settings where all media libraries are stored.
Public method Static member	GetMediaRootFolderPath	Returns physical path to the directory where all media libraries are stored.
Public method Static member	GetPermanentUrl	Returns a permanent URL to the media file.
Public method Static member	GetPreviewFileName	Returns media file preview file name.
Public method Static member	GetPreviewFilePath	Returns media file preview file path.
Public method Static member	GetTaskTitle	Gets task title.
Public method Static member	HasPreview	Returns true if file has preview file.
Public method Static member	IsExtensionAllowed	Determines whether the file with the specified extension (case insensitive) can be uploaded into library module on site specified by name.
Public method Static member	IsExternalLibrary	Returns true if media library root folder is outside of CMS.
Public method Static member	LogSynchronization(String, Int32, String, String, TaskTypeEnum, Boolean)	Logs the synchronization task for media folder.
Public method Static member	LogSynchronization(String, Int32, String, String, TaskTypeEnum, Int32)	Logs the synchronization task for media folder.
Public method Static member	LogSynchronization(String, Int32, String, String, TaskTypeEnum, Int32, Boolean)	Logs the synchronization task for media folder.
Public method Static member	MoveMediaFilePreview	Moves preview file into new location according new media file name.
Public method Static member	UseMediaLibrariesSiteFolder	Gets the value that indicates if site-specific folder should be used for media files physical files.