ContentDownloadHandler Class

Use ContentDownloadHandler to define a custom download handler that controls how content is downloaded.

Namespace

Sfc

ContentDownloadHandler Properties

The following are properties for ContentDownloadHandler.

downloadErrorMessage

A customized error message explaining why the download isn’t allowed.

Signature

public String downloadErrorMessage {get; set;}

Property Value

Type: String

This message is used if a redirectUrl is not provided. If the download is not allowed, Salesforce will throw a ContentCustomizedDownloadException exception that contains the downloadErrorMessage.

isDownloadAllowed

Indicates whether or not download is allowed.

Signature

public Boolean isDownloadAllowed {get; set;}

Property Value

Type: Boolean

redirectUrl

The URL the user is redirected to when the download action isn't available, for applying Information Rights Management (IRM) control, virus scanning, or other behavior.

Signature

public String redirectUrl {get; set;}

Property Value

Type: String

The URL must be a valid relative URL. For example, the redirect can be a custom Visualforce page such as “/apex/IRMControl”. URLs with no path, such as “www.domain.com”, results in an InvalidParameterValueException.