| SearchDocumentsSdsJson Class |
Used when searching a file for a string
Inheritance HierarchyNamespace: BlackBerry.Workspaces.Json
Assembly: BlackBerryWorkspacesSDK (in BlackBerryWorkspacesSDK.dll) Version: 7.0.0.223 (7.0.0.223)
SyntaxC#
public class SearchDocumentsSdsJson : BaseJson
The SearchDocumentsSdsJson type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SearchDocumentsSdsJson | Initializes a new instance of the SearchDocumentsSdsJson class |
Properties| Name | Description | |
|---|---|---|
 | AllStarredDocuments |
Ignore workspace id, return results from SDS and VDR in case of
true
|
| DocumentOrder |
Document order, if left empty set to LAST_UPDATED.
|
| Hidden |
When searching only for hidden or un-starred files, if omitted will
return only visible.
|
| IncludeStarredTransientDocuments |
Include transient files in the results
|
| ObjType |
The type of the Json object.
(Inherited from BaseJson.) |
| OrderAscending |
File order ascending, if left empty set to false.
|
| PageNumber |
Current page to fetch, if left empty set to 0.
|
| PageSize |
Page size for search results, if left empty set to 25.
|
| Read |
When searching only for read or un-read files, if omitted will
return both.
|
| SearchString |
The query search string.
|
| Starred |
When searching only for starred or un-starred files, if omitted
will return both.
|
| WorkspaceTypes |
Workspace types
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Converts the object into a JSON string.
(Inherited from BaseJson.) |
See Also