Table of Contents

Class MediaLibraryInfoProvider

Namespace
CMS.MediaLibrary
Assembly
CMS.MediaLibrary.dll

Class providing media library info management.

[ProviderInterface(typeof(IMediaLibraryInfoProvider))]
[Obsolete("Media libraries and their APIs are obsolete and will be discontinued in the future. Please migrate all media library files to Content hub and use their corresponding content item APIs.")]
public class MediaLibraryInfoProvider : AbstractInfoProvider<MediaLibraryInfo, MediaLibraryInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<MediaLibraryInfo>, IInfoByGuidProvider<MediaLibraryInfo>, IBulkInfoProvider<MediaLibraryInfo>, IMediaLibraryInfoProvider, IInfoProvider<MediaLibraryInfo>, IInfoByIdProvider<MediaLibraryInfo>, IInfoByNameProvider<MediaLibraryInfo>
Inheritance
object
MediaLibraryInfoProvider
Implements
Inherited Members
Extension Methods

Constructors

MediaLibraryInfoProvider()

Constructor

public MediaLibraryInfoProvider()

Fields

CURRENT_LIBRARY

Current media library.

public const string CURRENT_LIBRARY = "##CURRENT_LIBRARY##"

Field Value

string

Properties

DeletePhysicalFiles

Indicates if media files physical files should be deleted.

public static bool DeletePhysicalFiles { get; set; }

Property Value

bool

Methods

CopyMediaLibraryFolder(int, string, string, int, bool)

Copy media library folder.

public static void CopyMediaLibraryFolder(int libraryID, string origPath, string newPath, int userId, bool synchronization = false)

Parameters

libraryID int

Library ID

origPath string

Old folder path within the library folder

newPath string

New folder path within the library folder

userId int

ID of the user performing the action

synchronization bool

Indicates if method is running by web farms synchronization

CopyMediaLibraryFolderInternal(int, string, string, bool, int)

Copy media library folder.

protected virtual void CopyMediaLibraryFolderInternal(int libraryID, string origPath, string newPath, bool synchronization, int userId)

Parameters

libraryID int

Library ID

origPath string

Old folder path within the library folder

newPath string

New folder path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

userId int

ID of the user performing the action

CreateMediaLibraryFolder(int, string, bool)

Creates folder within specified library.

public static void CreateMediaLibraryFolder(int libraryID, string newFolderPath, bool synchronization = false)

Parameters

libraryID int

Library ID

newFolderPath string

New folder path

synchronization bool

Indicates if method is running by web farms synchronization

CreateMediaLibraryFolderInternal(int, string, bool)

Creates folder within specified library.

protected virtual void CreateMediaLibraryFolderInternal(int libraryID, string newFolderPath, bool synchronization)

Parameters

libraryID int

Library ID

newFolderPath string

New folder path

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaLibrariesFolders(ArrayList)

Delete all media libraries folders.

public static void DeleteMediaLibrariesFolders(ArrayList folders)

Parameters

folders ArrayList

List of folder to delete

DeleteMediaLibrariesFoldersInternal(ArrayList)

Delete all media libraries folders.

protected virtual void DeleteMediaLibrariesFoldersInternal(ArrayList folders)

Parameters

folders ArrayList

List of folder to delete

DeleteMediaLibraryFolder(int, string, bool)

Delete folder from media library.

public static void DeleteMediaLibraryFolder(int libraryID, string folderPath, bool synchronization)

Parameters

libraryID int

Media library ID

folderPath string

Path to the folder within the library

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaLibraryFolder(string, bool)

Delete media library root folder from media root directory. ~/media/

public static void DeleteMediaLibraryFolder(string folder, bool synchronization)

Parameters

folder string

Media library folder

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaLibraryFolderInternal(int, string, bool)

Delete folder from media library.

protected virtual void DeleteMediaLibraryFolderInternal(int libraryID, string folderPath, bool synchronization)

Parameters

libraryID int

Media library ID

folderPath string

Path to the folder within the library

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaLibraryFolderInternal(string, bool)

Delete media library root folder from media root directory. ~/media/

protected virtual void DeleteMediaLibraryFolderInternal(string folder, bool synchronization)

Parameters

folder string

Media library folder

synchronization bool

Indicates if method is running by web farms synchronization

Get(string)

Gets an instance of info object based on its code name.

public override MediaLibraryInfo Get(string name)

Parameters

name string

Code name of the info object to look for.

Returns

MediaLibraryInfo

Returns an instance of MediaLibraryInfo corresponding to name or null.

GetAsync(string, CancellationToken?)

Asynchronously gets an instance of info object based on its code name.

public override Task<MediaLibraryInfo> GetAsync(string name, CancellationToken? cancellationToken = null)

Parameters

name string

Code name of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<MediaLibraryInfo>

Returns a task returning either an instance of MediaLibraryInfo corresponding to name or null.

GetMediaLibraries(string, string, int, string)

Returns information on libraries matching specified criteria.

public static ObjectQuery<MediaLibraryInfo> GetMediaLibraries(string where, string orderBy = null, int topN = 0, string columns = null)

Parameters

where string

Where condition to filter data

orderBy string

Order by statement to use

topN int

Top N records

columns string

List of columns to be returned

Returns

ObjectQuery<MediaLibraryInfo>

GetMediaLibraryFolderPath(MediaLibraryInfo, string)

Gets the folder path for the given media library

public static string GetMediaLibraryFolderPath(MediaLibraryInfo libInfo, string webFullPath = null)

Parameters

libInfo MediaLibraryInfo

Media library info

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaLibraryFolderPath(int, string)

Returns physical path to the specified library.

public static string GetMediaLibraryFolderPath(int libraryId, string webFullPath = null)

Parameters

libraryId int

Library ID

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaLibraryFolderPath(string, string)

Returns physical path to the specified library folder.

public static string GetMediaLibraryFolderPath(string libraryFolder, string webFullPath = null)

Parameters

libraryFolder string

Library folder name

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaLibraryFolderPathInternal(string, string)

Returns physical path to the specified library folder.

protected virtual string GetMediaLibraryFolderPathInternal(string libraryFolder, string webFullPath = null)

Parameters

libraryFolder string

Library folder name

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

MoveMediaLibraryFolder(int, string, string, bool)

Moves media library folder.

public static void MoveMediaLibraryFolder(int libraryID, string origPath, string newPath, bool synchronization = false)

Parameters

libraryID int

Library ID

origPath string

Old folder path within the library folder

newPath string

New folder path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

MoveMediaLibraryFolderInternal(int, string, string, bool)

Moves media library folder.

protected virtual void MoveMediaLibraryFolderInternal(int libraryID, string origPath, string newPath, bool synchronization)

Parameters

libraryID int

Library ID

origPath string

Old folder path within the library folder

newPath string

New folder path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

RenameMediaLibraryFolder(int, string, string, bool)

Rename folder within specified library.

public static void RenameMediaLibraryFolder(int libraryID, string folderPath, string newFolderPath, bool synchronization = false)

Parameters

libraryID int

Library ID

folderPath string

Original folder path

newFolderPath string

New folder path

synchronization bool

Indicates if method is running by web farms synchronization

RenameMediaLibraryFolderInternal(int, string, string, bool)

Rename folder within specified library.

protected virtual void RenameMediaLibraryFolderInternal(int libraryID, string folderPath, string newFolderPath, bool synchronization)

Parameters

libraryID int

Library ID

folderPath string

Original folder path

newFolderPath string

New folder path

synchronization bool

Indicates if method is running by web farms synchronization

SetInfo(MediaLibraryInfo)

Inserts or Updates the object to the database.

protected override void SetInfo(MediaLibraryInfo info)

Parameters

info MediaLibraryInfo

Object to insert / update

Validate(MediaLibraryInfo)

Validates whether the info object's state satisfies domain specific constraints and returns the validation result.

public override InfoValidationResult Validate(MediaLibraryInfo info)

Parameters

info MediaLibraryInfo

Info object to be validated.

Returns

InfoValidationResult

Returns validation result with IsValid set to true, if info is valid. Otherwise returns result with the flag set to false and a corresponding error message.

Remarks

Implement IInfoValidator<TInfo> and register it into the system to perform domain specific validation for MediaLibraryInfo. The system invokes the registered validators as part of validation performed by this method.

The default implementation validates the code name to contain only allowed characters and to be unique.

Exceptions

ArgumentNullException

Thrown when info is null.

See Also