Click or drag to resize
BlackBerry.Workspaces.Json Namespace
BlackBerry Workspaces Json Namespace
Classes
  ClassDescription
Public classAccountCreationStatusRequestJson
Public classAccountCreationStatusResultJson
Public classActiveDirectoryGroupInfoJson
Active Directory group details.
Public classActiveDirectoryGroupSuggestionJson
An Active Directory group suggestion used when searching for AD groups
Public classActiveDirectorySettingsJson
The details of an Active Directory connection when listing the details for an organization
Public classActivityLogRecordJson
A single record the represents an activity of a user on a file used in reports
Public classAddActiveDirectoryGroupJson
Add an Active Directory group.
Public classAddActiveDirectoryGroupsJson
Add multiple Active Directory groups.
Public classAddDocumentEntityJson
Give user permissions to a particular workspace file only.
Public classAddDocumentPermissionRequestJson
Request to add permissions to a file.
Public classAddDocumentsTagValuesJson
List tags.
Public classAddEmailProtectorWhitelistEntitiesJson
Add users and domains to the Email Protector whitelist.
Public classAddEntitiesIManageJson
Add users to IManage workspaces.
Public classAddEntitiesTransientJson
Add users to transient workspaces.
Public classAddEntityVdrJson
List information when adding a user to a workspace.
Public classAddFolderEntityJson
List information when adding a user to a workspace.
Public classAddFolderPermissionRequestJson
Request for access to a folder.
Public classAddIManageDocumentPermissionRequestJson
A request used when adding a file permission
Public classAddIManageFolderPermissionRequestJson
A request used when adding an imanage workspace permission
Public classAddMembersToGroupJson
Add multiple users to a group.
Public classAddMembersToGroupWithGroupJson
Add multiple users to a group and add group information.
Public classAddMemberToGroupJson
Add a single user to a group.
Public classAddOrganizationBlacklistingJson
Add entities to blacklist.
Public classAddOrganizationDistributionListJson
Add a new distribution list, including members.
Public classAddOrganizationSystemAccountsIdpJson
Add multiple new system accounts.
Public classAddOrganizationSystemAccountsIdpResponseJson
Response to adding new system accounts.
Public classAddOrganizationWatermarkContentLineJson
Add content to a watermark.
Public classAddOrganizationWatermarkJson
Add a new watermark.
Public classAddRoomMemberJson
Add a user to a workspace.
Public classAddRoomMembersJson
Add multiple users to a workspace.
Public classAddSiteInputJson
Add a site.
Public classAddSiteOutputJson
Public classAddTransientDocumentPermissionRequestJson
A request used when adding a file permission
Public classAddTransientFolderPermissionRequestJson
A request used when adding a file permission
Public classAggregatedPermissionDetailsResponseJson
Response to aggregated permission details.
Public classAggregatedPermissionTemplateJson
Request aggregated permission details.
Public classAnnotationColorJson
An RGB color value
Public classAnnotationFieldBaseJson
Base for other annotations. Do not use.
Public classAnnotationPointJson
A single point
Public classAnnotationRectangleJson
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.
Public classArrowDocumentAnnotationJson
Public classAuthenticationParametersJson
Request for authentication details.
Public classAuthenticationPolicyJson
Set authentication policy.
Public classAutocompleteRequestJson
Public classAvailableUserInfoJson
Show user details.
Public classBaseJson
Base class for BlackBerry Workspaces JSON objects.
Public classBaseLogJson
Information about how to export a log.
Public classBulkDeleteWorkspaceDocumentsJson
Delete multiple files, includes information about how to delete.
Public classBulkOperationResultJson
Show result of bulk operation.
Public classBulkWorkspaceProtectorSettingsJson
Set workspace settings with SharePoint Protector.
Public classChangeActiveDirectorySettingsStatusJson
Request to enable or disable Active Directory.
Public classChangeEntitiesIManageJson
Change multiple workspace member permissions for a imanage workspace.
Public classChangeEntitiesTransientJson
Change multiple workspace member permissions for a transient workspace.
Public classChangeEntitiesVdrJson
Change multiple workspace member permissions for a workspace.
Public classChangeEntityVdrJson
Change a single workspace member permissions for a workspace.
Public classCheckIManageCredentialJson
Check IManage Credential
Public classCheckIManageCredentialResultJson
Result of checking IManage Credential
Public classCircleDocumentAnnotationJson
Public classClassificationJson
Public classClientTokenTTLConfigJson
Information about a client and its associated token.
Public classConnectorConfigurationJson
a Connector configuration - contains the info of how to login to the connector
Public classCopyDocumentFromInboxJson
Copy files from Inbox.
Public classCopyDocumentFromRoomJson
List users to receive a notification with link and permissions assigned sending a copy.
Public classCopyIManageDocumentToExchangeAsyncJson
List users to receive a notification with link and permissions assigned sending a copy from a imanage workspace.
Public classCopyMembershipJson
List users when copying membership.
Public classCopyMultipleDocumentsToExchangeAsyncJson
List of documents to send to exchange. WS documents and transient workspace documents.
Public classCopyTransientDocumentToExchangeAsyncJson
List users to receive a notification with link and permissions assigned sending a copy from a transient workspace.
Public classCountingRoomEntityJson
Used when listing the workspace entities (groups/domain/everyone) that are members of the workspace.
Public classCreateAggregatedUserDocActivityReportJson
Created by egilron on 6/12/2016.
Public classCreateFolderAsyncJson
Public classCreateFolderJson
Add folder.
Public classCreateIManageActivityLogRecordJson
Used when adding a notification for a file action in the file's activity log file.
Public classCreateIManageFolderJson
Add a folder for an Imanage workspace.
Public classCreateiManageWorkspaceCredentialsJson
Credentials for an iManage workspace
Public classCreateInternalDomainLicensingReportJson
Public classCreateLicensingReportJson
Created by tdagan on 11/16/2016.
Public classCreateMultipleRoomsJson
Public classCreateMultipleRoomsResponseJson
Public classCreateNewCommentJson
Public classCreateNewCommentResultJson
Public classCreateNewDocumentJson
Public classCreateNewIManageDocumentJson
Information for creating imanage document
Public classCreateNewTransientCommentJson
Public classCreateNewTransientCommentResultJson
Public classCreateNewTransientDocumentJson
Public classCreateOrganizationWeeklyStorageReportJson
Created by egilron on 12/12/2016.
Public classCreateQuickSendStorageReportJson
Created by egilron on 14/12/2016.
Public classCreateRoomEntityJson
Public classCreateRoomJson
Add workspace.
Public classCreateSessionJson
Settings for creating a new user session.
Public classCreateTransientActivityLogRecordJson
Used when adding a notification for a file action in the file's activity log file.
Public classCreateTransientFolderJson
Add transient workspace.
Public classCreateTransientWorkspaceJson
A new transient workspace to create
Public classCreateWorkspaceExternalFoldersJson
A collection of external folders to be created in a workspace.
Public classCreateWorkspaceFolderTreeJson
A workspace folder tree that will be created.
Public classCreateWorkspaceFolderTreeRecordJson
A single entry in a new workspace folder tree.
Public classCreateWorkspacesStorageReportJson
Created by egilron on 14/12/2016.
Public classDefaultNotificationEmailJson
The default notification email
Public classDefaultWorkspacePermissionsJson
Public classDeleteActiveDirectoryGroupListJson
A collection of active directory groups to be deleted.
Public classDeleteActiveDirectorySettingsJson
An active directory setting to be deleted.
Public classDeleteCommentJson
Public classDeleteDocumentsSelectionSdsJson
Files to be deleted from Inbox/Sent items.
Public classDeleteDocumentsSelectionVdrJson
Files or folders to be deleted from a workspace.
Public classDeleteEmbeddedNotificationJson
Created by tdagan on 3/27/2017.
Public classDeleteFolderJson
Delete folder and all its contents from a workspace.
Public classDeleteIdpSettingsJson
A list of IDP settings to remove from the organization.
Public classDeleteIManageDocumentsAndFoldersJson
Delete folder and all its contents from a imanage workspace.
Public classDeleteIManageWorkspaceJson
Delete iManage workspace.
Public classDeleteNotificationJson
Notification for deleting a user.
Public classDeleteOrganizationsDistributionListsJson
List distribution lists to delete.
Public classDeleteOrganizationSystemAccountIdpJson
Delete system account from organization.
Public classDeleteOrganizationWatermarkJson
Delete watermark from organization.
Public classDeleteRoomEntitiesJson
Delete multiple items from a workspace.
Public classDeleteRoomJson
Delete workspace.
Public classDeleteTagsJson
List tags to delete.
Public classDeleteTransientCommentJson
Public classDeleteTransientDocumentAnnotationsJson
Public classDeleteTransientDocumentsAndFoldersJson
Delete folder and all its contents from a transient workspace.
Public classDeleteTransientWorkspaceJson
Delete transient workspace.
Public classDeviceInfoJson
List device information.
Public classDeviceTypeJson
Public classDistributionListJson
Details of a single distribution list
Public classDocumentAndRecipientsJson
Used when gathering information about bulk email notifications
Public classDocumentAndVersionJson
Public classDocumentAnnotationJson
Annotation details
Public classDocumentAnnotationsForUserJson
Public classDocumentAnnotationsForUsersJson
Public classDocumentAnnotationsJson
A collection of annotations
Public classDocumentAnnotationsListJson
A collection of annotation records
Public classDocumentAnnotationsListRecordJson
A single annotation list record
Public classDocumentChunkJson
Information about a chunk of file data's status
Public classDocumentChunksJson
Information about the status of multiple chunks of file data
Public classDocumentCommentCountJson
Public classDocumentCommentJson
Public classDocumentConversionStatusJson
Status information of a file conversion
Public classDocumentCurrentVersionJson
Current version information about a file. Used in various places.
Public classDocumentExternalDataJson
A file's external data
Public classDocumentExternalRepositoryDataJson
Information about a file's external repository
Public classDocumentIdentifierJson
Public classDocumentJson
A file that is used in various operations
Public classDocumentLinkInfoResultJson
Public classDocumentLinksJson
Details about a link within a file
Public classDocumentModifiedDateSetJson
Used when setting a file's modified date
Public classDocumentPageAnnotationsJson
A collection of annotations
Public classDocumentPendingPermissionRequestJson
A pending request for a file permission
Public classDocumentPermissionRequestsResultsJson
Result from a pending permission request
Public classDocumentPlainAnnotationJson
A plain annotation
Public classDocumentsModifiedDateSetJson
Modified date to be set for a file
Public classDocumentsReadConfirmationEditJson
Public classDocumentsSelectionJson
Base type of several file selection JSONs
Public classDocumentsSelectionSdsJson
Specifies a filter for selecting files
Public classDocumentsSelectionVdrJson
Specifies various criteria for selecting files
Public classDocumentsUpdateDataSetJson
A collection of file data updates to be applied to a file
Public classDocumentUpdateDataSetJson
Information used when updating file data
Public classDocumentVersionAnnotationsListJson
A set of annotation records used when getting file version information
Public classDocumentVersionAnnotationsListRecordJson
Information about a single file annotation used when getting file version information
Public classDocumentVersionReadConfirmedJson
Public classDocuSignPolicyJson
Public classDomainJson
A single domain's information
Public classDownloadCommentsJson
Public classDownloadDocumentsSelectionSdsJson
Used when choosing which files to download
Public classDownloadDocumentsSelectionVdrJson
Used when choosing which files to download in a workspace
Public classDownloadPrepareDocumentStatusInputJson
Public classDownloadPrepareDocumentStatusOutputJson
Public classDownloadSentItemsDocumentsWithRecycleBinJson
User who's sent items and recycle bin will be downloaded
Public classDownloadSingleDocumentSelectionJson
A single file to be downloaded
Public classDownloadSingleIManageDocumentJson
Request for a document to be downloaded
Public classDownloadSingleRecycleBinWorkspaceDocumentJson
Original version of a file to be downloaded. Allowed only for workspace admins
Public classDownloadSingleTransientDocumentForWebJson
Public classDownloadSingleTransientDocumentJson
Public classDownloadTransientCommentsJson
Public classDownloadTransientDocumentAnnotationsJson
Public classDownloadWorkspaceDocumentsWithRecycleBinJson
Files to be downloaded from a workspace Recycle bin.
Public classEditActiveDirectoryGroupJson
Used when editing Active Directory groups in the organization
Public classEditActiveDirectorySettingsJson
Used when editing the Active Directory settings for and organization
Public classEditActiveDirectorySettingsResponseJson
Response from editing an organization's Active Directory settings
Public classEditCollaborationJson
Edit collaboration settings.
Public classEditExternalTransactionStatusInputJson
Used when editing the status of an external transaction
Public classEditFoldersAndDocumentsSettingsBulkJson
Used when editing folder permissions in bulk
Public classEditFolderSettingsJson
Used when editing folder permissions
Public classEditIdpClientSettingsJson
Used when editing IDP settings for an organization
Public classEditIdpSettingsJson
Used when editing IDP settings for an organization
Public classEditIdpTTLSettingsJson
Public classEditManagersOnGroupJson
Add multiple users to a group and add group information.
Public classEditOrganizationPolicyJson
Used when editing an organizational policy
Public classEditOrganizationSystemAccountsIdpJson
Organizational system accounts to be updated
Public classEditOrganizationWatermarkContentLineJson
An organizational watermark content line to be updated
Public classEditOrganizationWatermarkJson
An organizational watermark to be updated
Public classEditRoomJson
A workspace to be edited
Public classEditTagJson
Information about a tag that will be renamed
Public classEditUserJson
A user to be edited
Public classEmailBulkDataJson
Collection used to store bulk email data
Public classEmbeddedNotificationJson
Created by tdagan on 3/21/2017.
Public classEmbeddedNotificationsCommentInfoJson
Public classEntityInFolderPermissionsJson
Permissions for an entity that exists in a folder
Public classEntityInRoomResponseJson
Response when querying about entities in a workspace
Public classEntityPermissionJson
A single permission for an entity
Public classErrorInfoJson
Information about an error
Public classExistingActiveDirectoryGroupSuggestionJson
Details of a suggested Active Directory group
Public classExistingDocumentJson
A file that exists, but with a new suggested name
Public classExistingTransientDocumentJson
Public classExportActivityHistoryForTransientRoomsJson
Used when exporting the activity history for multiple rooms
Public classExportSpecificUsersTransientActivityHistoryByMailJson
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
Public classExportUsersTransientActivityHistoryJson
Used when exporting activity history for a list of users in current user's organization to a CSV file
Public classExternalDataItemJson
Simple key/value pair representing a piece of external data
Public classExternalDocumentsTransactionResultJson
Results from an action regarding external files
Public classExternalFoldersTransactionResultJson
Results from an action regarding external folders
Public classExternalRepositoryIdRequestJson
Request for getting the ID of an external repository
Public classExternalRepositoryIdResultJson
Result from getting external repository ID information
Public classExternalSiteDataJson
External site data
Public classExternalTransactionInputJson
Used when getting the status of an external transaction
Public classExternalTransactionStatusJson
The status of an external transaction
Public classFolderDefaultPermissionsJson
The default permissions for a folder
Public classFolderExternalDataJson
A collection of items in an external folder
Public classFolderExternalRepositoryDataJson
Details about a folder in an external repository
Public classFolderInfoJson
Details about a single folder
Public classFolderJson
Details about a single folder
Public classFolderLinksJson
Used when getting links for a folder in a workspace
Public classFolderPathToUuidJson
Created by sbenhayun on 6/7/2017.
Public classFolderPendingPermissionRequestJson
A request for permissions on an existing folder
Public classFolderPendingPermissionRequestsJson
A collection of requests for folder permissions
Public classFolderReadConfirmationEditJson
Public classFoldersDocumentsJson
A collection of folders and files
Public classFolderSuggestedNameJson
Public classFreeDrawDocumentAnnotationJson
Public classFreeDrawnElementDocumentAnnotationJson
Public classGenerateTransientDocumentGuidJson
GUID for a file in transient workspace's context
Public classGeometricalObjectDocumentAnnotationJson
Public classGetDocumentActivityLogRequestJson
Request for getting information about an activity log
Public classGetDocumentLinkInfoRequestJson
Request for getting information about a file link
Public classGetDocumentsActivityLogRequestJson
Request for getting information about an activity log
Public classGetDocumentsConversionStatusJson
Used when getting the status of a file conversion
Public classGetDocumentsGuidsInfoJson
Created by ybennatan on 8/29/2016.
Public classGetDocumentsVersionsInfoJson
Created by ybennatan on 8/31/2016.
Public classGetEmailBulkDataJson
Used when getting bulk data about email
Public classGetFolderInfoJson
Used when getting information about a folder. Either the "roomId" or the "roomGuid" must be specified to identify the workspace. The "path", "folderId", "folderGuid" must be specified to identify the folder.
Public classGetGroupInfoJson
Used when getting information about a group in a workspace
Public classGetGuidByFolderAndNameJson
GUID of folder and filename
Public classGetIManageDocumentActivityLogRequestJson
Used to get imanage document activity log
Public classGetIManageDocumentPermissionsForIosJson
Used to identify a workspace to get permission information from
Public classGetIManageFolderInfoJson
Information for getting the workspace or folder single level folders.
Public classGetIManagePathInfoJson
A path to get information about
Public classGetIManageWorkspaceInfoJson
Public classGetInfoUnauthDocumentResultJson
Result from getting informaton about an unauthorized file
Public classGetOrRefreshAccessTokenResponseJson
Response from getting information about an access token that needs to be obtained or refreshed
Public classGetPathInfoJson
A path to get information about
Public classGetSamlIdpIdJson
Public classGetSAMLIdPMetadataJson
Public classGetTransientDocumentActivityLogRequestJson
Used to get an activity log
Public classGetTransientDocumentPermissionsForIosJson
Used to identify a workspace to get permission information from
Public classGetTransientFolderInfoJson
Workspace to get a single level of folders from
Public classGetTransientWorkspaceInfoJson
Public classGetValidDocumentsGuidsInfoJson
Public classGetValidIManagePathInfoListJson
Public classGetValidPathInfoListJson
Public classGetWopiProofKeyJson
Public classGoodTokenErrorResponseJson
Error response when generating a BlackBerry Workspaces authentication token from a given Good authentication token.
Public classGroupAndMembersJson
Used when adding entities to a group
Public classGroupLogRecordJson
A record used when exporting group logs
Public classGroupRequestJson
Group request when filtering reports
Public classGroupsLogByIdsJson
Used when exporting groups logs
Public classGroupsLogByRoomsJson
Used when exporting groups logs
Public classGuidJson
A simple GUID
Public classHideNotificationJson
Public classHighlightDocumentAnnotationJson
Public classHistoryPeriodJson
Time period used when exporting history logs
Public classIManageDocumentInfoJson
Used for getting file information
Public classIManageDocumentInviteJson
Invite data for a document
Public classIManageDocumentJson
Details for a file in a IManage workspace
Public classIManageDocumentPermissionRequestsResultsJson
Result from a permission request for a document in a imanage workspace
Public classIManageDocumentsTransactionResultJson
Result from copying files to Sent items
Public classIManageFolderInfoResultJson
Result from getting a single folder level
Public classIManageFolderJson
IManage folder info
Public classIManageInitiateConversionJson
Used to initiate a conversion to PDF for a document
Public classIManageInviteJson
Invite to imanage workspace or folder
Public classIManageMatterInfoJson
The imanage matter info for creating imanage workspace locally
Public classIManageMatterJson
Details of iManage matter/folder
Public classIManageMoveJson
Used for moving folders or files
Public classIManageWorkspaceInfoJson
IManage Workspace Info
Public classIManageWorkspacePermissionRequestsResultsJson
Result from a pending transient workspace permission request
Public classInitialSyncRoomDataJson
Used when applying a decision to a request
Public classInitialSyncStatusJson
Status of an initial sync
Public classInlineTextDocumentAnnotationJson
Public classInviteJson
Used to invite groups to a workspace
Public classInviteTextJson
Information about the invite email
Public classIsActiveDirectoryConfiguredResultJson
Result from determining if Active Directory is enabled
Public classIsActiveDirectorySettingsEnabledJson
Used when finding out if Active Directory is enabled
Public classIsEmailProtectorEnabledJson
Result from determining if the email protector is enabled
Public classItemErrorInfoJson
A problematic item found during different processes
Public classItemListJsonT
A generic list of JSON items.
Public classItemWithErrorJson
Public classKMSRegionJson
Public classLastDocsWithActivityJson
Public classLastDocWithActivityJson
Public classLastResolvedDocumentPermissionRequestResultJson
Member of a list of last resolved permission requests on files in rooms and in exchange
Public classLastResolvedFolderPermissionRequestResultJson
Member of a list of last resolved permission requests on folder
Public classLastResolvedIManageDocumentPermissionRequestResultJson
Public classLastResolvedIManageFolderPermissionRequestResultJson
Public classLastResolvedTransientDocumentPermissionRequestResultJson
Public classLastResolvedTransientFolderPermissionRequestResultJson
Public classLineDocumentAnnotationJson
Public classListActiveDirectoryGroupsJson
Details about how to get a list of Active Directory groups
Public classListActiveDirectoryGroupsSuggestionsJson
A list of suggestions used when searching for Active Directory groups
Public classListAllFavoriteItemsJson
Public classListAllNotificationsJson
Created by tdagan on 3/21/2017.
Public classListBulkFolderPermissionsJson
Used when getting the aggregation of permissions of folders
Public classListDistributionListsByNameJson
Used when getting a list of members of a named distribution list
Public classListDistributionlistsJson
Information about returning a list of all distribution lists for an organization.
Public classListDocumentCommentsJson
Public classListDocumentsPermissionRequestsJson
Used when listing existing permission requests for a file
Public classListDocumentsVdrJson
Details of how to obtain a list of files
Public classListDomainsJson
Details of how to obtain a list of domains
Public classListEmailProtectorWhitelistEntitiesResultJson
Results from listing all user and domain entities within the Email protector whitelist
Public classListEmailProtectorWhitelistEntityResultJson
An entity result from listing all user and domain entities within the Email protector whitelist
Public classListExchangesRecycleBinDocumentsJson
Used when listing hidden files in the Inbox and items in the Sent items Recycle bin.
Public classListExistingActiveDirectoryGroupsSuggestionsJson
Details about using suggestions when searching for Acive Directory groups
Public classListExternalConnectorsJson
Public classListExternalConnectorsResultJson
Result json for the ListExternalConnectors API
Public classListFavoriteItemsJson
Public classListFolderDefaultPermissionsJson
Details for listing permissions for each of the default entities in given folder
Public classListFolderPermissionRequestsJson
Used when listing existing permissions requests for folder or the entire workspace in case the root folder is supplied
Public classListIdpSettingsJson
Currently not used
Public classListIdpSettingsResultItemJson
Single result from listing IDP settings for organization
Public classListIdpSettingsResultItemMultiMemberJson
Multi result from listing IDP settings for organization
Public classListIManageFoldersAndDocumentsJson
Information for retrieving a list of iManage files and folders for a workspace or a folder.
Public classListIManageFoldersJson
Used to get the tree of all folders
Public classListIManageFoldersSingleLevelResultJson
Single level of tree folders
Public classListIManageMattersJson
Used when retrieving a list of imanage matters
Public classListIManagePermissionDetailsJson
Request for listing permission details for files and folders for all entities in the workspace
Public classListInternalDomainsForOrganizationRequestJson
Used when requesting organization's internal domains
Public classListInternalDomainsForOrganizationResponseJson
Response for requesting organization's internal domains
Public classListLastResolvedFolderPermissionRequestsJson
Details for listing last resolved permission requests on folder
Public classListLastResolvedTransientDocumentPermissionRequestsJson
Public classListLastResolvedTransientFolderPermissionRequestsJson
Public classListLibrariesInputJson
Libraries to list
Public classListLibrariesOutputJson
Public classListNotificationsJson
Detals about how to list a user's notifications
Public classListOrganizationBlacklistingJson
Details for listing an organization's blacklist entries
Public classListOrganizationBlacklistingResultJson
Results from listing an organization's blacklist entries
Public classListOrganizationPolicyJson
Organization ID for listing policies
Public classListOrganizationSystemAccountsIdpJson
Used when listing organization system accounts
Public classListOrganizationWatermarksJson
Collection of watermark positions
Public classListPendingNumberPermissionRequestsJson
Details about how to list the number of pending existing file permission requests and workspace permission requests for an admin
Public classListPendingNumberPermissionRequestsResultJson
Result from listing the number of pending existing file permission requests and workspace permission requests for an admin
Public classListPermissionDetailsJson
Details for listing permission details for files and folders in bulk for all entities in the workspace
Public classListPermittedUsersToTransientWorkspaceJson
Public classListRoomEntitiesJson
Details about how to list the workspace entities
Public classListRoomsByTypeJson
Result from a permission request for a document in a transient workspace
Public classListRoomsByTypeResultJson
Workspace information
Public classListSitesInputJson
Input when listing sites
Public classListSitesOutputJson
Public classListStarredTransientDocumentsJson
List of starred files in transient workspace
Public classListSummaryEmbeddedNotificationJson
Public classListSystemAccountItemJson
Details about a single system account
Public classListTagsJson
A list of tags
Public classListTagTreeJson
A tree of tag lists
Public classListTransientDocumentCommentsJson
Public classListTransientDocumentsPermissionRequestsJson
Used when listing existing permission requests for a file
Public classListTransientFolderPermissionRequestsJson
Used when listing pending permission requests for folder in transient workspaces
Public classListTransientFoldersAndDocumentsJson
Used when retrieving a list of transient files and folders.
Public classListTransientFoldersJson
Used to get the tree of all folders
Public classListTransientFoldersSingleLevelResultJson
Single level of tree folders
Public classListTransientOrganizationPolicyJson
Used to get the organizational policy
Public classListTransientPermissionDetailsJson
Request for listing permission details for files and folders for all entities in the workspace
Public classListUserMentionInCommentsJson
Public classListUserMentionInUnreadDocumentCommentsJson
Public classListUserWorkspaceNotificationsSettingsJson
Public classListVersionsReadConfirmationJson
Public classListVersionsReadConfirmationRetJson
Public classListWorkspaceGroupMembershipsForUserRequestJson
Used to list the groups a user is a member of
Public classListWorkspaceRecycleBinDocumentsJson
Used to list files in the workspace recycle bin. The recycle bin holds non-permanently deleted files.
Public classListWorkspaceRecycleBinWorkspacesJson
Used to list files in the workspaces recycle bin. The recycle bin holds non-permanently deleted workspaces
Public classLoadToCacheJson
Details of what to load into the cache
Public classLockDocumentsRequestJson
Request to lock files
Public classMarkDocumentCommentsJson
Public classMarkDocumentsSelectionJson
Mark a set of files
Public classMarkDocumentsSelectionSdsJson
Files selected for marking
Public classMarkDocumentsSelectionVdrJson
Files selected for marking
Public classMarkEmbeddedNotificationJson
Created by tdagan on 3/27/2017.
Public classMarkIManageWorkspaceStarredJson
Set of workspaces to be marked as starred or unstarred(favorite)
Public classMarkItemsStarredJson
Mark a set of items
Public classMarkNotificationJson
Mark details
Public classMarkupDocumentAnnotationJson
Public classMarkupLocationJson
Public classMembersJson
A membership list
Public classModifyGroupWithGroupJson
Information for modifying a group
Public classMoveAllJson
Move all files to another folder
Public classMoveFolderIntoFolderJson
Used when moving a folder to another folder
Public classMoveFolderJson
Used when moving a folder
Public classMoveJson
Used when moving files
Public classNewSessionJson
Details of a new session that was created
Public classNoReplyEmailRequestJson
No reply email empty request
Public classNoReplyEmailResponseJson
No reply email
Public classNotificationJson
Used for listing a user's notifications
Public classOidcPublicKeyResultJson
Public classOnDemandRequestJson
Request for various demands
Public classOpenForAllRoomEditJson
Used for setting a workspace to be open to all entities
Public classOrgAdminsUserEmailsJson
Public classOrganizationActiveBYOKJson
Public classOrganizationConversionPolicyJson
An orgainzation conversion policy
Public classOrganizationCustomizationJson
Details about organization customization
Public classOrganizationExchangePolicyJson
Organization file share policy
Public classOrganizationPolicyJson
An organizational policy
Public classOrganizationProtectAnywherePolicyJson
An organizational protect anywhere policy
Public classOrganizationRoleLogRecordJson
A single log record about organization roles
Public classOrganizationStoragePolicyJson
Used for editing on organizational storage policy
Public classOrganizationStoragePolicyResponseJson
Response from getting an organizational storage policy
Public classOrganizationSubdomainCustomizationJson
Information about subdomain customization
Public classOrganizationSyncPolicyJson
Organization sync policy details
Public classOrganizationWatermarkConfigJson
Public classOrganizationWatermarkContentJson
Public classOrganizationWorkspacesPolicyJson
An organization workspace plicy
Public classOrgLicenseExpirationTimeRequestJson
Created by sbenhayun on 8/3/2017.
Public classOrgLicenseExpirationTimeResponseJson
Created by sbenhayun on 8/3/2017.
Public classPaginationJson
Pagination details
Public classPagingItemListJsonT
A PagingItemListJson object represents a page or subset of a larger set of Json objects. The object contains the offset that the wrapped ItemListJson object represents within the larger set.
Public classPathAndExternalIdJson
A path and external ID
Public classPathOrFolderIdJson
A path or ID for a folder
Public classPermissionDetailsJson
List of permission details
Public classPermissionFromUserJson
A permission from a user
Public classPermissionRequestUserAndTypeJson
User and type infomation for a permission request
Public classPermissionSetJson
Various permissions
Public classPermissionsTemplateForFolderRequestJson
Request for a folder permission template
Public classPermissionsTemplateRequestJson
Request for a permissions template
Public classPermissionsToUserForGetPermissionsJson
Permission to a user for getting permissions
Public classPermissionsToUserJson
Permissions to a user
Public classPermissionTemplatePayloadJson
Permission template payload
Public classPermittedEntityFromUserJson
A permitted entity from a user
Public classPermittedEntityToUserJson
Permitted entity to user
Public classPermittedEntityWithPermissionsFromUserJson
Permitted entity with permissions from a user
Public classPersonalRoomJson
Personal workspace ("My workspace")
Public classProtectorDownloadTypeResultJson
Result from getting info about a protector download type
Public classPublicKeyJson
Request for authentication details.
Public classRecentSharedWithMeJson
Public classRecycleBinDocumentJson
A recycle bin file
Public classRemoveDocumentsTagValuesJson
List of files to remove tags from
Public classRemoveEmailProtectorWhitelistEntitiesJson
Used when removing user and domain entities from the email protector whitelist.
Public classRemoveMembersFromGroupJson
Json representation of a list of members to remove from a group
Public classRemoveOrganizationBlacklistingJson
List of entities to remove from the organization denied blacklist.
Public classRemoveUsersJson
Users to remove from an organization
Public classRenameDistributionListJson
New name for a distribution list
Public classRenameFolderJson
Used when renaming a folder
Public classRenameIManageDocumentJson
Information about the file to rename
Public classRenameIManageFolderJson
Information about the folder to rename
Public classRenameIManageFolderResultJson
Result from renaming transient folder
Public classRenameTransientDocumentJson
A file to rename
Public classRenameTransientFolderJson
A folder to rename
Public classRenameTransientFolderResultJson
Result from renaming transient folder
Public classReportFilterJson
A report filter
Public classResolveActionForDocumentPermissionRequestJson
Request to resolve an action on a file
Public classResolveActionForFolderPermissionRequestJson
Request to resolve and action on a folder
Public classResolveActionForIManageDocumentPermissionRequestJson
Request to resolve and action on a file
Public classResolveActionForIManageFolderPermissionRequestJson
Request to resolve and action on an imanage workspace
Public classResolveActionForTransientDocumentPermissionRequestJson
Request to resolve and action on a file
Public classResolveActionForTransientFolderPermissionRequestJson
Request to resolve and action on a file
Public classRestoreExchangesRecycleBinDocumentsJson
Files to restore from the Sent items recycle bin to the original folders.
Public classRestoreWorkspacesRecycleBinDocumentJson
Files to restore from the Sent items recycle bin to the original folders.
Public classRestoreWorkspacesRecycleBinWorkspacesJson
Workspaces to restore from the recycle bin
Public classRollbackToSnapshotJson
Public classRollbackToSnapshotRetJson
Public classRoomEmailDataJson
List workspace files
Public classRoomEntityJson
A workspace
Public classRoomExplicitJson
Used when marking a workspace explicit
Public classRoomExternalDataJson
Items associated with a workspace
Public classRoomExternalRepositoryDataJson
Information about an external repository
Public classRoomJson
A workspace
Public classRoomLinksJson
Used when getting a URL for a workspace
Public classRoomListJson
List of workspaces
Public classRoomRecipientsJson
List workspace members
Public classRoomsReportRequestByMailJson
Request for a workspace report
Public classSaveTransientWorkspaceCredentialsJson
Saves credentials for a transient workspace
Public classSdsAddPermissionsJson
Information for adding SDS permissions
Public classSdsAddRecipientsJson
Information for adding recipients to files
Public classSdsEditPermissionsJson
Used when editing file permissions in Sent items
Public classSdsGetRecipientsJson
File to list recipients of
Public classSdsRevokePermissionsJson
Used when revoking all permissions for entities (users, groups, lists) for files in the Sent items.
Public classSearchDocumentsSdsJson
Used when searching a file for a string
Public classSearchDocumentsVdrJson
Used when searching files for a string
Public classSearchFilterJson
Public classSearchRequestJson
Public classSendEmailBulkJson
Used when sending bulk email notifications for a list of files to all permitted entities (users, groups etc) for each file
Public classSendEmailJson
Used when sending an email
Public classSendEmailsToIManageDocumentsJson
Used when sending emails
Public classSendEmailsToTransientDocumentsJson
Used when sending emails
Public classSendNotificationsJson
Public classSendSupportEmailJson
Public classSetClassificationJson
Used to set the classification on a file
Public classSharedWithMeJson
Public classSharedWithMeResponseJson
Public classSharepointRoomJson
SharePoint workspace
Public classShareTransientDocumentAnnotationJson
Public classSignInIManageResultJson
SignIn IManage
Public classSimpleNaturalIntegerJson
this json allows us to differentiate between the following case when supplying integer values for updating in the DB 1. the field is not being sent in the json ( a null value will occur when using the SimpleIntegerJson as member in another json)- signifies not to touch the current value 2. the field appears as an empty json (just the internal value of SimpleIntegerJson will be null, but the member will not) - signifies reset to null
Public classSquareDocumentAnnotationJson
Public classStarredTransientDocumentsJson
Starred files in transient workspaces
Public classStatusJson
A command status
Public classStrikeoutDocumentAnnotationJson
Public classSubmitDocumentResultJson
Result from submitting a file
Public classSubmitDocumentSdsJson
These parameters are needed when submitting files in SDS mode (not to a workspace).
Public classSubmitDocumentsVdrJson
Used when submitting files
Public classSubmitDocumentVdrJson
Public classSubmitIfNewIManageDocumentJson
Public classSubmitIfNewJson
Public classSubmitIfNewTransientDocumentJson
Public classSubmitIManageDocumentResultJson
Public classSubmitIManageDocumentVdrJson
Public classSubmitIManageVersionVdrJson
Public classSubmitTransientDocumentResultJson
Public classSubmitTransientDocumentVdrJson
Public classSubmitTransientVersionVdrJson
Public classSummaryEmbeddedNotificationJson
Public classSystemPropertiesJson
Various system properties
Public classTagDateValueAddJson
A tag date value
Public classTagDateValueRemoveJson
Used when removing values
Public classTagFieldJson
A tag
Public classTagListJson
A collection of tags
Public classTagListRemoveJson
Used when removing tags
Public classTagNumericValueAddJson
A tag numeric value
Public classTagNumericValueRemoveJson
Used when removing values
Public classTagRecordJson
Public classTagStringValueAddJson
A tag text value
Public classTagStringValueRemoveJson
Used when removing values
Public classTagTreeJson
A tag tree
Public classTextCommentDocumentAnnotationJson
Public classTextMarkupDocumentAnnotationJson
Public classTextualDocumentAnnotationJson
Public classTimeEstimationJson
Estimated seconds left
Public classTotalEmbeddedNotificationsRequestJson
Public classTotalEmbeddedNotificationsResponseJson
Public classTransactionInputJson
Used when getting a file transaction status
Public classTransactionStatusJson
File transaction status
Public classTransientDocumentAndUsersJson
Public classTransientDocumentCommentCountJson
Public classTransientDocumentInfoJson
Used for getting file information
Public classTransientDocumentInviteJson
Public classTransientDocumentJson
Details for a file in a transient workspace
Public classTransientDocumentPendingPermissionRequestJson
A pending request for a file permission in a transient workspace
Public classTransientDocumentPermissionRequestsResultsJson
Result from a permission request for a document in a transient workspace
Public classTransientDocumentsTransactionResultJson
Result from copying files to Sent items
Public classTransientEditFoldersAndDocumentsSettingsBulkJson
Used when bulk editing file settings
Public classTransientFolderInfoResultJson
Result from getting a single folder level
Public classTransientFolderJson
Details of a transient folder
Public classTransientFolderPendingPermissionRequestJson
A request for permissions on an existing folder
Public classTransientFolderPermissionRequestsResultsJson
Result from a pending transient workspace permission request
Public classTransientInitiateConversionJson
Used to initiate a conversion
Public classTransientInitiateConversionResultJson
Result from initiating a conversion
Public classTransientInviteJson
Invite
Public classTransientListUserMentionInUnreadDocumentCommentsJson
Public classTransientMoveJson
Used for moving folders or files
Public classTransientPathInfoJson
Public classTransientWorkspaceExternalDataJson
Workspace external data
Public classTransientWorkspaceInfoJson
Transient Workspace Info
Public classTransientWorkspaceJson
A transient worksapce
Public classUnauthDocumentInfoJson
Details used when opening a file
Public classUnauthDocumentJson
File details
Public classUnderlineDocumentAnnotationJson
Public classUnlockDocumentsRequestJson
Request to unlock a file
Public classUnregisterUserForPushNotificationJson
Created by sbenhayun on 3/8/2017.
Public classUnStarredTransientDocumentsJson
Files in transient workspaces that are not starred.
Public classUpdateCommentJson
Public classUpdateDocumentJson
Used when updating a file
Public classUpdateTransientCommentJson
Public classUploadUserTransientDocumentAnnotationsJson
Public classUrlJson
URL Json contains a URL
Public classUserAbilitiesJson
Details about a user's abilities
Public classUserAuthenticationLoggingInitialDateResponseJson
Public classUserDataJson
Details about a user
Public classUserDetailsJson
User details
Public classUserDeviceNotificationTypeSettingsJson
Public classUserDirectMembershipResolveDataJson
Data used for resolving user direct membership
Public classUserJson
A user
Public classUserReportJson
Public classUserRoleJson
A user role
Public classUsersForPasswordResetJson
Users who need a password reset
Public classUsersJson
User list
Public classUsersReportRequestJson
Public classUserWorkspaceNotificationsSettingsJson
Public classValidateCreateFolderJson
Used to validate params when creating a folder
Public classValidateDownloadDocumentsSelectionSdsJson
Used when validating files for download
Public classValidateDownloadDocumentsSelectionVdrJson
Used when validating files for download
Public classValidateDownloadDocumentVersionInVdrsJson
Used when validating files for download
Public classValidateDownloadIManageDocumentsJson
Used for validating a file for download
Public classValidateDownloadSentItemsDocumentsWithRecycleBinJson
Used when validating sent items download of a user with it's recycle bin.
Public classValidateDownloadTransientDocumentsAnnotationsJson
Public classValidateDownloadTransientDocumentsJson
Used for validating a file for download
Public classValidateDownloadUserTransientDocumentAnnotationsInDocJson
Public classValidateDownloadWorkspaceDocumentsWithRecycleBinJson
Used when validating files to download from a recycle bin.
Public classValidateKCDWorkspaceCredentialsJson
Validates credentials for a kcd transient workspace
Public classValidateSAMLIdPMetadataJson
Public classValidateUsersNotAdminsInWorkspacesRequestJson
Used when validating non-admin users in a workspace
Public classValidateUsersNotAdminsInWorkspacesResponseJson
Response to validating non-admin users in a workspace
Public classValidIManagePathInfoJson
Request for getting documents info
Public classValidPathInfoJson
Public classVdrAddPermissionsJson
Add permissions to an entity
Public classVdrEditPermissionsJson
Used when editing permissions for a list of files for a list of entities
Public classVdrRevokePermissionJson
Used when revoking permissions
Public classVerifyActiveDirectorySettingsJson
An a Active Directory setting to be verified
Public classViewerWatermarkJson
A viewer watermark
Public classWopiProofKeyJson
Public classWorkspaceGroupMembershipForUserInfoJson
Public classWorkspaceInfoJson
Workspace information
Public classWorkspaceProtectorSettingsJson
Used when setting a protector