public class SearchDocumentsVdrJson extends BaseJson
Constructor and Description |
---|
SearchDocumentsVdrJson() |
Modifier and Type | Method and Description |
---|---|
DeviceType |
getDeviceType()
Device type
|
ApiDocumentOrderVDR |
getDocumentOrder()
File order, if left empty set to LAST_UPDATED.
|
String |
getFolderGuid()
Folder guid
|
Integer |
getFolderId()
Folder id
|
String |
getFolderPath()
For search in specific folder, leave empty for entire workspace(s).
|
String |
getOrderByTagName()
If ordering by tag name, specify which tag name here.
|
Integer |
getPageNumber()
current page to fetch, if left empty set to 0.
|
Integer |
getPageSize()
Page size for search results, if left empty set to 25.
|
TrueFalseEither |
getRead()
When searching for only read or un-read files, if omitted will return
both.
|
List<String> |
getRoomGuids() |
List<String> |
getRoomIds()
List of workspaces to include in the search, if left null will search
in all workspaces that user has access to.
|
String |
getSearchString()
The query search string.
|
TrueFalseEither |
getStarred()
When searching for only starred or un-starred files, if omitted will
return both.
|
Set<String> |
getWorkspaceTypes() |
boolean |
isAdminMode()
For backwards compatibility, switches between admin and non admin view
- admin sees all , non admin only personal files
|
boolean |
isOrderAscending()
File order ascending, if left empty set to true.
|
void |
setAdminMode(boolean adminMode)
For backwards compatibility, switches between admin and non admin view
- admin sees all , non admin only personal files
|
void |
setDeviceType(DeviceType deviceType)
Device type
|
void |
setDocumentOrder(ApiDocumentOrderVDR documentOrder)
File order, if left empty set to LAST_UPDATED.
|
void |
setFolderGuid(String folderGuid)
Folder guid
|
void |
setFolderId(Integer folderId)
Folder id
|
void |
setFolderPath(String folderPath)
For search in specific folder, leave empty for entire workspace(s).
|
void |
setOrderAscending(boolean orderAscending)
File order ascending, if left empty set to true.
|
void |
setOrderByTagName(String orderByTagName)
If ordering by tag name, specify which tag name here.
|
void |
setPageNumber(Integer pageNumber)
current page to fetch, if left empty set to 0.
|
void |
setPageSize(Integer pageSize)
Page size for search results, if left empty set to 25.
|
void |
setRead(TrueFalseEither read)
When searching for only read or un-read files, if omitted will return
both.
|
void |
setRoomGuids(List<String> roomGuids) |
void |
setRoomIds(List<String> roomIds)
List of workspaces to include in the search, if left null will search
in all workspaces that user has access to.
|
void |
setSearchString(String searchString)
The query search string.
|
void |
setStarred(TrueFalseEither starred)
When searching for only starred or un-starred files, if omitted will
return both.
|
void |
setWorkspaceTypes(Set<String> workspaceTypes) |
getObjType, setObjType, toString
public DeviceType getDeviceType()
public void setDeviceType(DeviceType deviceType)
deviceType
- Device typepublic List<String> getRoomIds()
public void setRoomIds(List<String> roomIds)
roomIds
- List of workspaces to include in the search, if left
null will search in all workspaces that user has access to.public Integer getPageNumber()
public void setPageNumber(Integer pageNumber)
pageNumber
- current page to fetch, if left empty set to 0.public TrueFalseEither getRead()
public void setRead(TrueFalseEither read)
read
- When searching for only read or un-read files, if omitted
will return both.public String getFolderGuid()
public void setFolderGuid(String folderGuid)
folderGuid
- Folder guidpublic Integer getPageSize()
public void setPageSize(Integer pageSize)
pageSize
- Page size for search results, if left empty set to 25.public String getOrderByTagName()
public void setOrderByTagName(String orderByTagName)
orderByTagName
- If ordering by tag name, specify which tag name
here.public ApiDocumentOrderVDR getDocumentOrder()
public void setDocumentOrder(ApiDocumentOrderVDR documentOrder)
documentOrder
- File order, if left empty set to LAST_UPDATED.public Integer getFolderId()
public void setFolderId(Integer folderId)
folderId
- Folder idpublic String getFolderPath()
public void setFolderPath(String folderPath)
folderPath
- For search in specific folder, leave empty for entire
workspace(s). Workspace list must contain only one workspace to use
this function.public String getSearchString()
public void setSearchString(String searchString)
searchString
- The query search string.public TrueFalseEither getStarred()
public void setStarred(TrueFalseEither starred)
starred
- When searching for only starred or un-starred files, if
omitted will return both.public boolean isOrderAscending()
public void setOrderAscending(boolean orderAscending)
orderAscending
- File order ascending, if left empty set to true.public boolean isAdminMode()
public void setAdminMode(boolean adminMode)
adminMode
- For backwards compatibility, switches between admin
and non admin view - admin sees all , non admin only personal filesCopyright © 2019. All rights reserved.