MediaLibraryInfoProvider Class

Class providing media library info management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<MediaLibraryInfo, MediaLibraryInfoProvider, ObjectQuery<MediaLibraryInfo>>
    CMS.DataEngine.AbstractInfoProvider<MediaLibraryInfo, MediaLibraryInfoProvider>
      CMS.MediaLibrary.MediaLibraryInfoProvider

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

Syntax

public class MediaLibraryInfoProvider : AbstractInfoProvider<MediaLibraryInfo, MediaLibraryInfoProvider>

The MediaLibraryInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	MediaLibraryInfoProvider	Constructor

Fields

	Name	Description
Public field Static member	CURRENT_LIBRARY	Current media library.
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 Static member	DeletePhysicalFiles	Indicates if media files physical files should be deleted.
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	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	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	CombineSecurityWhereCondition	Add security where condition to the existing where condition.
Protected method	CombineSecurityWhereConditionInternal	Add security where condition to the existing where condition.
Public method Static member	CopyMediaLibraryFolder	Copy media library folder.
Protected method	CopyMediaLibraryFolderInternal	Copy media library folder.
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 Static member	CreateMediaLibraryFolder	Creates folder within specified library.
Protected method	CreateMediaLibraryFolderInternal	Creates folder within specified library.
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>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteMediaLibrariesFolders	Delete all media libraries folders.
Protected method	DeleteMediaLibrariesFoldersInternal	Delete all media libraries folders.
Public method Static member	DeleteMediaLibrariesInfos	Delete media libraries only from database for selected group.
Public method Static member	DeleteMediaLibraryFolder(String, String, Boolean, Boolean)	Delete media library root folder from media root directory. ~/[site name]/media/
Public method Static member	DeleteMediaLibraryFolder(String, Int32, String, Boolean, Boolean)	Delete folder from media library.
Protected method	DeleteMediaLibraryFolderInternal(String, String, Boolean, Boolean)	Delete media library root folder from media root directory. ~/[site name]/media/
Protected method	DeleteMediaLibraryFolderInternal(String, Int32, String, Boolean, Boolean)	Delete folder from media library.
Public method Static member	DeleteMediaLibraryInfo(Int32)	Deletes specified media library.
Public method Static member	DeleteMediaLibraryInfo(MediaLibraryInfo)	Deletes specified media library.
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	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	GetInfoById	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	GetMediaLibraries()	Returns the query for all media libraries.
Public method Static member	GetMediaLibraries(String, String, Int32, String)	Returns information on libraries matching specified criteria.
Public method Static member	GetMediaLibraryFolderPath(Int32, String)	Returns physical path to the specified library.
Public method Static member	GetMediaLibraryFolderPath(Int32, String, String)	Returns physical path to the specified library.
Public method Static member	GetMediaLibraryFolderPath(String, String, String)	Returns physical path to the specified library folder.
Public method Static member	GetMediaLibraryFolderPath(MediaLibraryInfo, String, String)	Gets the folder path for the given media library
Protected method	GetMediaLibraryFolderPathInternal	Returns physical path to the specified library folder.
Public method Static member	GetMediaLibraryInfo(Int32)	Returns the MediaLibraryInfo structure for the specified media library.
Public method Static member	GetMediaLibraryInfo(String, String)	Returns media library info specified by library name and site name. Do not use for retrieving group MLs (use GetMediaLibraryInfo(string libraryName, int siteId, int groupId) instead).
Public method Static member	GetMediaLibraryInfo(String, Int32, Int32)	Returns media library info specified by library name, site name and groupId.
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>.)
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>.)
Public method Static member	IsUserAuthorizedPerLibrary	Returns True if current user is granted with specified media library permission, otherwise returns False.
Protected method	IsUserAuthorizedPerLibraryInternal	Returns True if current user is granted with specified media library permission, otherwise returns False.
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	MoveMediaLibraryFolder	Moves media library folder.
Protected method	MoveMediaLibraryFolderInternal	Moves media library folder.
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	RenameMediaLibraryFolder	Rename folder within specified library.
Protected method	RenameMediaLibraryFolderInternal	Rename folder within specified library.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Public method Static member	SetMediaLibraryInfo	Sets (updates or inserts) specified media library.
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>.)