Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
SearchDocumentsSds
Used when searching a file for a string
Parameters
Name Type Description

allStarredDocuments

Boolean

Default value: FALSE

Ignore workspace id, return results from SDS and VDR in case of true

documentOrder

ApiDocumentOrderSDS

Default value: SCORE

Document order, if left empty set to LAST_UPDATED.

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

hidden

TrueFalseEither

Default value: FALSE

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

Possible values: [TRUE, FALSE, EITHER].

includeStarredTransientDocuments

Boolean

Default value: FALSE

Include transient files in the results

orderAscending

boolean

Default value: false

File order ascending, if left empty set to false.

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 only for read or un-read files, if omitted will return both.

Possible values: [TRUE, FALSE, EITHER].

searchString

String

Required

The query search string.

starred

TrueFalseEither

Default value: EITHER

When searching only for 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

Workspace types

Json Format
{
searchString: String,
pageSize: Integer,
pageNumber: Integer,
documentOrder: ApiDocumentOrderSDS,
orderAscending: Boolean,
read: TrueFalseEither,
starred: TrueFalseEither,
hidden: TrueFalseEither,
allStarredDocuments: Boolean,
includeStarredTransientDocuments: Boolean,
workspaceTypes: Set(String)
}