MediaLibraryHelper Class

Class providing helper methods for media library.

Inheritance Hierarchy

System.Object
  CMS.MediaLibrary.MediaLibraryHelper
    CMS.MediaLibrary.MediaHelper

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

Syntax

public class MediaLibraryHelper

The MediaLibraryHelper type exposes the following members.

Constructors

	Name	Description
Public method	MediaLibraryHelper

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)	Obsolete. Recursive copy media library directory.
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	Return file path with replaced slash ("/") to back slash ("\").
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	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	GetMediaFileUrl	Returns media file URL according to site 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	GetMediaSource(Guid, String)	Returns MediaSource for given media file.
Public method Static member	GetMediaSource(String, String, String)	Returns MediaSource for given media file.
Public method Static member	GetPermissionMatrix	Obsolete. Returns the permission matrix for the specified media library.
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(String)	Obsolete. Returns true if media library root folder is outside of CMS.
Public method Static member	IsExternalLibrary(String, String)	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	ShowPreviewOrIcon	Show preview file if exists or file icon.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	OBJECT_TYPE_FOLDER	Object type for abstract media folder.

Properties

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