Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
ValidateDownloadTransientDocuments
Used for validating a file for download
Parameters
Name Type Description

documentPaths

Set(String)

Not null
Default value: new HashSet<>()

List of file paths

downloadType

DownloadTypes

Not null
Default value: MAX_ALLOWED

Download type.

Possible values: [MAX_ALLOWED, ORIGINAL, PROTECTED, ENCRYPTED].

folderPaths

Set(String)

Not null
Default value: new HashSet<>()

List of folder paths

forceAction

Boolean

Not null
Default value: true

Force the action even if not allowed for all files provided (only allowed files will be affected). Not all operations support this parameter.

shouldAggregateMessage

Boolean

Not null
Default value: TRUE

Should aggregate message

workspaceGuid

String

Required
Not null

Workspace guid

Json Format
{
forceAction: Boolean,
shouldAggregateMessage: Boolean,
downloadType: DownloadTypes,
workspaceGuid: String,
documentPaths: Set(String),
folderPaths: Set(String)
}