All Classes

Class Description
AccessLevel
An enum of access level
AccountCreationStatusRequestJson  
AccountCreationStatusResultJson  
ActionLogToShow  
ActiveDirectoryActionLogType
An enum of Active Directory action log types.
ActiveDirectoryGroupActionType
An enum of Active Directory group action types.
ActiveDirectoryGroupInfoJson
Active Directory group details.
ActiveDirectoryGroupOrder
An enum of the values for ordering Active Directory groups.
ActiveDirectoryGroupSuggestionJson
An Active Directory group suggestion used when searching for AD groups
ActiveDirectoryGroupType
An enum of Active Directory Group types
ActiveDirectorySettingsJson
The details of an Active Directory connection when listing the details for an organization
ActiveDirectoryUserType
An enums of Active Directory user types
ActivityLogRecordJson
A single record the represents an activity of a user on a file used in reports
AddActiveDirectoryGroupJson
Add an Active Directory group.
AddActiveDirectoryGroupsJson
Add multiple Active Directory groups.
AddDocumentEntityJson
Give user permissions to a particular workspace file only.
AddDocumentPermissionRequestJson
Request to add permissions to a file.
AddDocumentsTagValuesJson
List tags.
AddEmailProtectorWhitelistEntitiesJson
Add users and domains to the Email Protector whitelist.
AddEntitiesIManageJson
Add user permissions to IManage workspaces or imanage documents.
AddEntitiesTransientJson
Add users to transient workspaces.
AddEntityVdrJson
List information when adding a user to a workspace.
AddFolderEntityJson
List information when adding a user to a workspace.
AddFolderPermissionRequestJson
Request for access to a folder.
AddIManageDocumentPermissionRequestJson
A request used when adding a file permission
AddIManageFolderPermissionRequestJson
A request used when adding an imanage workspace permission
AddMembersToGroupJson
Add multiple users to a group.
AddMembersToGroupWithGroupJson
Add multiple users to a group and add group information.
AddMemberToGroupJson
Add a single user to a group.
AddOrganizationBlacklistingJson
Add entities to blacklist.
AddOrganizationDistributionListJson
Add a new distribution list, including members.
AddOrganizationSystemAccountsIdpJson
Add multiple new system accounts.
AddOrganizationSystemAccountsIdpResponseJson
Response to adding new system accounts.
AddOrganizationWatermarkContentLineJson
Add content to a watermark.
AddOrganizationWatermarkJson
Add a new watermark.
AddRoomMemberJson
Add a user to a workspace.
AddRoomMembersJson
Add multiple users to a workspace.
AddSiteInputJson
Add a site.
AddSiteOutputJson  
AddTransientDocumentPermissionRequestJson
A request used when adding a file permission
AddTransientFolderPermissionRequestJson
A request used when adding a file permission
ADGroupType
This enum exists to minimise client-side options (verify we're requesting AD groups).
AggregatedPermissionDetailsResponseJson
Response to aggregated permission details.
AggregatedPermissionTemplateJson
Request aggregated permission details.
AggregationStatus
An enum of values for the aggreation status
AnnotationColorJson
An RGB color value
AnnotationFieldBaseJson
Base for other annotations.
AnnotationFlagsEnum
An enum of values for annotation flags
AnnotationGeometricalObjectType
An enum of the annotation geographical object types
AnnotationLineEndStyle
An enum of the annotation Line End Styles
AnnotationLinePointJson
A line end point
AnnotationPointJson
A single point
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.
AnnotationType
An enum of the annotation types
ApiDocumentFilter
An enum of API file filters
ApiDocumentOrderSDS
An enum of API file order SDS values
ApiDocumentOrderVDR
An enum of API file order workspace values
ApiErrors
An enum of api errors
ApiFavoriteItemOrder  
ApiFilterScope
An enum of API filter scope values
APIHttpMethod
Defines the HTTP methods used in sending requests to the API server.
APIRunner
Provides configuration and low level methods for using the BlackBerry Workspaces Android SDK.
APISession
APISession
ArrowDocumentAnnotationJson  
Authentication
Functions for handling authentication.
AuthenticationMethod
An enum of authentication methods
AuthenticationParametersJson
Request for authentication details.
AuthenticationPolicyJson
Set authentication policy.
AuthorizationActivity
Created by tasfaw on 10/5/2017.
AutocompleteRequestJson  
AvailableUserInfoJson
Show user details.
BaseJson
Base json
BaseLogJson
Information about how to export a log.
BlockCipherMode  
BoxOAuthParamsJson
Box OAuth Parameters
BulkDeleteWorkspaceDocumentsJson
Delete multiple files, includes information about how to delete.
BulkOperationResultJson
Show result of bulk operation.
BulkWorkspaceProtectorSettingsJson
Set workspace settings with SharePoint Protector.
CacheDocumentStatus
An enum of file cache status values
ChangeActiveDirectorySettingsStatusJson
Request to enable or disable Active Directory.
ChangeEntitiesIManageJson
Change multiple workspace member permissions for an imanage workspace or documents.
ChangeEntitiesTransientJson
Change multiple workspace member permissions for a transient workspace.
ChangeEntitiesVdrJson
Change multiple workspace member permissions for a workspace.
ChangeEntityVdrJson
Change a single workspace member permissions for a workspace.
CheckBoxAccessTokenResultJson
Result of checking Box access token.
CheckCredentialsResult
An enum of values for the result of credentials check
CheckDropboxAccessTokenResultJson
Result of checking Dropbox access token.
CheckIManageCredentialJson
Check IManage Credential
CheckIManageCredentialResultJson
Result of checking IManage Credential
CircleDocumentAnnotationJson  
ClassificationJson  
ClientTokenTTLConfigJson
Information about a client and its associated token.
Color
An enum of color values
CommentMentionType
Created by sbenhayun on 1/23/2017.
ConnectorConfigurationJson
a Connector configuration - contains the info of how to login to the connector
Consts  
Consts  
Consts.ApiDocumentOrder  
Consts.DocumentStatus  
ConversionModuleStatus
An enum of values for the conversion module status
CopyDocumentFromInboxJson
Copy files from Inbox.
CopyDocumentFromRoomJson
List users to receive a notification with link and permissions assigned sending a copy.
CopyIManageDocumentToExchangeAsyncJson
List users to receive a notification with link and permissions assigned sending a copy from a imanage workspace.
CopyMembershipJson
List users when copying membership.
CopyMultipleDocumentsToExchangeAsyncJson
List of documents to send to exchange.
CopyTransientDocumentToExchangeAsyncJson
List users to receive a notification with link and permissions assigned sending a copy from a transient workspace.
CountingRoomEntityJson
Used when listing the workspace entities (groups/domain/everyone) that are members of the workspace.
CreateAggregatedUserDocActivityReportJson
Created by egilron on 6/12/2016.
CreateDropboxWorkspaceJson
A new transient workspace to create
CreateFolderAsyncJson  
CreateFolderJson
Add folder.
CreateIManageActivityLogRecordJson
Used when adding a notification for a file action in the file's activity log file.
CreateIManageFolderJson
Add a folder for an Imanage workspace.
CreateiManageWorkspaceCredentialsJson
Credentials for an iManage workspace
CreateInternalDomainLicensingReportJson  
CreateLicensingReportJson
Created by tdagan on 11/16/2016.
CreateMultipleRoomsJson  
CreateMultipleRoomsResponseJson  
CreateNewCommentJson  
CreateNewCommentResultJson  
CreateNewDocumentJson  
CreateNewIManageDocumentJson
Information for creating imanage document
CreateNewTransientCommentJson  
CreateNewTransientCommentResultJson  
CreateNewTransientDocumentJson  
CreateOrganizationWeeklyStorageReportJson
Created by egilron on 12/12/2016.
CreateQuickSendStorageReportJson
Created by egilron on 14/12/2016.
CreateRoomEntityJson  
CreateRoomJson
Add workspace.
CreateSessionJson
Settings for creating a new user session.
CreateTransientActivityLogRecordJson
Used when adding a notification for a file action in the file's activity log file.
CreateTransientFolderJson
Add transient workspace.
CreateTransientWorkspaceJson
A new transient workspace to create
CreateWorkspaceExternalFoldersJson
A collection of external folders to be created in a workspace.
CreateWorkspaceFolderTreeJson
A workspace folder tree that will be created.
CreateWorkspaceFolderTreeRecordJson
A single entry in a new workspace folder tree.
CreateWorkspacesStorageReportJson
Created by egilron on 14/12/2016.
DefaultNotificationEmailJson
The default notification email
DefaultWorkspacePermissionsJson  
DeleteActiveDirectoryGroupListJson
A collection of active directory groups to be deleted.
DeleteActiveDirectorySettingsJson
An active directory setting to be deleted.
DeleteCommentJson  
DeleteDocumentsSelectionSdsJson
Files to be deleted from Inbox/Sent items.
DeleteDocumentsSelectionVdrJson
Files or folders to be deleted from a workspace.
DeleteEmbeddedNotificationJson
Created by tdagan on 3/27/2017.
DeleteFolderJson
Delete folder and all its contents from a workspace.
DeleteIdpSettingsJson
A list of IDP settings to remove from the organization.
DeleteIManageDocumentsAndFoldersJson
Delete folder and all its contents from a imanage workspace.
DeleteIManageWorkspaceJson
Delete iManage workspace.
DeleteNotificationJson
Notification for deleting a user.
DeleteOrganizationsDistributionListsJson
List distribution lists to delete.
DeleteOrganizationSystemAccountIdpJson
Delete system account from organization.
DeleteOrganizationWatermarkJson
Delete watermark from organization.
DeleteRoomEntitiesJson
Delete multiple items from a workspace.
DeleteRoomJson
Delete workspace.
DeleteTagsJson
List tags to delete.
DeleteTransientCommentJson  
DeleteTransientDocumentAnnotationsJson  
DeleteTransientDocumentsAndFoldersJson
Delete folder and all its contents from a transient workspace.
DeleteTransientWorkspaceJson
Delete transient workspace.
DeviceAction
An enum of device actions
DeviceInfoJson
List device information.
DeviceOperationAuthEnum
An enum of device operation auth values
DeviceState
An enum of device state values
DeviceType
An enum of device type values
DeviceTypeByAgent
An enum of device types by agent.
DeviceTypeJson  
DistributionListJson
Details of a single distribution list
DistributionlistsOrder
An enum of values for ordering distribution lists
DistributionListsReportOrder
An enum of values for ordering distribution list reports
DlpStatus
An enum of DLP status values
DocumentAccessLevel
An enum of values for file access level
DocumentAndRecipientsJson
Used when gathering information about bulk email notifications
DocumentAndVersionJson  
DocumentAnnotationDeserializer  
DocumentAnnotationJson
Annotation details
DocumentAnnotationsForUserJson  
DocumentAnnotationsForUsersJson  
DocumentAnnotationsJson
A collection of annotations
DocumentAnnotationsListJson
A collection of annotation records
DocumentAnnotationsListRecordJson
A single annotation list record
DocumentChunkJson
Information about a chunk of file data's status
DocumentChunksJson
Information about the status of multiple chunks of file data
DocumentCommentCountJson  
DocumentCommentJson  
DocumentConversionStatusJson
Status information of a file conversion
DocumentCurrentVersionJson
Current version information about a file.
DocumentExternalDataJson
A file's external data
DocumentExternalRepositoryDataJson
Information about a file's external repository
DocumentFormat
An enum of file format values
DocumentIdentifierJson  
DocumentJson
A file that is used in various operations
DocumentLinkInfoResultJson  
DocumentLinksJson
Details about a link within a file
DocumentModifiedDateSetJson
Used when setting a file's modified date
DocumentPageAnnotationsJson
A collection of annotations
DocumentPendingPermissionRequestJson
A pending request for a file permission
DocumentPermissionRequestsResultsJson
Result from a pending permission request
DocumentPlainAnnotationJson
A plain annotation
DocumentReportOrder
An enum of values for file report order for API V3 and above
Documents
Functions for sending secure files via BlackBerry Workspaces.
DocumentsModifiedDateSetJson
Modified date to be set for a file
DocumentsReadConfirmationEditJson  
DocumentsSelectionJson
Base type of several file selection JSONs
DocumentsSelectionSdsJson
Specifies a filter for selecting files
DocumentsSelectionVdrJson
Specifies various criteria for selecting files
DocumentStatusForApi
An enum of document status for api
DocumentsUpdateDataSetJson
A collection of file data updates to be applied to a file
DocumentTagType
An enum of document tag type
DocumentType
An enum of document type
DocumentUpdateDataSetJson
Information used when updating file data
DocumentVersionAnnotationsListJson
A set of annotation records used when getting file version information
DocumentVersionAnnotationsListRecordJson
Information about a single file annotation used when getting file version information
DocumentVersionReadConfirmedJson  
DocuSignPolicyJson  
DomainJson
A single domain's information
DomainsOrder
An enum of values for ordering domains.
DownloadCommentsJson  
DownloadDocumentsSelectionSdsJson
Used when choosing which files to download
DownloadDocumentsSelectionVdrJson
Used when choosing which files to download in a workspace
DownloadEventArgs  
DownloadFilesExample
Examples of downloading a file
DownloadManager
DownloadManager
DownloadPrepareDocumentStatusInputJson  
DownloadPrepareDocumentStatusOutputJson  
DownloadSentItemsDocumentsWithRecycleBinJson
User who's sent items and recycle bin will be downloaded
DownloadSingleDocumentSelectionJson
A single file to be downloaded
DownloadSingleIManageDocumentJson
Request for a document to be downloaded
DownloadSingleRecycleBinWorkspaceDocumentJson
Original version of a file to be downloaded.
DownloadSingleTransientDocumentForWebJson  
DownloadSingleTransientDocumentJson  
DownloadTransientCommentsJson  
DownloadTransientDocumentAnnotationsJson  
DownloadType
An enum of download type
DownloadTypes
An enum of download type values
DownloadWorkspaceDocumentsWithRecycleBinJson
Files to be downloaded from a workspace Recycle bin.
DropboxAccountNameJson  
DropboxCurrentAccountJson  
DropboxMountSharedFolderJson  
DropboxMountSharedFolderResultJson  
DropboxNewAccessTokenJson  
DropboxOAuthParamsJson
Dropbox OAuth Parameters
DropboxRootInfoJson  
EditActiveDirectoryGroupJson
Used when editing Active Directory groups in the organization
EditActiveDirectorySettingsJson
Used when editing the Active Directory settings for and organization
EditActiveDirectorySettingsResponseJson
Response from editing an organization's Active Directory settings
EditCollaborationJson
Edit collaboration settings.
EditExternalTransactionStatusInputJson
Used when editing the status of an external transaction
EditFoldersAndDocumentsSettingsBulkJson
Used when editing folder permissions in bulk
EditFolderSettingsJson
Used when editing folder permissions
EditIdpClientSettingsJson
Used when editing IDP settings for an organization
EditIdpSettingsJson
Used when editing IDP settings for an organization
EditIdpTTLSettingsJson  
EditManagersOnGroupJson
Add multiple users to a group and add group information.
EditOrganizationPolicyJson
Used when editing an organizational policy
EditOrganizationSystemAccountsIdpJson
Organizational system accounts to be updated
EditOrganizationWatermarkContentLineJson
An organizational watermark content line to be updated
EditOrganizationWatermarkJson
An organizational watermark to be updated
EditRoomJson
A workspace to be edited
EditTagJson
Information about a tag that will be renamed
EditUserJson
A user to be edited
EmailBulkDataJson
Collection used to store bulk email data
EmbeddedNotificationJson
Created by tdagan on 3/21/2017.
EmbeddedNotificationsCommentInfoJson  
EmbeddedNotificationsFilter  
EntityInFolderPermissionsJson
Permissions for an entity that exists in a folder
EntityInRoomResponseJson
Response when querying about entities in a workspace
EntityPermissionJson
A single permission for an entity
EntityStatusCode
An enum of values for entity status code
EntityType
An enum of values for entity type
Enums  
Enums.ConnectionError  
Enums.LoginResult  
Enums.PermissionMode  
Enums.ProxyType  
Enums.RestartStatus  
Enums.SecureTransferModes  
Enums.SignInType  
Enums.UploadStatus
UploadStatus Enum
ErrorInfoJson
Information about an error
ErrorItemType
An enum of error item types
ExistingActiveDirectoryGroupSuggestionJson
Details of a suggested Active Directory group
ExistingDocumentJson
A file that exists, but with a new suggested name
ExistingTransientDocumentJson  
ExpirationOptions
An enum of expiration values
ExportActivityHistoryForTransientRoomsJson
Used when exporting the activity history for multiple rooms
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
ExportUsersTransientActivityHistoryJson
Used when exporting activity history for a list of users in current user's organization to a CSV file
ExternalDataEntityType
A enum of external data entity types
ExternalDataItemJson
Simple key/value pair representing a piece of external data
ExternalDocumentsTransactionResultJson
Results from an action regarding external files
ExternalExceptionJson  
ExternalFoldersTransactionResultJson
Results from an action regarding external folders
ExternalIDPType
An enum of extenal IDP types
ExternalMessageJson  
ExternalMessagesJson  
ExternalRepositoryCloudStatus
An enum of values for external repository cloud status.
ExternalRepositoryGuidJson
Request with external Repository GUID
ExternalRepositoryIdRequestJson
Request for getting the ID of an external repository
ExternalRepositoryIdResultJson
Result from getting external repository ID information
ExternalRepositoryInitialSyncStatus
An enum of values for an external repository's initial sync status.
ExternalRepositoryRetrieveNewToken
An enum of values for whether to retrieve a new token for an external repository
ExternalRepositoryShowValue
An enum of values for external repository display
ExternalRepositoryType
An enum of external repository type
ExternalSiteDataJson
External site data
ExternalTransactionInputJson
Used when getting the status of an external transaction
ExternalTransactionStatusJson
The status of an external transaction
FileFormat
An enum of values for file formats
FileRequestData  
Files
Functions for sending secure files via BlackBerry Workspaces.
FolderDefaultPermissionsJson
The default permissions for a folder
FolderExternalDataJson
A collection of items in an external folder
FolderExternalRepositoryDataJson
Details about a folder in an external repository
FolderInfoJson
Details about a single folder
FolderJson
Details about a single folder
FolderLinksJson
Used when getting links for a folder in a workspace
FolderPathToUuidJson
Created by sbenhayun on 6/7/2017.
FolderPendingPermissionRequestJson
A request for permissions on an existing folder
FolderPendingPermissionRequestsJson
A collection of requests for folder permissions
FolderReadConfirmationEditJson  
FoldersDocumentsJson
A collection of folders and files
FolderSuggestedNameJson  
FormDataContentDisposition
Provides information about a file to be uploaded using an InputSteam.
FreeDrawDocumentAnnotationJson  
FreeDrawnElementDocumentAnnotationJson  
GdprStatus  
GenerateTransientDocumentGuidJson
GUID for a file in transient workspace's context
GeometricalObjectDocumentAnnotationJson  
GetDocumentActivityLogRequestJson
Request for getting information about an activity log
GetDocumentLinkInfoRequestJson
Request for getting information about a file link
GetDocumentsActivityLogRequestJson
Request for getting information about an activity log
GetDocumentsConversionStatusJson
Used when getting the status of a file conversion
GetDocumentsGuidsInfoJson
Created by ybennatan on 8/29/2016.
GetDocumentsVersionsInfoJson
Created by ybennatan on 8/31/2016.
GetDropboxWorkspaceJson
Dropbox Wrokspace Repository GUID
GetEmailBulkDataJson
Used when getting bulk data about email
GetFolderInfoJson
Used when getting information about a folder.
GetGroupInfoJson
Used when getting information about a group in a workspace
GetGuidByFolderAndNameJson
GUID of folder and filename
GetIManageDocumentActivityLogRequestJson
Used to get imanage document activity log
GetIManageDocumentPermissionsForIosJson
Used to identify a workspace to get permission information from
GetIManageFolderInfoJson
Information for getting the workspace or folder single level folders.
GetIManagePathInfoJson
A path to get information about
GetIManageWorkspaceInfoJson  
GetInfoUnauthDocumentResultJson
Result from getting informaton about an unauthorized file
GetOrRefreshAccessTokenResponseJson
Response from getting information about an access token that needs to be obtained or refreshed
GetPathInfoJson
A path to get information about
GetSamlIdpIdJson  
GetSAMLIdPMetadataJson  
GetSkipRoomsForRetentionInputJson  
GetTransientDocumentActivityLogRequestJson
Used to get an activity log
GetTransientDocumentPermissionsForIosJson
Used to identify a workspace to get permission information from
GetTransientFolderInfoJson
Workspace to get a single level of folders from
GetTransientWorkspaceInfoJson  
GetValidDocumentsGuidsInfoJson  
GetValidIManagePathInfoListJson  
GetValidPathInfoListJson  
GetWopiProofKeyJson  
GoodTokenErrorResponseJson
Error response when generating a BlackBerry Workspaces authentication token from a given Good authentication token.
GroupActionType
An enum of values for group actions
GroupAndMembersJson
Used when adding entities to a group
GroupLogRecordJson
A record used when exporting group logs
GroupRequestJson
Group request when filtering reports
GroupsLogByIdsJson
Used when exporting groups logs
GroupsLogByRoomsJson
Used when exporting groups logs
GroupsReportOrder
An enum of values for ordering group reports
GroupType
An enum of group types
GroupTypeRequest
Used to wrap the groupType enum to provide the "all" option without changing the original enum to prevent the GroupType enum from containing values that should not be saved in the database
GuidJson
A simple GUID
HideNotificationJson  
HighlightDocumentAnnotationJson  
HistoryPeriodJson
Time period used when exporting history logs
IAPISessionEvent  
IappUserActionType
An enum of iApp user actions
IappUserLevel
An enum of iApp user levels
IConnection  
IDownloadManagerEvent
IDownloadManagerEvent
IFileRequestData
Interface for file request data
IManageDocumentInfoJson
Used for getting file information
IManageDocumentInviteJson
Invite data for a document
IManageDocumentJson
Details for a file in a IManage workspace
IManageDocumentPermissionRequestsResultsJson
Result from a permission request for a document in a imanage workspace
IManageDocumentsTransactionResultJson
Result from copying files to Sent items
IManageEditFoldersAndDocumentsSettingsBulkJson
Used when bulk editing file settings
IManageFolderInfoResultJson
Result from getting a single folder level
IManageFolderJson
IManage folder info
IManageInitiateConversionJson
Used to initiate a conversion to PDF for a document
IManageInviteJson
Invite to imanage workspace or folder
IManageMatterInfoJson
The imanage matter info for creating imanage workspace locally
IManageMatterJson
Details of iManage matter/folder
IManageMoveJson
Used for moving folders or files
IManageWorkspaceInfoJson
IManage Workspace Info
IManageWorkspacePermissionRequestsResultsJson
Result from a pending transient workspace permission request
IManageWorkspaces
Functions for iManage workspace handling.
InitialSyncRoomDataJson
Used when applying a decision to a request
InitialSyncStatusJson
Status of an initial sync
InlineTextDocumentAnnotationJson  
InviteJson
Used to invite groups to a workspace
InviteTextJson
Information about the invite email
IsActiveDirectoryConfiguredResultJson
Result from determining if Active Directory is enabled
IsActiveDirectorySettingsEnabledJson
Used when finding out if Active Directory is enabled
ISessionCallbacks  
ItemErrorInfoJson
A problematic item found during different processes
ItemListJson<T extends BaseJson>
A generic list of items
Items
Functions for managing groups of items: documents, folders, workspaces
ItemWithErrorJson  
IUploadManagerEvent  
JacksonContextResolver
User: shalom Date: 10/30/11 3:56 PM
JaxbContextResolver  
JsonObjectTypes
An enum of json object types
KeyPair  
KMSRegionJson  
LastDocsWithActivityJson  
LastDocWithActivityJson  
LastResolvedDocumentPermissionRequestResultJson
Member of a list of last resolved permission requests on files in rooms and in exchange
LastResolvedFolderPermissionRequestResultJson
Member of a list of last resolved permission requests on folder
LastResolvedIManageDocumentPermissionRequestResultJson  
LastResolvedIManageFolderPermissionRequestResultJson  
LastResolvedTransientDocumentPermissionRequestResultJson  
LastResolvedTransientFolderPermissionRequestResultJson  
LayoutMode
An enum of layout modes
LineContentType
An enum of line content types
LineDocumentAnnotationJson  
ListActiveDirectoryGroupsJson
Details about how to get a list of Active Directory groups
ListActiveDirectoryGroupsSuggestionsJson
A list of suggestions used when searching for Active Directory groups
ListAllFavoriteItemsJson  
ListAllNotificationsJson
Created by tdagan on 3/21/2017.
ListBulkFolderPermissionsJson
Used when getting the aggregation of permissions of folders
ListDistributionListsByNameJson
Used when getting a list of members of a named distribution list
ListDistributionlistsJson
Information about returning a list of all distribution lists for an organization.
ListDocumentCommentsJson  
ListDocumentsPermissionRequestsJson
Used when listing existing permission requests for a file
ListDocumentsVdrJson
Details of how to obtain a list of files
ListDomainsJson
Details of how to obtain a list of domains
ListExchangesRecycleBinDocumentsJson
Used when listing hidden files in the Inbox and items in the Sent items Recycle bin.
ListExistingActiveDirectoryGroupsSuggestionsJson
Details about using suggestions when searching for Acive Directory groups
ListExternalConnectorsJson  
ListExternalConnectorsResultJson
Result json for the ListExternalConnectors API
ListFavoriteItemsJson  
ListFolderDefaultPermissionsJson
Details for listing permissions for each of the default entities in given folder
ListFolderPermissionRequestsJson
Used when listing existing permissions requests for folder or the entire workspace in case the root folder is supplied
ListIdpSettingsJson
Currently not used
ListIdpSettingsResultItemJson
Single result from listing IDP settings for organization
ListIdpSettingsResultItemMultiMemberJson
Multi result from listing IDP settings for organization
ListIManageFoldersAndDocumentsJson
Information for retrieving a list of iManage files and folders for a workspace or a folder.
ListIManageFoldersJson
Used to get the tree of all folders
ListIManageFoldersSingleLevelResultJson
Single level of tree folders
ListIManageMattersJson
Used when retrieving a list of imanage matters
ListIManagePermissionDetailsJson
Request for listing permission details for files or root folder in the imanage workspace
ListInternalDomainsForOrganizationRequestJson
Used when requesting organization's internal domains
ListInternalDomainsForOrganizationResponseJson
Response for requesting organization's internal domains
ListLastResolvedFolderPermissionRequestsJson
Details for listing last resolved permission requests on folder
ListLastResolvedTransientDocumentPermissionRequestsJson  
ListLastResolvedTransientFolderPermissionRequestsJson  
ListLibrariesInputJson
Libraries to list
ListLibrariesOutputJson  
ListNotificationsJson
Detals about how to list a user's notifications
ListOrganizationBlacklistingJson
Details for listing an organization's blacklist entries
ListOrganizationBlacklistingResultJson
Results from listing an organization's blacklist entries
ListOrganizationPolicyJson
Organization ID for listing policies
ListOrganizationSystemAccountsIdpJson
Used when listing organization system accounts
ListOrganizationWatermarksJson
Collection of watermark positions
ListPendingNumberPermissionRequestsJson
Details about how to list the number of pending existing file permission requests and workspace permission requests for an admin
ListPendingNumberPermissionRequestsResultJson
Result from listing the number of pending existing file permission requests and workspace permission requests for an admin
ListPermissionDetailsJson
Details for listing permission details for files and folders in bulk for all entities in the workspace
ListPermittedUsersToTransientWorkspaceJson  
ListRoomEntitiesJson
Details about how to list the workspace entities
ListRoomsByTypeJson
Result from a permission request for a document in a transient workspace
ListRoomsByTypeResultJson
Workspace information
ListSitesInputJson
Input when listing sites
ListSitesOutputJson  
ListStarredTransientDocumentsJson
List of starred files in transient workspace
ListSummaryEmbeddedNotificationJson  
ListSystemAccountItemJson
Details about a single system account
ListTagsJson
A list of tags
ListTagTreeJson
A tree of tag lists
ListTransientDocumentCommentsJson  
ListTransientDocumentsPermissionRequestsJson
Used when listing existing permission requests for a file
ListTransientFolderPermissionRequestsJson
Used when listing pending permission requests for folder in transient workspaces
ListTransientFoldersAndDocumentsJson
Used when retrieving a list of transient files and folders.
ListTransientFoldersJson
Used to get the tree of all folders
ListTransientFoldersSingleLevelResultJson
Single level of tree folders
ListTransientOrganizationPolicyJson
Used to get the organizational policy
ListTransientPermissionDetailsJson
Request for listing permission details for files and folders for all entities in the workspace
ListUserMentionInCommentsJson  
ListUserMentionInUnreadDocumentCommentsJson  
ListUserWorkspaceNotificationsSettingsJson  
ListVersionsReadConfirmationJson  
ListVersionsReadConfirmationRetJson  
ListWorkspaceGroupMembershipsForUserRequestJson
Used to list the groups a user is a member of
ListWorkspaceRecycleBinDocumentsJson
Used to list files in the workspace recycle bin.
ListWorkspaceRecycleBinWorkspacesJson
Used to list files in the workspaces recycle bin.
LoadToCacheJson
Details of what to load into the cache
LocalJacksonContextResolver  
LockDocumentsRequestJson
Request to lock files
LogActionType
An enum of log action values
LogSeverity
An enum of values for log severity
MailIcons  
MarkDocumentCommentsJson  
MarkDocumentsSelectionJson
Mark a set of files
MarkDocumentsSelectionSdsJson
Files selected for marking
MarkDocumentsSelectionVdrJson
Files selected for marking
MarkEmbeddedNotificationJson
Created by tdagan on 3/27/2017.
MarkIManageWorkspaceStarredJson
Set of workspaces to be marked as starred or unstarred(favorite)
MarkItemsStarredJson
Mark a set of items
MarkNotificationJson
Mark details
MarkOperationNotification
An enum of values for mark operation notifications
MarkOperationSDS
An enum of mark operation SDS values
MarkOperationVDR
An enum of mark operation workspace values
MarkupDocumentAnnotationJson  
MarkupLocationJson  
MembersJson
A membership list
ModifyGroupWithGroupJson
Information for modifying a group
MoveAllJson
Move all files to another folder
MoveFolderIntoFolderJson
Used when moving a folder to another folder
MoveFolderJson
Used when moving a folder
MoveJson
Used when moving files
MultipartUtility
This utility class provides an abstraction layer for sending multipart HTTP POST requests to a web server.
NetworkConnectionManager
NetworkConnectionManager
NewSessionJson
Details of a new session that was created
NoNullCollectionsBeanDeserializer
A BeanDeserializer subtype that initializes collections,maps and arrays with default values if they are null in the json pojo.
NoNullCollectionsBeanDeserializerModifier
User: shalom Date: 11/6/11 2:31 PM
NoNullCollectionsModule
This module adds functionality that null collections and arrays are initialized with empty defaults if they are not received or are null in the json input.
NoReplyEmailRequestJson
No reply email empty request
NoReplyEmailResponseJson
No reply email
NotificationJson
Used for listing a user's notifications
NotificationObject
An enum of Notification Objects
NotificationPeriod
An enum of values for notification period
Notifications
Functions for managing notifications.
OauthAccountState
An enum of OAUTH account states
OidcPublicKeyResultJson  
OnDemandRequestJson
Request for various demands
OneDriveManagement
Functions for managing OneDrive repositories.
OnlineViewerEncryptionMethod
An enum of online viewer encryption methods
OpenForAllRoomEditJson
Used for setting a workspace to be open to all entities
OrgAdminsUserEmailsJson  
OrganizationActiveBYOKJson  
OrganizationAuditActionTypeEnum
An enum of organization audit actions
OrganizationAuditAreaEnum
An enum of organization audit area values
OrganizationConversionPolicyJson
An orgainzation conversion policy
OrganizationCustomizationActionType
An enum of organization customization actions
OrganizationCustomizationFields
An enum of organization customization fields
OrganizationCustomizationJson
Details about organization customization
OrganizationEmailCustomizationFields  
OrganizationExchangePolicyJson
Organization file share policy
OrganizationPolicyJson
An organizational policy
OrganizationProduct
Products in the context of plans allocated to users in organization
OrganizationProtectAnywherePolicyJson
An organizational protect anywhere policy
OrganizationRole
An enum of organization roles
OrganizationRoleActionType
An enum of organization role action types
OrganizationRoleLogRecordJson
A single log record about organization roles
Organizations
Functions for managing organizations.
OrganizationStoragePolicyJson
Used for editing on organizational storage policy
OrganizationStoragePolicyResponseJson
Response from getting an organizational storage policy
OrganizationSubdomainCustomizationFields
An enum of organization subdomain customization fields
OrganizationSubdomainCustomizationJson
Information about subdomain customization
OrganizationSyncPolicyJson
Organization sync policy details
OrganizationToDeniedPermittedEntitiesLogActionTypeEnum
An enum of types for logging organization to denied permitted entities actions
OrganizationToDeniedPermittedEntitiesOrderEnum
An enum for ordering organization to denied permitted entities
OrganizationWatermarkConfigJson  
OrganizationWatermarkContentJson  
OrganizationWorkspacesPolicyJson
An organization workspace plicy
OrgAttributeType
An enum of organization attribute types
OrgCapabilityType
An enum of organization capability types
OrgLicenseExpirationTimeRequestJson
Created by sbenhayun on 8/3/2017.
OrgLicenseExpirationTimeResponseJson
Created by sbenhayun on 8/3/2017.
OrgLicenseSubscriptionInfoRequestJson  
OrgLicenseSubscriptionInfoResponseJson  
OrgLicenseType
An enum of organization license types
OrgRoleType
An enum of organization roles
PaginationJson
Pagination details
PagingItemListJson<T extends BaseJson>
Details about a page item
Pair<L,​R>  
PathAndExternalIdJson
A path and external ID
PathOrFolderIdJson
A path or ID for a folder
PdfConversionStatus
An enum of status values for PDF conversion
PermissionDetailsJson
List of permission details
PermissionFromUserJson
A permission from a user
PermissionRequestAction
An enum of actions for handling permission requests
PermissionRequestAdminAction
An enum of admin action for permission requests
PermissionRequestType
An enum of permission request types
PermissionRequestTypeExternalInterface
An enum of external interface types for permission requests
PermissionRequestUserAndTypeJson
User and type infomation for a permission request
PermissionSetJson
Various permissions
PermissionsTemplateForFolderRequestJson
Request for a folder permission template
PermissionsTemplateRequestJson
Request for a permissions template
PermissionsToUserForGetPermissionsJson
Permission to a user for getting permissions
PermissionsToUserJson
Permissions to a user
PermissionTemplateNameRequest
This must be synced with the existing templates in the database which are static at the moment
PermissionTemplatePayloadJson
Permission template payload
PermissionTemplateType
An enum of permission template types
PermittedEntityFromUserJson
A permitted entity from a user
PermittedEntityToUserJson
Permitted entity to user
PermittedEntityWithPermissionsFromUserJson
Permitted entity with permissions from a user
PersonalRoomJson
Personal workspace ("My workspace")
ProtectAnywhereSettingsActionLogType
An enum of log types for Protect Anywhere settings actions
ProtectAnywhereTemplateName
Used for setting max allowed template for protector rules.
ProtectorDownloadTypeResultJson
Result from getting info about a protector download type
PublicKeyJson
Request for authentication details.
PushNotificationsType
Created by sbenhayun on 3/13/2017.
ReadyForDownloadOriginal
An enum of values for reflecting ready to download original
RecentSharedWithMeJson  
RecycleBinDocumentJson
A recycle bin file
RecycleBinExchangeDocumentsOrder
An enum of values for ordering files in the Set items Recycle bin/hidden files in Inbox
RecycleBinWorkspaceDocumentsOrder
An enum of values for ordering files in the Recycle bin
RecycleBinWorkspacesOrder
An enum of values for ordering workspaces in the Recycle bin
RemoveDocumentsTagValuesJson
List of files to remove tags from
RemoveMembersFromGroupJson
Json representation of a list of members to remove from a group
RemoveOrganizationBlacklistingJson
List of entities to remove from the organization denied blacklist.
RemoveUsersJson
Users to remove from an organization
RenameDistributionListJson
New name for a distribution list
RenameFolderJson
Used when renaming a folder
RenameIManageDocumentJson
Information about the file to rename
RenameIManageFolderJson
Information about the folder to rename
RenameIManageFolderResultJson
Result from renaming transient folder
RenameTransientDocumentJson
A file to rename
RenameTransientFolderJson
A folder to rename
RenameTransientFolderResultJson
Result from renaming transient folder
ReportFilterJson
A report filter
ReportPeriod
An enum of report period values
ResolveActionForDocumentPermissionRequestJson
Request to resolve an action on a file
ResolveActionForFolderPermissionRequestJson
Request to resolve and action on a folder
ResolveActionForIManageDocumentPermissionRequestJson
Request to resolve and action on a file
ResolveActionForIManageFolderPermissionRequestJson
Request to resolve and action on an imanage workspace
ResolveActionForTransientDocumentPermissionRequestJson
Request to resolve and action on a file
ResolveActionForTransientFolderPermissionRequestJson
Request to resolve and action on a file
ResourceLoader  
RestoreExchangesRecycleBinDocumentsJson
Files to restore from the Sent items recycle bin to the original folders.
RestoreWorkspacesRecycleBinDocumentJson
Files to restore from the Sent items recycle bin to the original folders.
RestoreWorkspacesRecycleBinWorkspacesJson
Workspaces to restore from the recycle bin
Role
An enum of roles
RollbackToSnapshotJson  
RollbackToSnapshotRetJson  
RoomAccessLevel
An enum of workspace access levels
RoomEmailDataJson
List workspace files
RoomEntityJson
A workspace
RoomEntityType
An enum of workspace entity type
RoomExplicitJson
Used when marking a workspace explicit
RoomExternalDataJson
Items associated with a workspace
RoomExternalRepositoryDataJson
Information about an external repository
RoomJson
A workspace
RoomLinksJson
Used when getting a URL for a workspace
RoomListJson
List of workspaces
RoomRecipientsJson
List workspace members
RoomRole
An enum of workspace roles
Rooms
Functions for secure virtual data workspace handling.
RoomSearchType
An enum of search types for workspace
RoomsReportOrder
An enum of values for ordering workspace reports
RoomsReportRequestByMailJson
Request for a workspace report
SaveTransientWorkspaceCredentialsJson
Saves credentials for a transient workspace
SdkUtils  
SdsAddPermissionsJson
Information for adding SDS permissions
SdsAddRecipientsJson
Information for adding recipients to files
SdsEditPermissionsJson
Used when editing file permissions in Sent items
SdsGetRecipientsJson
File to list recipients of
SdsRevokePermissionsJson
Used when revoking all permissions for entities (users, groups, lists) for files in the Sent items.
Search  
SearchContext  
SearchDocumentsSdsJson
Used when searching a file for a string
SearchDocumentsVdrJson
Used when searching files for a string
SearchFilter  
SearchFilterJson  
SearchOrder  
SearchRequestJson  
SendEmailBulkJson
Used when sending bulk email notifications for a list of files to all permitted entities (users, groups etc) for each file
SendEmailJson
Used when sending an email
SendEmailsToIManageDocumentsJson
Used when sending emails
SendEmailsToTransientDocumentsJson
Used when sending emails
SendNotificationsJson  
SendSupportEmailJson  
ServiceAccountAuthenticationExample  
Sessions
Functions for connecting and identifying users with the BlackBerry Workspaces API servers.
SetClassificationJson
Used to set the classification on a file
SetupBoxTokenJson
A Box authorization code for setting up Box token.
SharedWithMeJson  
SharedWithMeOrder
An enum of values for ordering user notifications
SharedWithMeResponseJson  
SharePoint
Functions for managing SharePoint repositories.
SharepointRoomJson
SharePoint workspace
ShareTransientDocumentAnnotationJson  
SigningAlgorithm
An enum of signing algorithms
SignInIManageResultJson
SignIn IManage
SignInManager
SignInManager
SimpleNaturalIntegerJson
this json allows us to differentiate between the following case when supplying integer values for updating in the DB 1.
SingleListDataEntityType
An enum of single list date entities
SkipRetentionRoomInfoJson  
SkipRoomForRetentionJson  
SkipRoomsForRetentionInputJson  
SkipRoomsForRetentionOutputJson  
SquareDocumentAnnotationJson  
StarredTransientDocumentsJson
Starred files in transient workspaces
StatusJson
A command status
StrikeoutDocumentAnnotationJson  
SubmitDocumentResultJson
Result from submitting a file
SubmitDocumentSdsJson
These parameters are needed when submitting files in SDS mode (not to a workspace).
SubmitDocumentsVdrJson
Used when submitting files
SubmitDocumentVdrJson  
SubmitIfNewIManageDocumentJson  
SubmitIfNewJson  
SubmitIfNewTransientDocumentJson  
SubmitIManageDocumentResultJson  
SubmitIManageDocumentVdrJson  
SubmitIManageVersionVdrJson  
SubmitTransientDocumentResultJson  
SubmitTransientDocumentVdrJson  
SubmitTransientVersionVdrJson  
SuccessLevel
An enum of success levels
SummaryEmbeddedNotificationJson  
SystemProperties
Functions for accessing basic BlackBerry Workspaces system properties.
SystemPropertiesJson
Various system properties
TagDateValueAddJson
A tag date value
TagDateValueRemoveJson
Used when removing values
TagFieldJson
A tag
TagListJson
A collection of tags
TagListRemoveJson
Used when removing tags
TagNumericValueAddJson
A tag numeric value
TagNumericValueRemoveJson
Used when removing values
TagRecordJson  
TagsOrder
An enum for values for ordering tags
TagStringValueAddJson
A tag text value
TagStringValueRemoveJson
Used when removing values
TagTreeJson
A tag tree
TemplatePermissionsFilter
An enum of values for template permissions
TextCommentDocumentAnnotationJson  
TextMarkupDocumentAnnotationJson  
TextualDocumentAnnotationJson  
TimeEstimationJson
Estimated seconds left
TotalEmbeddedNotificationsRequestJson  
TotalEmbeddedNotificationsResponseJson  
TransactionInputJson
Used when getting a file transaction status
TransactionStatusEnum
An enum of transaction status values
TransactionStatusJson
File transaction status
TransientDocumentAndUsersJson  
TransientDocumentCommentCountJson  
TransientDocumentInfoJson
Used for getting file information
TransientDocumentInviteJson  
TransientDocumentJson
Details for a file in a transient workspace
TransientDocumentPendingPermissionRequestJson
A pending request for a file permission in a transient workspace
TransientDocumentPermissionRequestsResultsJson
Result from a permission request for a document in a transient workspace
TransientDocumentsTransactionResultJson
Result from copying files to Sent items
TransientEditFoldersAndDocumentsSettingsBulkJson
Used when bulk editing file settings
TransientEntityOrderByDirectionEnum
An enum of values for directional order of transient entities
TransientEntityOrderByEnum
An enum of values for ordering transient entities
TransientFolderInfoResultJson
Result from getting a single folder level
TransientFolderJson
Details of a transient folder
TransientFolderPendingPermissionRequestJson
A request for permissions on an existing folder
TransientFolderPermissionRequestsResultsJson
Result from a pending transient workspace permission request
TransientInitiateConversionFileFormat
An enum of file formats
TransientInitiateConversionJson
Used to initiate a conversion
TransientInitiateConversionResultJson
Result from initiating a conversion
TransientInviteJson
Invite
TransientListUserMentionInUnreadDocumentCommentsJson  
TransientMoveJson
Used for moving folders or files
TransientPathInfoJson  
TransientWorkspaceExternalDataJson
Workspace external data
TransientWorkspaceInfoJson
Transient Workspace Info
TransientWorkspaceJson
A transient worksapce
TransientWorkspaces
Functions for secure virtual data transient workspace handling.
TrueFalseEither
An enum of Boolean values including either(null)
UnauthDocumentInfoJson
Details used when opening a file
UnauthDocumentJson
File details
UnderlineDocumentAnnotationJson  
UnlockDocumentsRequestJson
Request to unlock a file
UnregisterUserForPushNotificationJson
Created by sbenhayun on 3/8/2017.
UnStarredTransientDocumentsJson
Files in transient workspaces that are not starred.
UpdateCommentJson  
UpdateDocumentJson
Used when updating a file
UpdateTransientCommentJson  
UploadFilesExample
Examples of uploading a file
UploadManager
UploadManager
UploadResult
Uploads result
UploadUserTransientDocumentAnnotationsJson  
UrlJson
URL Json contains a URL
User  
UserAbilitiesJson
Details about a user's abilities
UserAuthenticationActivityType  
UserAuthenticationLoggingInitialDateResponseJson  
UserDataJson
Details about a user
UserDetailsJson
User details
UserDeviceNotificationTypeSettingsJson  
UserDirectMembershipResolveDataJson
Data used for resolving user direct membership
UserJson
A user
UserNotificationOrder
An enum of values for ordering user notifications
UserReportJson  
UserRoleJson
A user role
Users
Functions for managing users.
UsersExample
Examples of Workspaces User functionality
UsersForPasswordResetJson
Users who need a password reset
UsersJson
User list
UsersOrder
An enum of values for ordering users
UsersReportOrder
An enum of values for ordering users reports
UsersReportRequestJson  
UserWorkspaceNotificationsSettingsJson  
ValidateCreateFolderJson
Used to validate params when creating a folder
ValidateDownloadDocumentsSelectionSdsJson
Used when validating files for download
ValidateDownloadDocumentsSelectionVdrJson
Used when validating files for download
ValidateDownloadDocumentVersionInVdrsJson
Used when validating files for download
ValidateDownloadIManageDocumentsJson
Used for validating a file for download
ValidateDownloadSentItemsDocumentsWithRecycleBinJson
Used when validating sent items download of a user with it's recycle bin.
ValidateDownloadTransientDocumentsAnnotationsJson  
ValidateDownloadTransientDocumentsJson
Used for validating a file for download
ValidateDownloadUserTransientDocumentAnnotationsInDocJson  
ValidateDownloadWorkspaceDocumentsWithRecycleBinJson
Used when validating files to download from a recycle bin.
ValidateKCDWorkspaceCredentialsJson
Validates credentials for a kcd transient workspace
ValidateSAMLIdPMetadataJson  
ValidateUsersNotAdminsInWorkspacesRequestJson
Used when validating non-admin users in a workspace
ValidateUsersNotAdminsInWorkspacesResponseJson
Response to validating non-admin users in a workspace
ValidIManagePathInfoJson
Request for getting documents info
ValidPathInfoJson  
VdrAddPermissionsJson
Add permissions to an entity
VdrDocumentFilter
An enum of values for filtering workspace files
VdrDocumentOrder
An enum of values for ordering workspace files.
VdrEditPermissionsJson
Used when editing permissions for a list of files for a list of entities
VdrRevokePermissionJson
Used when revoking permissions
VerifyActiveDirectorySettingsJson
An a Active Directory setting to be verified
ViewerWatermarkJson
A viewer watermark
WatchdoxSDKException
Exception thrown when errors occur completing API requests.
WaterMarkPosition
An enum of values for a watermark's position
WhoCanView
An enum of values specifying who can view a file
WopiProofKeyJson  
WorkspaceCapabilityType
An enum of values for specifying workspace capability
WorkspaceGroupMembershipForUserInfoJson  
WorkspaceInfoJson
Workspace information
WorkspaceProtectorSettingsJson
Used when setting a protector
Workspaces
Functions for secure virtual data workspace handling.
WorkspacesExample
Examples of Workspaces Workspace functionality
WorkspacesLogger  
YesNoDefault
An enum of boolean-mirroring values