DeleteAttachmentWebFarmTask Class

Web farm task used to delete attachments.

Inheritance Hierarchy

System.Object
  CMS.Core.WebFarmTaskBase
    CMS.DocumentEngine.DeleteAttachmentWebFarmTask

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

Syntax

public class DeleteAttachmentWebFarmTask : WebFarmTaskBase

The DeleteAttachmentWebFarmTask type exposes the following members.

Constructors

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

Properties

	Name	Description
Public property	DeleteDirectory	Gets or sets a value that indicates whether directory will be deleted.
Public property	FileGuid	Gets or sets identifier of the file to be deleted.
Public property	SiteName	Gets or sets name of the site which is file 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 if the synchronization of the deletion of the attachments is allowed (Overrides WebFarmTaskBase.ConditionMethod().)
Public method	ExecuteTask	Processes the web farm task by invoking the DeleteFile(Guid, String, Boolean, Boolean) method while passing it current class' properties as its parameters. (Overrides WebFarmTaskBase.ExecuteTask().)