Class TransientWorkspaces


  • public class TransientWorkspaces
    extends Object
    Functions for secure virtual data transient workspace handling.
    • Method Detail

      • DownloadCommentsV30

        public InputStream DownloadCommentsV30​(DownloadTransientCommentsJson downloadTransientCommentsJson)
        Download a pdf contains all the comments of the given document
        Parameters:
        downloadTransientCommentsJson -
        Returns:
        a pdf
      • addEntitiesV30

        public BulkOperationResultJson addEntitiesV30​(AddEntitiesTransientJson addEntitiesTransientJson)
        Adds permitted entities to workspace with no permissions outside of the given folder.
        Parameters:
        addEntitiesTransientJson - information used when adding permitted entities to workspace with no permissions outside of the given folder
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • addNotificationV30

        public BulkOperationResultJson addNotificationV30​(CreateTransientActivityLogRecordJson createTransientActivityLogRecordJson)
        Adds a notification for a file action in the file's activity log file.
        Parameters:
        createTransientActivityLogRecordJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • addTransientDocumentPermissionRequestV30

        public BulkOperationResultJson addTransientDocumentPermissionRequestV30​(AddTransientDocumentPermissionRequestJson addTransientDocumentPermissionRequestJson)
        Add a permission request for a document in a transient workspace
        Parameters:
        addTransientDocumentPermissionRequestJson - data about the request for adding a file permission
        Returns:
        - details about the success of each request, for each entity and document
      • addTransientFolderPermissionRequestV30

        public BulkOperationResultJson addTransientFolderPermissionRequestV30​(AddTransientFolderPermissionRequestJson addTransientFolderPermissionRequestJson)
        Add a permission request for a folder in a transient workspace
        Parameters:
        addTransientFolderPermissionRequestJson - data about the request for adding a folder permission
        Returns:
        - details about the success of each request, for each entity and document
      • cancelUploadDocumentByPostV30

        public String cancelUploadDocumentByPostV30​(String documentGuid,
                                                    String roomId,
                                                    String documentName,
                                                    String fileName)
        Cancels an upload
        Parameters:
        deviceType - device type
        documentGuid - document guid
        documentName - document name
        fileName - file name
        roomId - room id
        Returns:
        "success"
      • changeDefaultPermissionsBulkV30

        public BulkOperationResultJson changeDefaultPermissionsBulkV30​(ChangeEntitiesTransientJson changeEntitiesTransientJson)
        Changes default permissions of a permitted entity in a transient workspace.
        Parameters:
        changeEntitiesTransientJson - details of entities (user, group, domain) and new default permissions to be assigned to them since expiration date is now not a part of the inheritance model, the user may send 'leave unchanged' so that the expiration date will not change when changing permissions. The user can do so by passing expiration date = null, expiration days = null and neverExpires = true.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • checkForBoxAccessTokenV30

        public CheckBoxAccessTokenResultJson checkForBoxAccessTokenV30​(ExternalRepositoryGuidJson externalRepositoryGuidJson)
        Check if the logged in user has a Box access token stored.
        Parameters:
        ExternalRepositoryGuidJson - the Box repository to be checked
        Returns:
        CheckBoxAccessTokenResultJson true if a Box token exists for current user.
      • checkForCredentialV30

        public CheckDropboxAccessTokenResultJson checkForCredentialV30​(GetDropboxWorkspaceJson getDropboxWorkspaceJson)
        Check if the logged in user has a valid Dropbox access token stored.
        Parameters:
        GetDropboxWorkspaceJson - the Dropbox repository to be checked
        Returns:
        CheckDropboxAccessTokenResultJson true if a valid Dropbox access token exists
      • copyDocumentsFromRoomsToExchangeAsyncV30

        public TransientDocumentsTransactionResultJson copyDocumentsFromRoomsToExchangeAsyncV30​(CopyTransientDocumentToExchangeAsyncJson copyTransientDocumentToExchangeAsyncJson)
        Copies a transient file to Microsoft Exchange.
        Parameters:
        copyTransientDocumentToExchangeAsyncJson - A list of users to receive notification and link to the files and permissions to assign the file when copying transient files to Exchange
        Returns:
        transientDocumentsTransactionResultJson
      • createDropboxWorkspaceV30

        public TransientWorkspaceJson createDropboxWorkspaceV30​(CreateDropboxWorkspaceJson createDropboxWorkspaceJson)
        Creates a new transient workspace for Dropbox.
        Parameters:
        createTransientWorkspaceJson - a new transient workspace to create
        Returns:
        transientWorkspaceJson
      • createFolderV30

        public TransientFolderJson createFolderV30​(CreateTransientFolderJson createTransientFolderJson)
        Creates a new transient folder.
        Parameters:
        createTransientFolderJson - a transient folder to create
        Returns:
        transientFolderJson
      • createNewTransientDocumentV30

        public SubmitIfNewTransientDocumentJson createNewTransientDocumentV30​(CreateNewTransientDocumentJson createNewTransientDocumentJson)
        Create new empty document
        Parameters:
        createNewTransientDocumentJson - json new document upload and submit
        Returns:
        SubmitIfNewTransientDocumentJson - return exist or new document
      • createRoomV30

        public TransientWorkspaceJson createRoomV30​(CreateTransientWorkspaceJson createTransientWorkspaceJson)
        Creates a new transient workspace.
        Parameters:
        createTransientWorkspaceJson - a new transient workspace to create
        Returns:
        transientWorkspaceJson
      • deleteDocumentsAndFoldersV30

        public BulkOperationResultJson deleteDocumentsAndFoldersV30​(DeleteTransientDocumentsAndFoldersJson deleteTransientDocumentsAndFoldersJson)
        Deletes transient folders and files.
        Parameters:
        deleteTransientDocumentsAndFoldersJson - transient folders and files to delete
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • deleteRoomV30

        public BulkOperationResultJson deleteRoomV30​(DeleteTransientWorkspaceJson deleteTransientWorkspaceJson)
        Delete transient workspace.
        Parameters:
        deleteTransientWorkspaceJson - a transient workspace to delete
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • deleteUserDocumentAnnotationV30

        public BulkOperationResultJson deleteUserDocumentAnnotationV30​(DeleteTransientDocumentAnnotationsJson deleteTransientDocumentAnnotationsJson)
        Delete annotations from transient file.
        Parameters:
        deleteTransientDocumentAnnotationsJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • documentUploadCompleteV30

        public BulkOperationResultJson documentUploadCompleteV30​(String documentGuid,
                                                                 String roomId)
        Complete uploaded file.
        Parameters:
        documentGuid - document guid
        roomId - room id
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • downloadDocumentAnnotationsOriginalV30

        public InputStream downloadDocumentAnnotationsOriginalV30​(String path,
                                                                  String user,
                                                                  String workspaceGuid)
        Returns the annotations for a given file.
        Returns:
        inputStream
      • downloadDocumentsFormV30

        public InputStream downloadDocumentsFormV30​(Set<String> documentPaths,
                                                    String downloadType,
                                                    Set<String> folderPaths,
                                                    String wdUniqueDownloadKey,
                                                    String workspaceUuid)
        Downloads a set of specified files or all files in a set of specified folders and files in a transient workspace.
      • downloadOriginalV30

        public InputStream downloadOriginalV30​(String workspaceGuid,
                                               String documentPath,
                                               String downloadType,
                                               String forceWatermarks)
        Returns a single file.
        Parameters:
        documentPath - document path
        downloadType - download type
        forceWatermarks - force water marks
        workspaceGuid - workspace guid
        Returns:
        inputStream
      • downloadSingleDocumentForWebV30

        public InputStream downloadSingleDocumentForWebV30​(String documentPath,
                                                           String downloadType,
                                                           boolean forceWatermarks,
                                                           String wdUniqueDownloadKey,
                                                           String workspaceUuid)
        Downloads a single file (for web).
        Returns:
        inputStream
      • downloadSingleDocumentForWebV30

        public InputStream downloadSingleDocumentForWebV30​(DownloadSingleTransientDocumentForWebJson downloadSingleTransientDocumentForWebJson)
        Downloads a single file for web (additional info is returned).
        Parameters:
        downloadSingleTransientDocumentForWebJson -
        Returns:
        inputStream
      • downloadSingleDocumentV30

        public InputStream downloadSingleDocumentV30​(DownloadSingleTransientDocumentJson downloadSingleTransientDocumentJson)
        Downloads a single file.
        Parameters:
        downloadSingleTransientDocumentJson -
        Returns:
        inputStream
      • downloadUserDocumentAnnotationsInDocFormForWebV30

        public InputStream downloadUserDocumentAnnotationsInDocFormForWebV30​(String path,
                                                                             String userAddress,
                                                                             String wdUniqueDownloadKey,
                                                                             String workspaceGuid)
        Returns the annotations for a user file in PDF format.
        Returns:
        inputStream
      • downloadUserDocumentAnnotationsInDocFromV30

        public InputStream downloadUserDocumentAnnotationsInDocFromV30​(String path,
                                                                       Set<String> userAddresses,
                                                                       String wdUniqueDownloadKey,
                                                                       String workspaceGuid)
        Downloads document annotations in zip format.
      • downloadUserDocumentAnnotationsInDocMultipleFromV30

        public InputStream downloadUserDocumentAnnotationsInDocMultipleFromV30​(String path,
                                                                               Set<String> userAddresses,
                                                                               String wdUniqueDownloadKey,
                                                                               String workspaceGuid)
        Downloads annotations for file in a user's workspace.
        Returns:
        inputStream
      • editFoldersAndDocumentsSettingsBulkV30

        public BulkOperationResultJson editFoldersAndDocumentsSettingsBulkV30​(TransientEditFoldersAndDocumentsSettingsBulkJson transientEditFoldersAndDocumentsSettingsBulkJson)
        Edit folder and file permissions in bulk.
        Parameters:
        transientEditFoldersAndDocumentsSettingsBulkJson - used when bulk editing file settings
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • exportActivityHistoryForRoomsV30

        public InputStream exportActivityHistoryForRoomsV30​(ExportActivityHistoryForTransientRoomsJson exportActivityHistoryForTransientRoomsJson)
        Returns a CSV file of workspace activity history for the given set of rooms.
        Parameters:
        exportActivityHistoryForTransientRoomsJson -
      • exportSpecificUsersActivityHistoryByMailV30

        public BulkOperationResultJson exportSpecificUsersActivityHistoryByMailV30​(ExportSpecificUsersTransientActivityHistoryByMailJson exportSpecificUsersTransientActivityHistoryByMailJson)
        Exports a selected Activity history for a list of users in current user's organization to a CSV file as an attachment to an email.
        Parameters:
        exportSpecificUsersTransientActivityHistoryByMailJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • exportUsersActivityHistoryV30

        public InputStream exportUsersActivityHistoryV30​(ExportUsersTransientActivityHistoryJson exportUsersTransientActivityHistoryJson)
        Exports activity history for a list of users in current user's organization to a CSV file.
        Parameters:
        exportUsersTransientActivityHistoryJson - list of users and start/end dates filter for activity history
      • generateGuidV30

        public GuidJson generateGuidV30()
        Creates file GUID for new or updated files.
        Returns:
        guidJson
      • generateGuidV30

        public GuidJson generateGuidV30​(GenerateTransientDocumentGuidJson generateTransientDocumentGuidJson)
        Creates file GUID for new file in a workspace context.
        Parameters:
        generateTransientDocumentGuidJson - a workspace to get a guid for
        Returns:
        guidJson
      • getActivityLogV30

        public InputStream getActivityLogV30​(String documentPath,
                                             String fromDate,
                                             boolean lastActionPerUser,
                                             Integer pageNumber,
                                             Integer pageSize,
                                             String toDate,
                                             String workspaceUuid)
        Gets activity log for a file in WD in CSV format.
      • getBoxOAuthParametersV30

        public BoxOAuthParamsJson getBoxOAuthParametersV30()
        Return Box OAuth Parameters.
        Returns:
        BoxOAuthParamsJson
      • getDocumentInfoV30

        public TransientDocumentJson getDocumentInfoV30​(TransientDocumentInfoJson transientDocumentInfoJson)
        Retrieves file info.
        Parameters:
        transientDocumentInfoJson - used for getting file information
        Returns:
        transientDocumentJson
      • getDropboxOAuthParametersV30

        public DropboxOAuthParamsJson getDropboxOAuthParametersV30​(GetDropboxWorkspaceJson getDropboxWorkspaceJson)
        Return Dropbox OAuth Parameters.
        Parameters:
        GetDropboxWorkspaceJson -
        Returns:
        DropboxOAuthParamsJson
      • getPathInfoV30

        public TransientPathInfoJson getPathInfoV30​(GetPathInfoJson getPathInfoJson)
        Get info for a path.
        Parameters:
        getPathInfoJson -
        Returns:
        transientPathInfoJson
      • inviteV30

        public BulkOperationResultJson inviteV30​(TransientInviteJson transientInviteJson)
        Invite groups to a workspace.
        Parameters:
        transientInviteJson - invite data
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • inviteV30

        public BulkOperationResultJson inviteV30​(TransientDocumentInviteJson transientDocumentInviteJson)
        Invites groups to a specific file in a workspace.
        Parameters:
        transientDocumentInviteJson - invite data
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • listFoldersAndDocumentsV30

        public PagingItemListJson<BaseJson> listFoldersAndDocumentsV30​(ListTransientFoldersAndDocumentsJson listTransientFoldersAndDocumentsJson)
        Retrieves a list of transient files and folders.
        Parameters:
        listTransientFoldersAndDocumentsJson - used when retrieving a list of transient files and folders
        Returns:
        A of Json objects which main include TransientFolderJson and/or TransientDocumentJson objects.
      • listOrganizationPolicyV30

        public OrganizationPolicyJson listOrganizationPolicyV30​(ListTransientOrganizationPolicyJson listTransientOrganizationPolicyJson)
        Returns the organization policy for the given workspace.
        Parameters:
        listTransientOrganizationPolicyJson - used to get the organizational policy
        Returns:
        organizationPolicyJson
      • listPermissionDetailsV30

        public PermissionDetailsJson listPermissionDetailsV30​(ListTransientPermissionDetailsJson listTransientPermissionDetailsJson)
        List permission details for files and folders for all entities in the workspace.
        Parameters:
        listTransientPermissionDetailsJson - request for listing permission details for files and folders for all entities in the workspace
        Returns:
        permissionDetailsJson
      • listTransientDocumentsPermissionRequestsV30

        public ItemListJson<TransientDocumentPermissionRequestsResultsJson> listTransientDocumentsPermissionRequestsV30​(ListTransientDocumentsPermissionRequestsJson listTransientDocumentsPermissionRequestsJson)
        Lists existing permission requests for a document in a transient workspace.
        Parameters:
        listTransientDocumentsPermissionRequestsJson - Details about the document to get info on
        Returns:
        List which indicates whether all requests were successful or, if not, a list of errors.
      • listTransientFolderPermissionRequestsV30

        public ItemListJson<TransientFolderPermissionRequestsResultsJson> listTransientFolderPermissionRequestsV30​(ListTransientFolderPermissionRequestsJson listTransientFolderPermissionRequestsJson)
        Lists existing permission requests for a folder in a transient workspace.
        Parameters:
        listTransientFolderPermissionRequestsJson - Details about the document to get info on
        Returns:
        List which indicates whether all requests were successful or, if not, a list of errors.
      • listUnreadCommentsUserMentionPerDocumentV30

        public ItemListJson<DocumentCommentJson> listUnreadCommentsUserMentionPerDocumentV30​(TransientListUserMentionInUnreadDocumentCommentsJson transientListUserMentionInUnreadDocumentCommentsJson)
        List of unread comments of a certain document that user was mention in
        Parameters:
        transientListUserMentionInUnreadDocumentCommentsJson -
        Returns:
        list of DocumentCommentJson
      • moveV30

        public BulkOperationResultJson moveV30​(TransientMoveJson transientMoveJson)
        Moves folders and files.
        Parameters:
        transientMoveJson - used for moving folders or files
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • renameDocumentV30

        public TransientDocumentJson renameDocumentV30​(RenameTransientDocumentJson renameTransientDocumentJson)
        Renames a file in a transient workspace.
        Parameters:
        renameTransientDocumentJson - a file to rename
        Returns:
        transientDocumentJson
      • resolveActionForTransientDocumentPermissionRequestV30

        public BulkOperationResultJson resolveActionForTransientDocumentPermissionRequestV30​(ResolveActionForTransientDocumentPermissionRequestJson resolveActionForTransientDocumentPermissionRequestJson)
        Applies a decision on a request.
        Parameters:
        resolveActionForTransientDocumentPermissionRequestJson - document and requesters informtaion
        Returns:
        An object which indicates if the action was successful or, if not, the problems.
      • resolveActionForTransientFolderPermissionRequestV30

        public BulkOperationResultJson resolveActionForTransientFolderPermissionRequestV30​(ResolveActionForTransientFolderPermissionRequestJson resolveActionForTransientFolderPermissionRequestJson)
        Applies a decision on a request.
        Parameters:
        resolveActionForTransientFolderPermissionRequestJson - document and requesters informtaion
        Returns:
        An object which indicates if the action was successful or, if not, the problems.
      • saveTransientWorkspaceCredentialsV30

        public TransientFolderJson saveTransientWorkspaceCredentialsV30​(SaveTransientWorkspaceCredentialsJson saveTransientWorkspaceCredentialsJson)
        Saves the credentials for a given workspace.
        Parameters:
        saveTransientWorkspaceCredentialsJson - saves credentials for a transient workspace
        Returns:
        transientFolderJson
      • sendBulkEmailV30

        public String sendBulkEmailV30​(SendEmailsToTransientDocumentsJson sendEmailsToTransientDocumentsJson)
        Sends emails to file users.
        Parameters:
        sendEmailsToTransientDocumentsJson - used when sending emails
        Returns:
        "success"
      • setupBoxAuthTokenV30

        public TransientWorkspaceJson setupBoxAuthTokenV30​(SetupBoxTokenJson setupBoxTokenJson)
        Update existing Box workspace token info(re-authenticate) or create a new Box workspace with the Box token info(sign-in)
        Parameters:
        setupBoxTokenJson - Info for getting Box token
        Returns:
        transientWorkspaceJson the Box workspace info
      • shareUserDocumentAnnotationV30

        public BulkOperationResultJson shareUserDocumentAnnotationV30​(ShareTransientDocumentAnnotationJson shareTransientDocumentAnnotationJson)
        Shares file annotations with the provided users and/or groups.
        Parameters:
        shareTransientDocumentAnnotationJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • signOutBoxWorkspaceV30

        public BulkOperationResultJson signOutBoxWorkspaceV30​(ExternalRepositoryGuidJson externalRepositoryGuidJson)
        Sign out Box repository. It deletes Box workspace owned by the user and deletes the Box token info for the user.
        Parameters:
        ExternalRepositoryGuidJson - external repository GUID for the Box workspace
        Returns:
        BulkOperationResultJson
      • signOutDropboxWorkspaceV30

        public BulkOperationResultJson signOutDropboxWorkspaceV30​(GetDropboxWorkspaceJson getDropboxWorkspaceJson)
        Sign out Dropbox repository. It deletes Dropbox workspace owned by the user and deletes the credential for the user.
        Parameters:
        GetDropboxWorkspaceJson -
        Returns:
        BulkOperationResultJson
      • starDocumentsV30

        public BulkOperationResultJson starDocumentsV30​(StarredTransientDocumentsJson starredTransientDocumentsJson)
        Marks a file with a star.
        Parameters:
        starredTransientDocumentsJson - workspace and document information used when starring documents
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • unstarDocumentsV30

        public BulkOperationResultJson unstarDocumentsV30​(UnStarredTransientDocumentsJson unStarredTransientDocumentsJson)
        Removes a star for a file
        Parameters:
        unStarredTransientDocumentsJson - workspace and document details used when unstarring documents
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • uploadDocumentByPostV30

        public String uploadDocumentByPostV30​(String documentGuid,
                                              String roomId,
                                              File data,
                                              DeviceType deviceType,
                                              String documentName,
                                              String fileName,
                                              Long start)
        Uploads new file data.
        Parameters:
        data - file data
        deviceType - device type
        documentGuid - document guid
        documentName - document name
        fileName - file name
        roomId - room id
        start - start
        Returns:
        "success"
      • uploadDocumentByPostV30

        public String uploadDocumentByPostV30​(String documentGuid,
                                              String roomId,
                                              InputStream data,
                                              DeviceType deviceType,
                                              String documentName,
                                              String fileName,
                                              Long start)
        Uploads new file data.
        Parameters:
        data - file data
        deviceType - device type
        documentGuid - document guid
        documentName - document name
        fileName - file name
        roomId - room id
        start - start
        Returns:
        "success"
      • uploadUserDocumentAnnotationV30

        public BulkOperationResultJson uploadUserDocumentAnnotationV30​(UploadUserTransientDocumentAnnotationsJson uploadUserTransientDocumentAnnotationsJson)
        Uploads annotations for a user file.
        Parameters:
        uploadUserTransientDocumentAnnotationsJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • validateDocumentsToDownloadV30

        public BulkOperationResultJson validateDocumentsToDownloadV30​(ValidateDownloadTransientDocumentsJson validateDownloadTransientDocumentsJson)
        Validates files for download.
        Parameters:
        validateDownloadTransientDocumentsJson - used for validating a file for download
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • validateDownloadUserDocumentAnnotationsInDocV30

        public BulkOperationResultJson validateDownloadUserDocumentAnnotationsInDocV30​(ValidateDownloadUserTransientDocumentAnnotationsInDocJson validateDownloadUserTransientDocumentAnnotationsInDocJson)
        Validates user file annotations for download.
        Parameters:
        validateDownloadTransientDocumentsAnnotationsJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • validateKCDCredentialsV30

        public TransientFolderJson validateKCDCredentialsV30​(ValidateKCDWorkspaceCredentialsJson validateKCDWorkspaceCredentialsJson)
        validate the credentials for a kcd user on a given workspace.
        Parameters:
        validateKCDWorkspaceCredentialsJson - saves credentials for a transient workspace
        Returns:
        transientFolderJson
      • validateZipDownloadUserDocumentAnnotationsInDocV30

        public BulkOperationResultJson validateZipDownloadUserDocumentAnnotationsInDocV30​(ValidateDownloadTransientDocumentsAnnotationsJson validateDownloadTransientDocumentsAnnotationsJson)
        Validates user document annotations for download.
        Parameters:
        validateDownloadTransientDocumentsAnnotationsJson -
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document