Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
RecycleBinDocument
A recycle bin file
Parameters
Name Type Description

accessLevel

DocumentAccessLevel

Access level

Possible values: [VIEWER, TRACKING, NONE, FULL].

contentType

String

Content type

deleteDate

Date

Delete date

deletingUserAddress

String

Deleting user email address

documentCurrentVersion

DocumentCurrentVersion

A json which represents the current version of the file

documentName

String

Deprecated

Use 'name' instead

downloadPdfSize

long

Deprecated

downloadSize

long

Deprecated

expires

Date

Expires date

filename

String

Name of a file.

folder

String

Default value: ""

File's folder, for example: /office/docs

folderUuid

String

Default value: ""

File's folder uuid

guid

String

Signed GUID of a file, created by the server.

lastUpdateDate

Date

Deprecated

Use 'lastUpdated' instead

lastUpdated

Date

Date of creation or last update of the file.

name

String

Name

originalSize

Long

Original size

pendingRequests

Integer

Pending requests

percentCompleted

Integer

Progress status.

permissionsJson

PermissionsToUser

Permissions, in some contexts may be null.

previewUrl

String

Preview URL

read

boolean

Will be true if the last file was read since its last update.

recentlyViewed

Date

Deprecated

not supported any longer - info is meaningless

room

String

Default value: "0"

Id of the workspace the file has been submitted to.

score

Float

The score of the file in the current search

secureTransferFile

boolean

Secure transfer file

sender

String

Email address of sender

starred

boolean

Will be true if the file was marked as starred (favorite).

status

Status

Status, status number and error string in case of error.

type

String

Deprecated

Use 'contentType' instead

url

String

URL of a (protected) file.

workspaceName

String

Workspace name

Json Format
{
id: Integer,
guid: String,
name: String,
sender: String,
filename: String,
url: String,
contentType: String,
room: String,
folder: String,
folderUuid: String,
lastUpdated: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
recentlyViewed: Date,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
percentCompleted: Integer,
read: Boolean,
starred: Boolean,
permissionsJson:
{
accessLevel: Consts$AccessLevel,
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
pinRequired: Boolean,
minExpirationDate: Date,
latestChangeDate: Date,
originalComments: Boolean
},
downloadSize: long,
downloadPdfSize: long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
deleteDate: Date,
workspaceName: String,
deletingUserAddress: String
}