Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
ListDocumentsVdr
Details of how to obtain a list of files
Parameters
Name Type Description

adminMode

boolean

Default value: true

For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal files

documentFilter

VdrDocumentFilter

Default value: ALL

Filter expired files, default is to show ALL files.

Possible values: [READ, ALL, UNREAD, STARRED, VALID_ONLY, UNSTARRED].

documentOrder

VdrDocumentOrder

Default value: LAST_UPDATED

File order, if left empty set to LAST_UPDATED.

Possible values: [DOCUMENT_NAME, SENDER, LAST_UPDATED, SIZE, SENDER_ADDRESS, LAST_VIEWED, MODIFIED_DATE].

filterScope

ApiFilterScope

Default value: SPECIFIC_FOLDER

Filter scope, default is specific folder, if all files from workspace are needed change to ENTIRE_ROOM.

Possible values: [SPECIFIC_FOLDER, ENTIRE_ROOM].

folderGuid

String

Folder guid

folderId

Integer

Folder id

folderPath

String

For search in specific folder, leave empty for entire workspace(s). For root folder use '/', and for a folder called folder1 in a folder called folder2. use '/folder2/folder1' alternatively use folderId

folders

boolean

Default value: true

List folders with files, folders will always appear first.

lastVersionUploaderUserAddress

String

noTags

boolean

Default value: false

Will omit the files' tags (saves bandwidth).

orderAscending

boolean

Default value: true

File order ascending, if left empty set to true.

pageNumber

Integer

Default value: 0

Current page to fetch, if left empty set to 0.

pageSize

Integer

Default value: 25

Page size for search results, if left empty set to 25.

Json Format
{
pageSize: Integer,
pageNumber: Integer,
folderPath: String,
folderId: Integer,
folderGuid: String,
documentOrder: VdrDocumentOrder,
orderAscending: Boolean,
folders: Boolean,
documentFilter: VdrDocumentFilter,
filterScope: ApiFilterScope,
noTags: Boolean,
adminMode: Boolean,
includeExternalRepository: Boolean,
shortJson: Boolean,
lastVersionUploaderUserAddress: String
}