Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
SubmitTransientDocumentResult
Parameters
Name Type Description

accessLevel

DocumentAccessLevel

Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.

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

annotationsList

DocumentAnnotationsList

A json which represents the users who annotated the file, and the last update date of their annotation

classification

String

Classification, if exists.

contentType

String

convertedName

String

Converted name for file

creationDate

Date

Date of creation.

documentCurrentVersion

DocumentCurrentVersion

A json which represents the current version of the file

documentName

String

Deprecated

Use 'name' instead

downloadPdfSize

long

Deprecated

downloadSize

long

Deprecated

existingDocument

ExistingDocument

expires

Date

Deprecated

Use permissions instead

externalRepositoryData

DocumentExternalRepositoryData

filename

String

File name.

folder

String

Default value: ""

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

folderId

Integer

guid

String

Signed GUID of a file, created by the server.

id

Integer

lastUpdateDate

Date

Deprecated

Use 'lastUpdated' instead

lastUpdated

Date

Date of creation or last update of the document.

modifiedDate

Date

Date of modified.

name

String

File name

originalSize

Long

Original size of file (bytes)

path

String

Path of the file in the transient external repository

pdfConversionStatus

PdfConversionStatus

The status of PDF conversion

Possible values: [NOT_SUPPORTED, COMPLETED, NOT_INITIATED, ERROR, INITIATED].

pendingRequests

Integer

Number of pending requests to access the file

percentCompleted

Integer

Progress status.

permissionsJson

PermissionsToUser

Permissions, in some contexts may be null.

previewUrl

String

URL to preview the file

read

Boolean

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

recentlyViewed

Date

Deprecated

Date file was most recently viewed. 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

sender

String

Sender's email address

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.

tagList

TagList

Tags, if exist.

type

String

Deprecated

Use 'contentType' instead

url

String

URL of a (protected) file.

viewerUrl

String

URL of a (protected) file for viewing .

Json Format
{
id: Integer,
guid: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
contentType: String,
room: String,
folder: String,
folderId: Integer,
lastUpdated: Date,
creationDate: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
recentlyViewed: Date,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
percentCompleted: Integer,
classification: String,
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
},
tagList:
{
freeTextValues: List(
{
tagName: String,
tagValue: String
}),
dateValues: List(
{
tagName: String,
tagValue: Date
}),
numericValues: List(
{
tagName: String,
tagValue: Number
})
}),
downloadSize: long,
downloadPdfSize: long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
pdfConversionStatus: PdfConversionStatus,
annotationsList:
{
annotationRecordJsons: Collection(
{
annotatingUserAddress: String,
annotationUpdateDate: Date
})
}),
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
documentExternalData:
{
id: String,
items: Set(
{
key: String,
value: String
})
})
}),
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
modifiedDate: Date,
existingDocument:
{
documentGuid: String,
versionGuid: String,
permitted: Boolean,
suggestedName: String,
lockedForUser: Boolean
},
path: String
}