DeleteFileMediaWebFarmTask Class

Web farm task used to delete media files.

Inheritance Hierarchy

System.Object
  CMS.Core.WebFarmTaskBase
    CMS.MediaLibrary.DeleteFileMediaWebFarmTask

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

Syntax

public class DeleteFileMediaWebFarmTask : WebFarmTaskBase

The DeleteFileMediaWebFarmTask type exposes the following members.

Constructors

	Name	Description
Public method	DeleteFileMediaWebFarmTask	Initializes a new instance of DeleteFileMediaWebFarmTask.

Properties

	Name	Description
Public property	ApplyOnlyOnFiles	Gets or sets a value that indicates if media deletion will be executed only on files.
Public property	DestinationLibraryId	Gets or sets identifier of the library where file will be deleted.
Public property	DestinationPath	Gets or sets relative path where file will be deleted.
Public property	SiteId	Gets or sets identifier of the site which destination library is assigned to.
Public property	TaskBinaryData	Gets or sets the binary representation of data. (Inherited from WebFarmTaskBase.)
Public property	TaskFilePath	Gets or sets target path of file transported by task. (Inherited from WebFarmTaskBase.)
Public property	TaskTarget	Gets or sets task target. (Inherited from WebFarmTaskBase.)

Methods

	Name	Description
Public method	ConditionMethod	Returns true whether the synchronization for deleting media files is allowed and provided storage is not shared. (Overrides WebFarmTaskBase.ConditionMethod().)
Public method	ExecuteTask	Processes the web farm task by invoking the DeleteMediaFile(Int32, Int32, String, Boolean, Boolean) method while passing it current class' properties as its parameters. (Overrides WebFarmTaskBase.ExecuteTask().)