Package | Description |
---|---|
com.blackberry.workspaces.api.sdk.json | |
com.blackberry.workspaces.api.sdk.resource |
Modifier and Type | Class and Description |
---|---|
class |
ItemListJson<T extends BaseJson>
A generic list of items
|
class |
PagingItemListJson<T extends BaseJson>
Details about a page item
|
Modifier and Type | Class and Description |
---|---|
class |
AccountCreationStatusRequestJson |
class |
AccountCreationStatusResultJson |
class |
ActiveDirectoryGroupInfoJson
Active Directory group details.
|
class |
ActiveDirectoryGroupSuggestionJson
An Active Directory group suggestion used when searching for AD groups
|
class |
ActiveDirectorySettingsJson
The details of an Active Directory connection when listing the details for
an organization
|
class |
ActivityLogRecordJson
A single record the represents an activity of a user on a file used in
reports
|
class |
AddActiveDirectoryGroupJson
Add an Active Directory group.
|
class |
AddActiveDirectoryGroupsJson
Add multiple Active Directory groups.
|
class |
AddDocumentEntityJson
Give user permissions to a particular workspace file only.
|
class |
AddDocumentPermissionRequestJson
Request to add permissions to a file.
|
class |
AddDocumentsTagValuesJson
List tags.
|
class |
AddEmailProtectorWhitelistEntitiesJson
Add users and domains to the Email Protector whitelist.
|
class |
AddEntitiesIManageJson
Add user permissions to IManage workspaces or imanage documents.
|
class |
AddEntitiesTransientJson
Add users to transient workspaces.
|
class |
AddEntityVdrJson
List information when adding a user to a workspace.
|
class |
AddFolderEntityJson
List information when adding a user to a workspace.
|
class |
AddFolderPermissionRequestJson
Request for access to a folder.
|
class |
AddIManageDocumentPermissionRequestJson
A request used when adding a file permission
|
class |
AddIManageFolderPermissionRequestJson
A request used when adding an imanage workspace permission
|
class |
AddMembersToGroupJson
Add multiple users to a group.
|
class |
AddMembersToGroupWithGroupJson
Add multiple users to a group and add group information.
|
class |
AddMemberToGroupJson
Add a single user to a group.
|
class |
AddOrganizationBlacklistingJson
Add entities to blacklist.
|
class |
AddOrganizationDistributionListJson
Add a new distribution list, including members.
|
class |
AddOrganizationSystemAccountsIdpJson
Add multiple new system accounts.
|
class |
AddOrganizationSystemAccountsIdpResponseJson
Response to adding new system accounts.
|
class |
AddOrganizationWatermarkContentLineJson
Add content to a watermark.
|
class |
AddOrganizationWatermarkJson
Add a new watermark.
|
class |
AddRoomMemberJson
Add a user to a workspace.
|
class |
AddRoomMembersJson
Add multiple users to a workspace.
|
class |
AddSiteInputJson
Add a site.
|
class |
AddSiteOutputJson |
class |
AddTransientDocumentPermissionRequestJson
A request used when adding a file permission
|
class |
AddTransientFolderPermissionRequestJson
A request used when adding a file permission
|
class |
AggregatedPermissionDetailsResponseJson
Response to aggregated permission details.
|
class |
AggregatedPermissionTemplateJson
Request aggregated permission details.
|
class |
AnnotationColorJson
An RGB color value
|
class |
AnnotationFieldBaseJson
Base for other annotations.
|
class |
AnnotationLinePointJson
A line end point
|
class |
AnnotationPointJson
A single point
|
class |
AnnotationRectangleJson
A rectangle as defined by PDF Spec (PDF32000 2008), which is defined by two
points: one indicating the lower left corner, and the other the upper right
corner.
|
class |
ArrowDocumentAnnotationJson |
class |
AuthenticationParametersJson
Request for authentication details.
|
class |
AuthenticationPolicyJson
Set authentication policy.
|
class |
AutocompleteRequestJson |
class |
AvailableUserInfoJson
Show user details.
|
class |
BaseLogJson
Information about how to export a log.
|
class |
BulkDeleteWorkspaceDocumentsJson
Delete multiple files, includes information about how to delete.
|
class |
BulkOperationResultJson
Show result of bulk operation.
|
class |
BulkWorkspaceProtectorSettingsJson
Set workspace settings with SharePoint Protector.
|
class |
ChangeActiveDirectorySettingsStatusJson
Request to enable or disable Active Directory.
|
class |
ChangeEntitiesIManageJson
Change multiple workspace member permissions for an imanage workspace or
documents.
|
class |
ChangeEntitiesTransientJson
Change multiple workspace member permissions for a transient workspace.
|
class |
ChangeEntitiesVdrJson
Change multiple workspace member permissions for a workspace.
|
class |
ChangeEntityVdrJson
Change a single workspace member permissions for a workspace.
|
class |
CheckDropboxAccessTokenResultJson
Result of checking Dropbox access token.
|
class |
CheckIManageCredentialJson
Check IManage Credential
|
class |
CheckIManageCredentialResultJson
Result of checking IManage Credential
|
class |
CircleDocumentAnnotationJson |
class |
ClassificationJson |
class |
ClientTokenTTLConfigJson
Information about a client and its associated token.
|
class |
ConnectorConfigurationJson
a Connector configuration - contains the info of how to login to the
connector
|
class |
CopyDocumentFromInboxJson
Copy files from Inbox.
|
class |
CopyDocumentFromRoomJson
List users to receive a notification with link and permissions assigned
sending a copy.
|
class |
CopyIManageDocumentToExchangeAsyncJson
List users to receive a notification with link and permissions assigned
sending a copy from a imanage workspace.
|
class |
CopyMembershipJson
List users when copying membership.
|
class |
CopyMultipleDocumentsToExchangeAsyncJson
List of documents to send to exchange.
|
class |
CopyTransientDocumentToExchangeAsyncJson
List users to receive a notification with link and permissions assigned
sending a copy from a transient workspace.
|
class |
CountingRoomEntityJson
Used when listing the workspace entities (groups/domain/everyone) that are
members of the workspace.
|
class |
CreateAggregatedUserDocActivityReportJson
Created by egilron on 6/12/2016.
|
class |
CreateDropboxWorkspaceJson
A new transient workspace to create
|
class |
CreateFolderAsyncJson |
class |
CreateFolderJson
Add folder.
|
class |
CreateIManageActivityLogRecordJson
Used when adding a notification for a file action in the file's activity
log file.
|
class |
CreateIManageFolderJson
Add a folder for an Imanage workspace.
|
class |
CreateiManageWorkspaceCredentialsJson
Credentials for an iManage workspace
|
class |
CreateInternalDomainLicensingReportJson |
class |
CreateLicensingReportJson
Created by tdagan on 11/16/2016.
|
class |
CreateMultipleRoomsJson |
class |
CreateMultipleRoomsResponseJson |
class |
CreateNewCommentJson |
class |
CreateNewCommentResultJson |
class |
CreateNewDocumentJson |
class |
CreateNewIManageDocumentJson
Information for creating imanage document
|
class |
CreateNewTransientCommentJson |
class |
CreateNewTransientCommentResultJson |
class |
CreateNewTransientDocumentJson |
class |
CreateOrganizationWeeklyStorageReportJson
Created by egilron on 12/12/2016.
|
class |
CreateQuickSendStorageReportJson
Created by egilron on 14/12/2016.
|
class |
CreateRoomEntityJson |
class |
CreateRoomJson
Add workspace.
|
class |
CreateSessionJson
Settings for creating a new user session.
|
class |
CreateTransientActivityLogRecordJson
Used when adding a notification for a file action in the file's activity
log file.
|
class |
CreateTransientFolderJson
Add transient workspace.
|
class |
CreateTransientWorkspaceJson
A new transient workspace to create
|
class |
CreateWorkspaceExternalFoldersJson
A collection of external folders to be created in a workspace.
|
class |
CreateWorkspaceFolderTreeJson
A workspace folder tree that will be created.
|
class |
CreateWorkspaceFolderTreeRecordJson
A single entry in a new workspace folder tree.
|
class |
CreateWorkspacesStorageReportJson
Created by egilron on 14/12/2016.
|
class |
DefaultNotificationEmailJson
The default notification email
|
class |
DefaultWorkspacePermissionsJson |
class |
DeleteActiveDirectoryGroupListJson
A collection of active directory groups to be deleted.
|
class |
DeleteActiveDirectorySettingsJson
An active directory setting to be deleted.
|
class |
DeleteCommentJson |
class |
DeleteDocumentsSelectionSdsJson
Files to be deleted from Inbox/Sent items.
|
class |
DeleteDocumentsSelectionVdrJson
Files or folders to be deleted from a workspace.
|
class |
DeleteEmbeddedNotificationJson
Created by tdagan on 3/27/2017.
|
class |
DeleteFolderJson
Delete folder and all its contents from a workspace.
|
class |
DeleteIdpSettingsJson
A list of IDP settings to remove from the organization.
|
class |
DeleteIManageDocumentsAndFoldersJson
Delete folder and all its contents from a imanage workspace.
|
class |
DeleteIManageWorkspaceJson
Delete iManage workspace.
|
class |
DeleteNotificationJson
Notification for deleting a user.
|
class |
DeleteOrganizationsDistributionListsJson
List distribution lists to delete.
|
class |
DeleteOrganizationSystemAccountIdpJson
Delete system account from organization.
|
class |
DeleteOrganizationWatermarkJson
Delete watermark from organization.
|
class |
DeleteRoomEntitiesJson
Delete multiple items from a workspace.
|
class |
DeleteRoomJson
Delete workspace.
|
class |
DeleteTagsJson
List tags to delete.
|
class |
DeleteTransientCommentJson |
class |
DeleteTransientDocumentAnnotationsJson |
class |
DeleteTransientDocumentsAndFoldersJson
Delete folder and all its contents from a transient workspace.
|
class |
DeleteTransientWorkspaceJson
Delete transient workspace.
|
class |
DeviceInfoJson
List device information.
|
class |
DeviceTypeJson |
class |
DistributionListJson
Details of a single distribution list
|
class |
DocumentAndRecipientsJson
Used when gathering information about bulk email notifications
|
class |
DocumentAndVersionJson |
class |
DocumentAnnotationJson
Annotation details
|
class |
DocumentAnnotationsForUserJson |
class |
DocumentAnnotationsForUsersJson |
class |
DocumentAnnotationsJson
A collection of annotations
|
class |
DocumentAnnotationsListJson
A collection of annotation records
|
class |
DocumentAnnotationsListRecordJson
A single annotation list record
|
class |
DocumentChunkJson
Information about a chunk of file data's status
|
class |
DocumentChunksJson
Information about the status of multiple chunks of file data
|
class |
DocumentCommentCountJson |
class |
DocumentCommentJson |
class |
DocumentConversionStatusJson
Status information of a file conversion
|
class |
DocumentCurrentVersionJson
Current version information about a file.
|
class |
DocumentExternalDataJson
A file's external data
|
class |
DocumentExternalRepositoryDataJson
Information about a file's external repository
|
class |
DocumentIdentifierJson |
class |
DocumentJson
A file that is used in various operations
|
class |
DocumentLinkInfoResultJson |
class |
DocumentLinksJson
Details about a link within a file
|
class |
DocumentModifiedDateSetJson
Used when setting a file's modified date
|
class |
DocumentPageAnnotationsJson
A collection of annotations
|
class |
DocumentPendingPermissionRequestJson
A pending request for a file permission
|
class |
DocumentPermissionRequestsResultsJson
Result from a pending permission request
|
class |
DocumentPlainAnnotationJson
A plain annotation
|
class |
DocumentsModifiedDateSetJson
Modified date to be set for a file
|
class |
DocumentsReadConfirmationEditJson |
class |
DocumentsSelectionJson
Base type of several file selection JSONs
|
class |
DocumentsSelectionSdsJson
Specifies a filter for selecting files
|
class |
DocumentsSelectionVdrJson
Specifies various criteria for selecting files
|
class |
DocumentsUpdateDataSetJson
A collection of file data updates to be applied to a file
|
class |
DocumentUpdateDataSetJson
Information used when updating file data
|
class |
DocumentVersionAnnotationsListJson
A set of annotation records used when getting file version information
|
class |
DocumentVersionAnnotationsListRecordJson
Information about a single file annotation used when getting file version
information
|
class |
DocumentVersionReadConfirmedJson |
class |
DocuSignPolicyJson |
class |
DomainJson
A single domain's information
|
class |
DownloadCommentsJson |
class |
DownloadDocumentsSelectionSdsJson
Used when choosing which files to download
|
class |
DownloadDocumentsSelectionVdrJson
Used when choosing which files to download in a workspace
|
class |
DownloadPrepareDocumentStatusInputJson |
class |
DownloadPrepareDocumentStatusOutputJson |
class |
DownloadSentItemsDocumentsWithRecycleBinJson
User who's sent items and recycle bin will be downloaded
|
class |
DownloadSingleDocumentSelectionJson
A single file to be downloaded
|
class |
DownloadSingleIManageDocumentJson
Request for a document to be downloaded
|
class |
DownloadSingleRecycleBinWorkspaceDocumentJson
Original version of a file to be downloaded.
|
class |
DownloadSingleTransientDocumentForWebJson |
class |
DownloadSingleTransientDocumentJson |
class |
DownloadTransientCommentsJson |
class |
DownloadTransientDocumentAnnotationsJson |
class |
DownloadWorkspaceDocumentsWithRecycleBinJson
Files to be downloaded from a workspace Recycle bin.
|
class |
DropboxOAuthParamsJson
Dropbox OAuth Parameters
|
class |
EditActiveDirectoryGroupJson
Used when editing Active Directory groups in the organization
|
class |
EditActiveDirectorySettingsJson
Used when editing the Active Directory settings for and organization
|
class |
EditActiveDirectorySettingsResponseJson
Response from editing an organization's Active Directory settings
|
class |
EditCollaborationJson
Edit collaboration settings.
|
class |
EditExternalTransactionStatusInputJson
Used when editing the status of an external transaction
|
class |
EditFoldersAndDocumentsSettingsBulkJson
Used when editing folder permissions in bulk
|
class |
EditFolderSettingsJson
Used when editing folder permissions
|
class |
EditIdpClientSettingsJson
Used when editing IDP settings for an organization
|
class |
EditIdpSettingsJson
Used when editing IDP settings for an organization
|
class |
EditIdpTTLSettingsJson |
class |
EditManagersOnGroupJson
Add multiple users to a group and add group information.
|
class |
EditOrganizationPolicyJson
Used when editing an organizational policy
|
class |
EditOrganizationSystemAccountsIdpJson
Organizational system accounts to be updated
|
class |
EditOrganizationWatermarkContentLineJson
An organizational watermark content line to be updated
|
class |
EditOrganizationWatermarkJson
An organizational watermark to be updated
|
class |
EditRoomJson
A workspace to be edited
|
class |
EditTagJson
Information about a tag that will be renamed
|
class |
EditUserJson
A user to be edited
|
class |
EmailBulkDataJson
Collection used to store bulk email data
|
class |
EmbeddedNotificationJson
Created by tdagan on 3/21/2017.
|
class |
EmbeddedNotificationsCommentInfoJson |
class |
EntityInFolderPermissionsJson
Permissions for an entity that exists in a folder
|
class |
EntityInRoomResponseJson
Response when querying about entities in a workspace
|
class |
EntityPermissionJson
A single permission for an entity
|
class |
ErrorInfoJson
Information about an error
|
class |
ExistingActiveDirectoryGroupSuggestionJson
Details of a suggested Active Directory group
|
class |
ExistingDocumentJson
A file that exists, but with a new suggested name
|
class |
ExistingTransientDocumentJson |
class |
ExportActivityHistoryForTransientRoomsJson
Used when exporting the activity history for multiple rooms
|
class |
ExportSpecificUsersTransientActivityHistoryByMailJson
Used when exporting a selected Activity history for a list of users in
current user's organization to a CSV file as an attachment to an email
|
class |
ExportUsersTransientActivityHistoryJson
Used when exporting activity history for a list of users in current user's
organization to a CSV file
|
class |
ExternalDataItemJson
Simple key/value pair representing a piece of external data
|
class |
ExternalDocumentsTransactionResultJson
Results from an action regarding external files
|
class |
ExternalExceptionJson |
class |
ExternalFoldersTransactionResultJson
Results from an action regarding external folders
|
class |
ExternalMessageJson |
class |
ExternalMessagesJson |
class |
ExternalRepositoryIdRequestJson
Request for getting the ID of an external repository
|
class |
ExternalRepositoryIdResultJson
Result from getting external repository ID information
|
class |
ExternalSiteDataJson
External site data
|
class |
ExternalTransactionInputJson
Used when getting the status of an external transaction
|
class |
ExternalTransactionStatusJson
The status of an external transaction
|
class |
FolderDefaultPermissionsJson
The default permissions for a folder
|
class |
FolderExternalDataJson
A collection of items in an external folder
|
class |
FolderExternalRepositoryDataJson
Details about a folder in an external repository
|
class |
FolderInfoJson
Details about a single folder
|
class |
FolderJson
Details about a single folder
|
class |
FolderLinksJson
Used when getting links for a folder in a workspace
|
class |
FolderPathToUuidJson
Created by sbenhayun on 6/7/2017.
|
class |
FolderPendingPermissionRequestJson
A request for permissions on an existing folder
|
class |
FolderPendingPermissionRequestsJson
A collection of requests for folder permissions
|
class |
FolderReadConfirmationEditJson |
class |
FoldersDocumentsJson
A collection of folders and files
|
class |
FolderSuggestedNameJson |
class |
FreeDrawDocumentAnnotationJson |
class |
FreeDrawnElementDocumentAnnotationJson |
class |
GenerateTransientDocumentGuidJson
GUID for a file in transient workspace's context
|
class |
GeometricalObjectDocumentAnnotationJson |
class |
GetDocumentActivityLogRequestJson
Request for getting information about an activity log
|
class |
GetDocumentLinkInfoRequestJson
Request for getting information about a file link
|
class |
GetDocumentsActivityLogRequestJson
Request for getting information about an activity log
|
class |
GetDocumentsConversionStatusJson
Used when getting the status of a file conversion
|
class |
GetDocumentsGuidsInfoJson
Created by ybennatan on 8/29/2016.
|
class |
GetDocumentsVersionsInfoJson
Created by ybennatan on 8/31/2016.
|
class |
GetDropboxWorkspaceJson
Dropbox Wrokspace Repository GUID
|
class |
GetEmailBulkDataJson
Used when getting bulk data about email
|
class |
GetFolderInfoJson
Used when getting information about a folder.
|
class |
GetGroupInfoJson
Used when getting information about a group in a workspace
|
class |
GetGuidByFolderAndNameJson
GUID of folder and filename
|
class |
GetIManageDocumentActivityLogRequestJson
Used to get imanage document activity log
|
class |
GetIManageDocumentPermissionsForIosJson
Used to identify a workspace to get permission information from
|
class |
GetIManageFolderInfoJson
Information for getting the workspace or folder single level folders.
|
class |
GetIManagePathInfoJson
A path to get information about
|
class |
GetIManageWorkspaceInfoJson |
class |
GetInfoUnauthDocumentResultJson
Result from getting informaton about an unauthorized file
|
class |
GetOrRefreshAccessTokenResponseJson
Response from getting information about an access token that needs to be
obtained or refreshed
|
class |
GetPathInfoJson
A path to get information about
|
class |
GetSamlIdpIdJson |
class |
GetSAMLIdPMetadataJson |
class |
GetSkipRoomsForRetentionInputJson |
class |
GetTransientDocumentActivityLogRequestJson
Used to get an activity log
|
class |
GetTransientDocumentPermissionsForIosJson
Used to identify a workspace to get permission information from
|
class |
GetTransientFolderInfoJson
Workspace to get a single level of folders from
|
class |
GetTransientWorkspaceInfoJson |
class |
GetValidDocumentsGuidsInfoJson |
class |
GetValidIManagePathInfoListJson |
class |
GetValidPathInfoListJson |
class |
GetWopiProofKeyJson |
class |
GoodTokenErrorResponseJson
Error response when generating a BlackBerry Workspaces authentication token
from a given Good authentication token.
|
class |
GroupAndMembersJson
Used when adding entities to a group
|
class |
GroupLogRecordJson
A record used when exporting group logs
|
class |
GroupRequestJson
Group request when filtering reports
|
class |
GroupsLogByIdsJson
Used when exporting groups logs
|
class |
GroupsLogByRoomsJson
Used when exporting groups logs
|
class |
GuidJson
A simple GUID
|
class |
HideNotificationJson |
class |
HighlightDocumentAnnotationJson |
class |
HistoryPeriodJson
Time period used when exporting history logs
|
class |
IManageDocumentInfoJson
Used for getting file information
|
class |
IManageDocumentInviteJson
Invite data for a document
|
class |
IManageDocumentJson
Details for a file in a IManage workspace
|
class |
IManageDocumentPermissionRequestsResultsJson
Result from a permission request for a document in a imanage workspace
|
class |
IManageDocumentsTransactionResultJson
Result from copying files to Sent items
|
class |
IManageEditFoldersAndDocumentsSettingsBulkJson
Used when bulk editing file settings
|
class |
IManageFolderInfoResultJson
Result from getting a single folder level
|
class |
IManageFolderJson
IManage folder info
|
class |
IManageInitiateConversionJson
Used to initiate a conversion to PDF for a document
|
class |
IManageInviteJson
Invite to imanage workspace or folder
|
class |
IManageMatterInfoJson
The imanage matter info for creating imanage workspace locally
|
class |
IManageMatterJson
Details of iManage matter/folder
|
class |
IManageMoveJson
Used for moving folders or files
|
class |
IManageWorkspaceInfoJson
IManage Workspace Info
|
class |
IManageWorkspacePermissionRequestsResultsJson
Result from a pending transient workspace permission request
|
class |
InitialSyncRoomDataJson
Used when applying a decision to a request
|
class |
InitialSyncStatusJson
Status of an initial sync
|
class |
InlineTextDocumentAnnotationJson |
class |
InviteJson
Used to invite groups to a workspace
|
class |
InviteTextJson
Information about the invite email
|
class |
IsActiveDirectoryConfiguredResultJson
Result from determining if Active Directory is enabled
|
class |
IsActiveDirectorySettingsEnabledJson
Used when finding out if Active Directory is enabled
|
class |
IsEmailProtectorEnabledJson
Result from determining if the email protector is enabled
|
class |
ItemErrorInfoJson
A problematic item found during different processes
|
class |
ItemListJson<T extends BaseJson>
A generic list of items
|
class |
ItemWithErrorJson |
class |
KMSRegionJson |
class |
LastDocsWithActivityJson |
class |
LastDocWithActivityJson |
class |
LastResolvedDocumentPermissionRequestResultJson
Member of a list of last resolved permission requests on files in rooms and
in exchange
|
class |
LastResolvedFolderPermissionRequestResultJson
Member of a list of last resolved permission requests on folder
|
class |
LastResolvedIManageDocumentPermissionRequestResultJson |
class |
LastResolvedIManageFolderPermissionRequestResultJson |
class |
LastResolvedTransientDocumentPermissionRequestResultJson |
class |
LastResolvedTransientFolderPermissionRequestResultJson |
class |
LineDocumentAnnotationJson |
class |
ListActiveDirectoryGroupsJson
Details about how to get a list of Active Directory groups
|
class |
ListActiveDirectoryGroupsSuggestionsJson
A list of suggestions used when searching for Active Directory groups
|
class |
ListAllFavoriteItemsJson |
class |
ListAllNotificationsJson
Created by tdagan on 3/21/2017.
|
class |
ListBulkFolderPermissionsJson
Used when getting the aggregation of permissions of folders
|
class |
ListDistributionListsByNameJson
Used when getting a list of members of a named distribution list
|
class |
ListDistributionlistsJson
Information about returning a list of all distribution lists for an
organization.
|
class |
ListDocumentCommentsJson |
class |
ListDocumentsPermissionRequestsJson
Used when listing existing permission requests for a file
|
class |
ListDocumentsVdrJson
Details of how to obtain a list of files
|
class |
ListDomainsJson
Details of how to obtain a list of domains
|
class |
ListEmailProtectorWhitelistEntitiesResultJson
Results from listing all user and domain entities within the Email
protector whitelist
|
class |
ListEmailProtectorWhitelistEntityResultJson
An entity result from listing all user and domain entities within the Email
protector whitelist
|
class |
ListExchangesRecycleBinDocumentsJson
Used when listing hidden files in the Inbox and items in the Sent items
Recycle bin.
|
class |
ListExistingActiveDirectoryGroupsSuggestionsJson
Details about using suggestions when searching for Acive Directory groups
|
class |
ListExternalConnectorsJson |
class |
ListExternalConnectorsResultJson
Result json for the ListExternalConnectors API
|
class |
ListFavoriteItemsJson |
class |
ListFolderDefaultPermissionsJson
Details for listing permissions for each of the default entities in given
folder
|
class |
ListFolderPermissionRequestsJson
Used when listing existing permissions requests for folder or the entire
workspace in case the root folder is supplied
|
class |
ListIdpSettingsJson
Currently not used
|
class |
ListIdpSettingsResultItemJson
Single result from listing IDP settings for organization
|
class |
ListIdpSettingsResultItemMultiMemberJson
Multi result from listing IDP settings for organization
|
class |
ListIManageFoldersAndDocumentsJson
Information for retrieving a list of iManage files and folders for a
workspace or a folder.
|
class |
ListIManageFoldersJson
Used to get the tree of all folders
|
class |
ListIManageFoldersSingleLevelResultJson
Single level of tree folders
|
class |
ListIManageMattersJson
Used when retrieving a list of imanage matters
|
class |
ListIManagePermissionDetailsJson
Request for listing permission details for files or root folder in the
imanage workspace
|
class |
ListInternalDomainsForOrganizationRequestJson
Used when requesting organization's internal domains
|
class |
ListInternalDomainsForOrganizationResponseJson
Response for requesting organization's internal domains
|
class |
ListLastResolvedFolderPermissionRequestsJson
Details for listing last resolved permission requests on folder
|
class |
ListLastResolvedTransientDocumentPermissionRequestsJson |
class |
ListLastResolvedTransientFolderPermissionRequestsJson |
class |
ListLibrariesInputJson
Libraries to list
|
class |
ListLibrariesOutputJson |
class |
ListNotificationsJson
Detals about how to list a user's notifications
|
class |
ListOrganizationBlacklistingJson
Details for listing an organization's blacklist entries
|
class |
ListOrganizationBlacklistingResultJson
Results from listing an organization's blacklist entries
|
class |
ListOrganizationPolicyJson
Organization ID for listing policies
|
class |
ListOrganizationSystemAccountsIdpJson
Used when listing organization system accounts
|
class |
ListOrganizationWatermarksJson
Collection of watermark positions
|
class |
ListPendingNumberPermissionRequestsJson
Details about how to list the number of pending existing file permission
requests and workspace permission requests for an admin
|
class |
ListPendingNumberPermissionRequestsResultJson
Result from listing the number of pending existing file permission requests
and workspace permission requests for an admin
|
class |
ListPermissionDetailsJson
Details for listing permission details for files and folders in bulk for
all entities in the workspace
|
class |
ListPermittedUsersToTransientWorkspaceJson |
class |
ListRoomEntitiesJson
Details about how to list the workspace entities
|
class |
ListRoomsByTypeJson
Result from a permission request for a document in a transient workspace
|
class |
ListRoomsByTypeResultJson
Workspace information
|
class |
ListSitesInputJson
Input when listing sites
|
class |
ListSitesOutputJson |
class |
ListStarredTransientDocumentsJson
List of starred files in transient workspace
|
class |
ListSummaryEmbeddedNotificationJson |
class |
ListSystemAccountItemJson
Details about a single system account
|
class |
ListTagsJson
A list of tags
|
class |
ListTagTreeJson
A tree of tag lists
|
class |
ListTransientDocumentCommentsJson |
class |
ListTransientDocumentsPermissionRequestsJson
Used when listing existing permission requests for a file
|
class |
ListTransientFolderPermissionRequestsJson
Used when listing pending permission requests for folder in transient
workspaces
|
class |
ListTransientFoldersAndDocumentsJson
Used when retrieving a list of transient files and folders.
|
class |
ListTransientFoldersJson
Used to get the tree of all folders
|
class |
ListTransientFoldersSingleLevelResultJson
Single level of tree folders
|
class |
ListTransientOrganizationPolicyJson
Used to get the organizational policy
|
class |
ListTransientPermissionDetailsJson
Request for listing permission details for files and folders for all
entities in the workspace
|
class |
ListUserMentionInCommentsJson |
class |
ListUserMentionInUnreadDocumentCommentsJson |
class |
ListUserWorkspaceNotificationsSettingsJson |
class |
ListVersionsReadConfirmationJson |
class |
ListVersionsReadConfirmationRetJson |
class |
ListWorkspaceGroupMembershipsForUserRequestJson
Used to list the groups a user is a member of
|
class |
ListWorkspaceRecycleBinDocumentsJson
Used to list files in the workspace recycle bin.
|
class |
ListWorkspaceRecycleBinWorkspacesJson
Used to list files in the workspaces recycle bin.
|
class |
LoadToCacheJson
Details of what to load into the cache
|
class |
LockDocumentsRequestJson
Request to lock files
|
class |
MarkDocumentCommentsJson |
class |
MarkDocumentsSelectionJson
Mark a set of files
|
class |
MarkDocumentsSelectionSdsJson
Files selected for marking
|
class |
MarkDocumentsSelectionVdrJson
Files selected for marking
|
class |
MarkEmbeddedNotificationJson
Created by tdagan on 3/27/2017.
|
class |
MarkIManageWorkspaceStarredJson
Set of workspaces to be marked as starred or unstarred(favorite)
|
class |
MarkItemsStarredJson
Mark a set of items
|
class |
MarkNotificationJson
Mark details
|
class |
MarkupDocumentAnnotationJson |
class |
MarkupLocationJson |
class |
MembersJson
A membership list
|
class |
ModifyGroupWithGroupJson
Information for modifying a group
|
class |
MoveAllJson
Move all files to another folder
|
class |
MoveFolderIntoFolderJson
Used when moving a folder to another folder
|
class |
MoveFolderJson
Used when moving a folder
|
class |
MoveJson
Used when moving files
|
class |
NewSessionJson
Details of a new session that was created
|
class |
NoReplyEmailRequestJson
No reply email empty request
|
class |
NoReplyEmailResponseJson
No reply email
|
class |
NotificationJson
Used for listing a user's notifications
|
class |
OidcPublicKeyResultJson |
class |
OnDemandRequestJson
Request for various demands
|
class |
OpenForAllRoomEditJson
Used for setting a workspace to be open to all entities
|
class |
OrgAdminsUserEmailsJson |
class |
OrganizationActiveBYOKJson |
class |
OrganizationConversionPolicyJson
An orgainzation conversion policy
|
class |
OrganizationCustomizationJson
Details about organization customization
|
class |
OrganizationExchangePolicyJson
Organization file share policy
|
class |
OrganizationPolicyJson
An organizational policy
|
class |
OrganizationProtectAnywherePolicyJson
An organizational protect anywhere policy
|
class |
OrganizationRoleLogRecordJson
A single log record about organization roles
|
class |
OrganizationStoragePolicyJson
Used for editing on organizational storage policy
|
class |
OrganizationStoragePolicyResponseJson
Response from getting an organizational storage policy
|
class |
OrganizationSubdomainCustomizationJson
Information about subdomain customization
|
class |
OrganizationSyncPolicyJson
Organization sync policy details
|
class |
OrganizationWatermarkConfigJson |
class |
OrganizationWatermarkContentJson |
class |
OrganizationWorkspacesPolicyJson
An organization workspace plicy
|
class |
OrgLicenseExpirationTimeRequestJson
Created by sbenhayun on 8/3/2017.
|
class |
OrgLicenseExpirationTimeResponseJson
Created by sbenhayun on 8/3/2017.
|
class |
PaginationJson
Pagination details
|
class |
PagingItemListJson<T extends BaseJson>
Details about a page item
|
class |
PathAndExternalIdJson
A path and external ID
|
class |
PathOrFolderIdJson
A path or ID for a folder
|
class |
PermissionDetailsJson
List of permission details
|
class |
PermissionFromUserJson
A permission from a user
|
class |
PermissionRequestUserAndTypeJson
User and type infomation for a permission request
|
class |
PermissionSetJson
Various permissions
|
class |
PermissionsTemplateForFolderRequestJson
Request for a folder permission template
|
class |
PermissionsTemplateRequestJson
Request for a permissions template
|
class |
PermissionsToUserForGetPermissionsJson
Permission to a user for getting permissions
|
class |
PermissionsToUserJson
Permissions to a user
|
class |
PermissionTemplatePayloadJson
Permission template payload
|
class |
PermittedEntityFromUserJson
A permitted entity from a user
|
class |
PermittedEntityToUserJson
Permitted entity to user
|
class |
PermittedEntityWithPermissionsFromUserJson
Permitted entity with permissions from a user
|
class |
PersonalRoomJson
Personal workspace ("My workspace")
|
class |
ProtectorDownloadTypeResultJson
Result from getting info about a protector download type
|
class |
PublicKeyJson
Request for authentication details.
|
class |
RecentSharedWithMeJson |
class |
RecycleBinDocumentJson
A recycle bin file
|
class |
RemoveDocumentsTagValuesJson
List of files to remove tags from
|
class |
RemoveEmailProtectorWhitelistEntitiesJson
Used when removing user and domain entities from the email protector
whitelist.
|
class |
RemoveMembersFromGroupJson
Json representation of a list of members to remove from a group
|
class |
RemoveOrganizationBlacklistingJson
List of entities to remove from the organization denied blacklist.
|
class |
RemoveUsersJson
Users to remove from an organization
|
class |
RenameDistributionListJson
New name for a distribution list
|
class |
RenameFolderJson
Used when renaming a folder
|
class |
RenameIManageDocumentJson
Information about the file to rename
|
class |
RenameIManageFolderJson
Information about the folder to rename
|
class |
RenameIManageFolderResultJson
Result from renaming transient folder
|
class |
RenameTransientDocumentJson
A file to rename
|
class |
RenameTransientFolderJson
A folder to rename
|
class |
RenameTransientFolderResultJson
Result from renaming transient folder
|
class |
ReportFilterJson
A report filter
|
class |
ResolveActionForDocumentPermissionRequestJson
Request to resolve an action on a file
|
class |
ResolveActionForFolderPermissionRequestJson
Request to resolve and action on a folder
|
class |
ResolveActionForIManageDocumentPermissionRequestJson
Request to resolve and action on a file
|
class |
ResolveActionForIManageFolderPermissionRequestJson
Request to resolve and action on an imanage workspace
|
class |
ResolveActionForTransientDocumentPermissionRequestJson
Request to resolve and action on a file
|
class |
ResolveActionForTransientFolderPermissionRequestJson
Request to resolve and action on a file
|
class |
RestoreExchangesRecycleBinDocumentsJson
Files to restore from the Sent items recycle bin to the original folders.
|
class |
RestoreWorkspacesRecycleBinDocumentJson
Files to restore from the Sent items recycle bin to the original folders.
|
class |
RestoreWorkspacesRecycleBinWorkspacesJson
Workspaces to restore from the recycle bin
|
class |
RollbackToSnapshotJson |
class |
RollbackToSnapshotRetJson |
class |
RoomEmailDataJson
List workspace files
|
class |
RoomEntityJson
A workspace
|
class |
RoomExplicitJson
Used when marking a workspace explicit
|
class |
RoomExternalDataJson
Items associated with a workspace
|
class |
RoomExternalRepositoryDataJson
Information about an external repository
|
class |
RoomJson
A workspace
|
class |
RoomLinksJson
Used when getting a URL for a workspace
|
class |
RoomListJson
List of workspaces
|
class |
RoomRecipientsJson
List workspace members
|
class |
RoomsReportRequestByMailJson
Request for a workspace report
|
class |
SaveTransientWorkspaceCredentialsJson
Saves credentials for a transient workspace
|
class |
SdsAddPermissionsJson
Information for adding SDS permissions
|
class |
SdsAddRecipientsJson
Information for adding recipients to files
|
class |
SdsEditPermissionsJson
Used when editing file permissions in Sent items
|
class |
SdsGetRecipientsJson
File to list recipients of
|
class |
SdsRevokePermissionsJson
Used when revoking all permissions for entities (users, groups, lists) for
files in the Sent items.
|
class |
SearchDocumentsSdsJson
Used when searching a file for a string
|
class |
SearchDocumentsVdrJson
Used when searching files for a string
|
class |
SearchFilterJson |
class |
SearchRequestJson |
class |
SendEmailBulkJson
Used when sending bulk email notifications for a list of files to all
permitted entities (users, groups etc) for each file
|
class |
SendEmailJson
Used when sending an email
|
class |
SendEmailsToIManageDocumentsJson
Used when sending emails
|
class |
SendEmailsToTransientDocumentsJson
Used when sending emails
|
class |
SendNotificationsJson |
class |
SendSupportEmailJson |
class |
SetClassificationJson
Used to set the classification on a file
|
class |
SharedWithMeJson |
class |
SharedWithMeResponseJson |
class |
SharepointRoomJson
SharePoint workspace
|
class |
ShareTransientDocumentAnnotationJson |
class |
SignInIManageResultJson
SignIn IManage
|
class |
SimpleNaturalIntegerJson
this json allows us to differentiate between the following case when
supplying integer values for updating in the DB 1.
|
class |
SkipRetentionRoomInfoJson |
class |
SkipRoomForRetentionJson |
class |
SkipRoomsForRetentionInputJson |
class |
SkipRoomsForRetentionOutputJson |
class |
SquareDocumentAnnotationJson |
class |
StarredTransientDocumentsJson
Starred files in transient workspaces
|
class |
StatusJson
A command status
|
class |
StrikeoutDocumentAnnotationJson |
class |
SubmitDocumentResultJson
Result from submitting a file
|
class |
SubmitDocumentSdsJson
These parameters are needed when submitting files in SDS mode (not to a
workspace).
|
class |
SubmitDocumentsVdrJson
Used when submitting files
|
class |
SubmitDocumentVdrJson |
class |
SubmitIfNewIManageDocumentJson |
class |
SubmitIfNewJson |
class |
SubmitIfNewTransientDocumentJson |
class |
SubmitIManageDocumentResultJson |
class |
SubmitIManageDocumentVdrJson |
class |
SubmitIManageVersionVdrJson |
class |
SubmitTransientDocumentResultJson |
class |
SubmitTransientDocumentVdrJson |
class |
SubmitTransientVersionVdrJson |
class |
SummaryEmbeddedNotificationJson |
class |
SystemPropertiesJson
Various system properties
|
class |
TagDateValueAddJson
A tag date value
|
class |
TagDateValueRemoveJson
Used when removing values
|
class |
TagFieldJson
A tag
|
class |
TagListJson
A collection of tags
|
class |
TagListRemoveJson
Used when removing tags
|
class |
TagNumericValueAddJson
A tag numeric value
|
class |
TagNumericValueRemoveJson
Used when removing values
|
class |
TagRecordJson |
class |
TagStringValueAddJson
A tag text value
|
class |
TagStringValueRemoveJson
Used when removing values
|
class |
TagTreeJson
A tag tree
|
class |
TextCommentDocumentAnnotationJson |
class |
TextMarkupDocumentAnnotationJson |
class |
TextualDocumentAnnotationJson |
class |
TimeEstimationJson
Estimated seconds left
|
class |
TotalEmbeddedNotificationsRequestJson |
class |
TotalEmbeddedNotificationsResponseJson |
class |
TransactionInputJson
Used when getting a file transaction status
|
class |
TransactionStatusJson
File transaction status
|
class |
TransientDocumentAndUsersJson |
class |
TransientDocumentCommentCountJson |
class |
TransientDocumentInfoJson
Used for getting file information
|
class |
TransientDocumentInviteJson |
class |
TransientDocumentJson
Details for a file in a transient workspace
|
class |
TransientDocumentPendingPermissionRequestJson
A pending request for a file permission in a transient workspace
|
class |
TransientDocumentPermissionRequestsResultsJson
Result from a permission request for a document in a transient workspace
|
class |
TransientDocumentsTransactionResultJson
Result from copying files to Sent items
|
class |
TransientEditFoldersAndDocumentsSettingsBulkJson
Used when bulk editing file settings
|
class |
TransientFolderInfoResultJson
Result from getting a single folder level
|
class |
TransientFolderJson
Details of a transient folder
|
class |
TransientFolderPendingPermissionRequestJson
A request for permissions on an existing folder
|
class |
TransientFolderPermissionRequestsResultsJson
Result from a pending transient workspace permission request
|
class |
TransientInitiateConversionJson
Used to initiate a conversion
|
class |
TransientInitiateConversionResultJson
Result from initiating a conversion
|
class |
TransientInviteJson
Invite
|
class |
TransientListUserMentionInUnreadDocumentCommentsJson |
class |
TransientMoveJson
Used for moving folders or files
|
class |
TransientPathInfoJson |
class |
TransientWorkspaceExternalDataJson
Workspace external data
|
class |
TransientWorkspaceInfoJson
Transient Workspace Info
|
class |
TransientWorkspaceJson
A transient worksapce
|
class |
UnauthDocumentInfoJson
Details used when opening a file
|
class |
UnauthDocumentJson
File details
|
class |
UnderlineDocumentAnnotationJson |
class |
UnlockDocumentsRequestJson
Request to unlock a file
|
class |
UnregisterUserForPushNotificationJson
Created by sbenhayun on 3/8/2017.
|
class |
UnStarredTransientDocumentsJson
Files in transient workspaces that are not starred.
|
class |
UpdateCommentJson |
class |
UpdateDocumentJson
Used when updating a file
|
class |
UpdateTransientCommentJson |
class |
UploadUserTransientDocumentAnnotationsJson |
class |
UrlJson
URL Json contains a URL
|
class |
UserAbilitiesJson
Details about a user's abilities
|
class |
UserAuthenticationLoggingInitialDateResponseJson |
class |
UserDataJson
Details about a user
|
class |
UserDetailsJson
User details
|
class |
UserDeviceNotificationTypeSettingsJson |
class |
UserDirectMembershipResolveDataJson
Data used for resolving user direct membership
|
class |
UserJson
A user
|
class |
UserReportJson |
class |
UserRoleJson
A user role
|
class |
UsersForPasswordResetJson
Users who need a password reset
|
class |
UsersJson
User list
|
class |
UsersReportRequestJson |
class |
UserWorkspaceNotificationsSettingsJson |
class |
ValidateCreateFolderJson
Used to validate params when creating a folder
|
class |
ValidateDownloadDocumentsSelectionSdsJson
Used when validating files for download
|
class |
ValidateDownloadDocumentsSelectionVdrJson
Used when validating files for download
|
class |
ValidateDownloadDocumentVersionInVdrsJson
Used when validating files for download
|
class |
ValidateDownloadIManageDocumentsJson
Used for validating a file for download
|
class |
ValidateDownloadSentItemsDocumentsWithRecycleBinJson
Used when validating sent items download of a user with it's recycle bin.
|
class |
ValidateDownloadTransientDocumentsAnnotationsJson |
class |
ValidateDownloadTransientDocumentsJson
Used for validating a file for download
|
class |
ValidateDownloadUserTransientDocumentAnnotationsInDocJson |
class |
ValidateDownloadWorkspaceDocumentsWithRecycleBinJson
Used when validating files to download from a recycle bin.
|
class |
ValidateKCDWorkspaceCredentialsJson
Validates credentials for a kcd transient workspace
|
class |
ValidateSAMLIdPMetadataJson |
class |
ValidateUsersNotAdminsInWorkspacesRequestJson
Used when validating non-admin users in a workspace
|
class |
ValidateUsersNotAdminsInWorkspacesResponseJson
Response to validating non-admin users in a workspace
|
class |
ValidIManagePathInfoJson
Request for getting documents info
|
class |
ValidPathInfoJson |
class |
VdrAddPermissionsJson
Add permissions to an entity
|
class |
VdrEditPermissionsJson
Used when editing permissions for a list of files for a list of entities
|
class |
VdrRevokePermissionJson
Used when revoking permissions
|
class |
VerifyActiveDirectorySettingsJson
An a Active Directory setting to be verified
|
class |
ViewerWatermarkJson
A viewer watermark
|
class |
WopiProofKeyJson |
class |
WorkspaceGroupMembershipForUserInfoJson |
class |
WorkspaceInfoJson
Workspace information
|
class |
WorkspaceProtectorSettingsJson
Used when setting a protector
|
Modifier and Type | Method and Description |
---|---|
BaseJson |
SharedWithMeResponseJson.getItemJson() |
BaseJson |
ItemWithErrorJson.getItemJson() |
Modifier and Type | Method and Description |
---|---|
ItemListJson<BaseJson> |
FoldersDocumentsJson.getDocuments()
List of file in folders
|
Modifier and Type | Method and Description |
---|---|
void |
SharedWithMeResponseJson.setItemJson(BaseJson itemJson) |
void |
ItemWithErrorJson.setItemJson(BaseJson itemJson) |
Modifier and Type | Method and Description |
---|---|
void |
FoldersDocumentsJson.setDocuments(ItemListJson<BaseJson> documents)
List of file in folders
|
Modifier and Type | Method and Description |
---|---|
PagingItemListJson<BaseJson> |
Search.autoCompleteV30(AutocompleteRequestJson autocompleteRequestJson)
Autocomplete route
|
PagingItemListJson<BaseJson> |
Items.getAllFavoritesV30(ListAllFavoriteItemsJson listAllFavoriteItemsJson)
Gets a list of all starred (favorite) items workspaces, documents or
folders for the user
|
PagingItemListJson<BaseJson> |
Items.getFavoritesV30(ListFavoriteItemsJson listFavoriteItemsJson)
Gets a list of starred (favorite) items workspaces, documents or
folders for the user under the specified location
|
PagingItemListJson<BaseJson> |
Workspaces.listDocumentsForAdminV30(String roomId,
ListDocumentsVdrJson listDocumentsVdrJson)
Lists all files in a specified workspace for admin console requests.
|
PagingItemListJson<BaseJson> |
Rooms.listDocumentsForAdminV30(String roomId,
ListDocumentsVdrJson listDocumentsVdrJson)
Lists all files in a specified workspace for admin console requests.
|
PagingItemListJson<BaseJson> |
Workspaces.listDocumentsV30(String roomId,
ListDocumentsVdrJson listDocumentsVdrJson)
Requests a list of all files in a specified workspace.
|
PagingItemListJson<BaseJson> |
Rooms.listDocumentsV30(String roomId,
ListDocumentsVdrJson listDocumentsVdrJson)
Requests a list of all files in a specified workspace.
|
PagingItemListJson<BaseJson> |
IManageWorkspaces.listFoldersAndDocumentsV30(ListIManageFoldersAndDocumentsJson listIManageFoldersAndDocumentsJson)
Retrieves a list of iManage files and folders for a workspace or a
folder.
|
PagingItemListJson<BaseJson> |
TransientWorkspaces.listFoldersAndDocumentsV30(ListTransientFoldersAndDocumentsJson listTransientFoldersAndDocumentsJson)
Retrieves a list of transient files and folders.
|
PagingItemListJson<BaseJson> |
IManageWorkspaces.listMattersV30(ListIManageMattersJson listIManageMattersJson)
Retrieves a list of imanage top level matters and workspaces.
|
PagingItemListJson<BaseJson> |
Files.searchDocumentsV30(SearchDocumentsSdsJson searchDocumentsSdsJson)
Searches for a file in the Inbox/Sent items by name or string.
|
PagingItemListJson<BaseJson> |
Documents.searchDocumentsV30(SearchDocumentsSdsJson searchDocumentsSdsJson)
Searches for a file in the Inbox/Sent items by name or string.
|
PagingItemListJson<BaseJson> |
Search.searchV30(SearchRequestJson searchRequestJson)
Main Search Route
|
Copyright © 2019. All rights reserved.