Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
SearchDocumentsVdr
Used when searching files for a string
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

deviceType

DeviceType

Device type

Possible values: [SALESFORCE_PLUGIN, GOOGLE_DRIVE, BROWSER, SRE, CMIS, CIFS, MAC, UPLOADER, OFFICE_ONLINE, SHAREPOINT, ANDROID_APP, ONE_DRIVE, BLACKBERRY_APP, SDK, WINDOWS_PLUGIN, IOS_APP, SYNC, CHROME_EXTENSION].

documentOrder

ApiDocumentOrderVDR

Default value: SCORE

File order, if left empty set to LAST_UPDATED.

Possible values: [SCORE, SENDER, LAST_UPDATED, SIZE, SENDER_ADDRESS, FILE_NAME, TYPE, LAST_VIEWED, NAME, TAG_NAME].

folderGuid

String

Folder guid

folderId

Integer

Folder id

folderPath

String

For search in specific folder, leave empty for entire workspace(s). Workspace list must contain only one workspace to use this function.

orderAscending

boolean

Default value: false

File order ascending, if left empty set to true.

orderByTagName

String

If ordering by tag name, specify which tag name here.

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.

read

TrueFalseEither

Default value: EITHER

When searching for only read or un-read files, if omitted will return both.

Possible values: [TRUE, FALSE, EITHER].

roomGuids

List(String)

Not null
Default value: new ArrayList<>()

roomIds

List(String)

Not null
Default value: new ArrayList<>()

List of workspaces to include in the search, if left null will search in all workspaces that user has access to.

searchString

String

The query search string.

starred

TrueFalseEither

Default value: EITHER

When searching for only starred or un-starred files, if omitted will return both.

Possible values: [TRUE, FALSE, EITHER].

workspaceTypes

Set(String)

Not null
Minimum size: 1  Maximum size: 2147483647

Json Format
{
searchString: String,
roomIds: List(String),
roomGuids: List(String),
pageSize: Integer,
pageNumber: Integer,
folderPath: String,
folderId: Integer,
folderGuid: String,
documentOrder: ApiDocumentOrderVDR,
orderAscending: Boolean,
orderByTagName: String,
read: TrueFalseEither,
starred: TrueFalseEither,
adminMode: Boolean,
deviceType: DeviceType,
workspaceTypes: Set(String)
}