Package com.dropbox.core.v2.sharing

Class DbxUserSharingRequests

  • public class DbxUserSharingRequests
extends java.lang.Object
    Routes in namespace "sharing".

    • Constructor Detail

      • DbxUserSharingRequests

        public DbxUserSharingRequests​(DbxRawClientV2 client)

    • Method Detail

      • addFileMember

        public java.util.List<FileMemberActionResult> addFileMember​(java.lang.String file,
                                                            java.util.List<MemberSelector> members)
                                                     throws AddFileMemberErrorException,
                                                            DbxException
        Adds specified members to a file.

        The default values for the optional request parameters will be used. See AddFileMemberBuilder for more details.

        Parameters:
        file - File to which to add members. Must have length of at least 1, match pattern " ((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        members - Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email. Must not contain a null item and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        AddFileMemberErrorException
        DbxException

      • addFileMemberBuilder

        public AddFileMemberBuilder addFileMemberBuilder​(java.lang.String file,
                                                 java.util.List<MemberSelector> members)
        Adds specified members to a file.
        Parameters:
        file - File to which to add members. Must have length of at least 1, match pattern " ((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        members - Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email. Must not contain a null item and not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • addFolderMember

        public void addFolderMember​(java.lang.String sharedFolderId,
                            java.util.List<AddMember> members)
                     throws AddFolderMemberErrorException,
                            DbxException
        Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.

        For the new member to get access to all the functionality for this folder, you will need to call mountFolder(String) on their behalf.

        The default values for the optional request parameters will be used. See AddFolderMemberBuilder for more details.

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        members - The intended list of members to add. Added members will receive invites to join the shared folder. Must not contain a null item and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        AddFolderMemberErrorException
        DbxException

      • addFolderMemberBuilder

        public AddFolderMemberBuilder addFolderMemberBuilder​(java.lang.String sharedFolderId,
                                                     java.util.List<AddMember> members)
        Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member. For the new member to get access to all the functionality for this folder, you will need to call mountFolder(String) on their behalf.
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        members - The intended list of members to add. Added members will receive invites to join the shared folder. Must not contain a null item and not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • checkJobStatus

        public JobStatus checkJobStatus​(java.lang.String asyncJobId)
                         throws PollErrorException,
                                DbxException
        Returns the status of an asynchronous job.
        Parameters:
        asyncJobId - Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        PollErrorException
        DbxException

      • checkRemoveMemberJobStatus

        public RemoveMemberJobStatus checkRemoveMemberJobStatus​(java.lang.String asyncJobId)
                                                 throws PollErrorException,
                                                        DbxException
        Returns the status of an asynchronous job for sharing a folder.
        Parameters:
        asyncJobId - Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        PollErrorException
        DbxException

      • checkShareJobStatus

        public ShareFolderJobStatus checkShareJobStatus​(java.lang.String asyncJobId)
                                         throws PollErrorException,
                                                DbxException
        Returns the status of an asynchronous job for sharing a folder.
        Parameters:
        asyncJobId - Id of the asynchronous job. This is the value of a response returned from the method that launched the job. Must have length of at least 1 and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        PollErrorException
        DbxException

      • createSharedLinkBuilder

        @Deprecated
public CreateSharedLinkBuilder createSharedLinkBuilder​(java.lang.String path)
        Deprecated.
        use createSharedLinkWithSettings(String,SharedLinkSettings) instead.
        Create a shared link. If a shared link already exists for the given path, that link is returned. Previously, it was technically possible to break a shared link by moving or renaming the corresponding file or folder. In the future, this will no longer be the case, so your app shouldn't rely on this behavior. Instead, if your app needs to revoke a shared link, use revokeSharedLink(String).
        Parameters:
        path - The path to share. Must not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • createSharedLinkWithSettings

        public SharedLinkMetadata createSharedLinkWithSettings​(java.lang.String path,
                                                       SharedLinkSettings settings)
                                                throws CreateSharedLinkWithSettingsErrorException,
                                                       DbxException
        Create a shared link with custom settings. If no settings are given then the default visibility is RequestedVisibility.PUBLIC (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).
        Parameters:
        path - The path to be shared by the shared link. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not be null.
        settings - The requested settings for the newly created shared link.
        Returns:
        The metadata of a shared link.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        CreateSharedLinkWithSettingsErrorException
        DbxException

      • getFileMetadata

        public SharedFileMetadata getFileMetadata​(java.lang.String file,
                                          java.util.List<FileAction> actions)
                                   throws GetFileMetadataErrorException,
                                          DbxException
        Returns shared file metadata.
        Parameters:
        file - The file to query. Must have length of at least 1, match pattern "((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        actions - A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.getPermissions() field describing the actions the authenticated user can perform on the file. Must not contain a null item.
        Returns:
        Properties of the shared file.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        GetFileMetadataErrorException
        DbxException

      • getFileMetadataBatch

        public java.util.List<GetFileMetadataBatchResult> getFileMetadataBatch​(java.util.List<java.lang.String> files,
                                                                       java.util.List<FileAction> actions)
                                                                throws SharingUserErrorException,
                                                                       DbxException
        Returns shared file metadata.
        Parameters:
        files - The files to query. Must contain at most 100 items, not contain a null item, and not be null.
        actions - A list of `FileAction`s corresponding to `FilePermission`s that should appear in the response's SharedFileMetadata.getPermissions() field describing the actions the authenticated user can perform on the file. Must not contain a null item.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        SharingUserErrorException
        DbxException

      • getFolderMetadata

        public SharedFolderMetadata getFolderMetadata​(java.lang.String sharedFolderId)
                                       throws SharedFolderAccessErrorException,
                                              DbxException
        Returns shared folder metadata by its folder ID.
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        The metadata which includes basic information about the shared folder.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        SharedFolderAccessErrorException
        DbxException

      • getFolderMetadata

        public SharedFolderMetadata getFolderMetadata​(java.lang.String sharedFolderId,
                                              java.util.List<FolderAction> actions)
                                       throws SharedFolderAccessErrorException,
                                              DbxException
        Returns shared folder metadata by its folder ID.
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        actions - A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.getPermissions() field describing the actions the authenticated user can perform on the folder. Must not contain a null item.
        Returns:
        The metadata which includes basic information about the shared folder.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        SharedFolderAccessErrorException
        DbxException

      • getSharedLinkFileBuilder

        public GetSharedLinkFileBuilder getSharedLinkFileBuilder​(java.lang.String url)
        Download the shared link's file from a user's Dropbox.
        Parameters:
        url - URL of the shared link. Must not be null.
        Returns:
        Downloader builder for configuring the request parameters and instantiating a downloader.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • getSharedLinkMetadataBuilder

        public DbxUserGetSharedLinkMetadataBuilder getSharedLinkMetadataBuilder​(java.lang.String url)
        Get the shared link's metadata.
        Parameters:
        url - URL of the shared link. Must not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • getSharedLinks

        @Deprecated
public GetSharedLinksResult getSharedLinks()
                                    throws GetSharedLinksErrorException,
                                           DbxException
        Deprecated.
        use listSharedLinks(com.dropbox.core.v2.sharing.ListSharedLinksArg) instead.
        Returns a list of LinkMetadata objects for this user, including collection links.

        If no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links.

        If a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.

        Throws:
        GetSharedLinksErrorException
        DbxException

      • getSharedLinks

        @Deprecated
public GetSharedLinksResult getSharedLinks​(java.lang.String path)
                                    throws GetSharedLinksErrorException,
                                           DbxException
        Deprecated.
        use listSharedLinks(com.dropbox.core.v2.sharing.ListSharedLinksArg) instead.
        Returns a list of LinkMetadata objects for this user, including collection links.

        If no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links.

        If a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.

        Parameters:
        path - See getSharedLinks(String) description.
        Throws:
        GetSharedLinksErrorException
        DbxException

      • listFileMembersBuilder

        public ListFileMembersBuilder listFileMembersBuilder​(java.lang.String file)
        Use to obtain the members who have been invited to a file, both inherited and uninherited members.
        Parameters:
        file - The file for which you want to see members. Must have length of at least 1, match pattern " ((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • listFileMembersBatch

        public java.util.List<ListFileMembersBatchResult> listFileMembersBatch​(java.util.List<java.lang.String> files)
                                                                throws SharingUserErrorException,
                                                                       DbxException
        Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.

        Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.

        The limit request parameter will default to 10L (see listFileMembersBatch(List,long)).

        Parameters:
        files - Files for which to return members. Must contain at most 100 items, not contain a null item, and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        SharingUserErrorException
        DbxException

      • listFileMembersBatch

        public java.util.List<ListFileMembersBatchResult> listFileMembersBatch​(java.util.List<java.lang.String> files,
                                                                       long limit)
                                                                throws SharingUserErrorException,
                                                                       DbxException
        Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.

        Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.

        Parameters:
        files - Files for which to return members. Must contain at most 100 items, not contain a null item, and not be null.
        limit - Number of members to return max per query. Defaults to 10 if no limit is specified. Must be less than or equal to 20.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        SharingUserErrorException
        DbxException

      • listFolderMembersBuilder

        public ListFolderMembersBuilder listFolderMembersBuilder​(java.lang.String sharedFolderId)
        Returns shared folder membership by its folder ID.
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • listFoldersBuilder

        public ListFoldersBuilder listFoldersBuilder()
        Return the list of all shared folders the current user has access to.
        Returns:
        Request builder for configuring request parameters and completing the request.

      • listFoldersContinue

        public ListFoldersResult listFoldersContinue​(java.lang.String cursor)
                                      throws ListFoldersContinueErrorException,
                                             DbxException
        Once a cursor has been retrieved from listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), use this to paginate through all shared folders. The cursor must come from a previous call to listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or listFoldersContinue(String).
        Parameters:
        cursor - The cursor returned by the previous API call specified in the endpoint description. Must not be null.
        Returns:
        Result for listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.getPathLower().
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        ListFoldersContinueErrorException
        DbxException

      • listMountableFoldersBuilder

        public ListMountableFoldersBuilder listMountableFoldersBuilder()
        Return the list of all shared folders the current user can mount or unmount.
        Returns:
        Request builder for configuring request parameters and completing the request.

      • listMountableFoldersContinue

        public ListFoldersResult listMountableFoldersContinue​(java.lang.String cursor)
                                               throws ListFoldersContinueErrorException,
                                                      DbxException
        Once a cursor has been retrieved from listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), use this to paginate through all mountable shared folders. The cursor must come from a previous call to listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or listMountableFoldersContinue(String).
        Parameters:
        cursor - The cursor returned by the previous API call specified in the endpoint description. Must not be null.
        Returns:
        Result for listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.getPathLower().
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        ListFoldersContinueErrorException
        DbxException

      • listReceivedFilesBuilder

        public ListReceivedFilesBuilder listReceivedFilesBuilder()
        Returns a list of all files shared with current user. Does not include files the user has received via shared folders, and does not include unclaimed invitations.
        Returns:
        Request builder for configuring request parameters and completing the request.

      • listSharedLinks

        public ListSharedLinksResult listSharedLinks()
                                      throws ListSharedLinksErrorException,
                                             DbxException
        List shared links of this user.

        If no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member's home folder unless the team space ID is specified in the request header. For more information, refer to the :link:`Namespace Guide https://www.dropbox.com/developers/reference/namespace-guide`.

        If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.

        Throws:
        ListSharedLinksErrorException
        DbxException

      • listSharedLinksBuilder

        public ListSharedLinksBuilder listSharedLinksBuilder()
        List shared links of this user. If no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member's home folder unless the team space ID is specified in the request header. For more information, refer to the Namespace Guide. If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.
        Returns:
        Request builder for configuring request parameters and completing the request.

      • mountFolder

        public SharedFolderMetadata mountFolder​(java.lang.String sharedFolderId)
                                 throws MountFolderErrorException,
                                        DbxException
        The current user mounts the designated folder.

        Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.

        Parameters:
        sharedFolderId - The ID of the shared folder to mount. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        The metadata which includes basic information about the shared folder.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        MountFolderErrorException
        DbxException

      • relinquishFileMembership

        public void relinquishFileMembership​(java.lang.String file)
                              throws RelinquishFileMembershipErrorException,
                                     DbxException
        The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.
        Parameters:
        file - The path or id for the file. Must have length of at least 1, match pattern "((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RelinquishFileMembershipErrorException
        DbxException

      • relinquishFolderMembership

        public LaunchEmptyResult relinquishFolderMembership​(java.lang.String sharedFolderId)
                                             throws RelinquishFolderMembershipErrorException,
                                                    DbxException
        The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.

        This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.

        The leaveACopy request parameter will default to false (see relinquishFolderMembership(String,boolean)).

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RelinquishFolderMembershipErrorException
        DbxException

      • relinquishFolderMembership

        public LaunchEmptyResult relinquishFolderMembership​(java.lang.String sharedFolderId,
                                                    boolean leaveACopy)
                                             throws RelinquishFolderMembershipErrorException,
                                                    DbxException
        The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.

        This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        leaveACopy - Keep a copy of the folder's contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.
        Returns:
        Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RelinquishFolderMembershipErrorException
        DbxException

      • removeFileMember

        @Deprecated
public FileMemberActionIndividualResult removeFileMember​(java.lang.String file,
                                                         MemberSelector member)
                                                  throws RemoveFileMemberErrorException,
                                                         DbxException
        Deprecated.
        use removeFileMember2(String,MemberSelector) instead.
        Identical to remove_file_member_2 but with less information returned.
        Parameters:
        file - File from which to remove members. Must have length of at least 1, match pattern " ((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        member - Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RemoveFileMemberErrorException
        DbxException

      • removeFileMember2

        public FileMemberRemoveActionResult removeFileMember2​(java.lang.String file,
                                                      MemberSelector member)
                                               throws RemoveFileMemberErrorException,
                                                      DbxException
        Removes a specified member from the file.
        Parameters:
        file - File from which to remove members. Must have length of at least 1, match pattern " ((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        member - Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RemoveFileMemberErrorException
        DbxException

      • removeFolderMember

        public LaunchResultBase removeFolderMember​(java.lang.String sharedFolderId,
                                           MemberSelector member,
                                           boolean leaveACopy)
                                    throws RemoveFolderMemberErrorException,
                                           DbxException
        Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        member - The member to remove from the folder. Must not be null.
        leaveACopy - If true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. This must be set to false when removing a group, or when the folder is within a team folder or another shared folder.
        Returns:
        Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RemoveFolderMemberErrorException
        DbxException

      • revokeSharedLink

        public void revokeSharedLink​(java.lang.String url)
                      throws RevokeSharedLinkErrorException,
                             DbxException
        Revoke a shared link.

        Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the listSharedLinks(com.dropbox.core.v2.sharing.ListSharedLinksArg) with the file as the ListSharedLinksArg.getPath() argument.

        Parameters:
        url - URL of the shared link. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        RevokeSharedLinkErrorException
        DbxException

      • shareFolder

        public ShareFolderLaunch shareFolder​(java.lang.String path)
                              throws ShareFolderErrorException,
                                     DbxException
        Share a folder with collaborators.

        Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`.

        If a ShareFolderLaunch.getAsyncJobIdValue() is returned, you'll need to call checkShareJobStatus(String) until the action completes to get the metadata for the folder.

        The default values for the optional request parameters will be used. See ShareFolderBuilder for more details.

        Parameters:
        path - The path or the file id to the folder to share. If it does not exist, then a new one is created. Must match pattern " (/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        ShareFolderErrorException
        DbxException

      • shareFolderBuilder

        public ShareFolderBuilder shareFolderBuilder​(java.lang.String path)
        Share a folder with collaborators. Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`. If a ShareFolderLaunch.getAsyncJobIdValue() is returned, you'll need to call checkShareJobStatus(String) until the action completes to get the metadata for the folder.
        Parameters:
        path - The path or the file id to the folder to share. If it does not exist, then a new one is created. Must match pattern " (/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • transferFolder

        public void transferFolder​(java.lang.String sharedFolderId,
                           java.lang.String toDropboxId)
                    throws TransferFolderErrorException,
                           DbxException
        Transfer ownership of a shared folder to a member of the shared folder.

        User must have AccessLevel.OWNER access to the shared folder to perform a transfer.

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        toDropboxId - A account or team member ID to transfer ownership to. Must have length of at least 1 and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        TransferFolderErrorException
        DbxException

      • unmountFolder

        public void unmountFolder​(java.lang.String sharedFolderId)
                   throws UnmountFolderErrorException,
                          DbxException
        The current user unmounts the designated folder. They can re-mount the folder at a later time using mountFolder(String).
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        UnmountFolderErrorException
        DbxException

      • unshareFile

        public void unshareFile​(java.lang.String file)
                 throws UnshareFileErrorException,
                        DbxException
        Remove all members from this file. Does not remove inherited members.
        Parameters:
        file - The file to unshare. Must have length of at least 1, match pattern "((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        UnshareFileErrorException
        DbxException

      • unshareFolder

        public LaunchEmptyResult unshareFolder​(java.lang.String sharedFolderId)
                                throws UnshareFolderErrorException,
                                       DbxException
        Allows a shared folder owner to unshare the folder.

        You'll need to call checkJobStatus(String) to determine if the action has completed successfully.

        The leaveACopy request parameter will default to false (see unshareFolder(String,boolean)).

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        UnshareFolderErrorException
        DbxException

      • unshareFolder

        public LaunchEmptyResult unshareFolder​(java.lang.String sharedFolderId,
                                       boolean leaveACopy)
                                throws UnshareFolderErrorException,
                                       DbxException
        Allows a shared folder owner to unshare the folder.

        You'll need to call checkJobStatus(String) to determine if the action has completed successfully.

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        leaveACopy - If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.
        Returns:
        Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        UnshareFolderErrorException
        DbxException

      • updateFileMember

        public MemberAccessLevelResult updateFileMember​(java.lang.String file,
                                                MemberSelector member,
                                                AccessLevel accessLevel)
                                         throws FileMemberActionErrorException,
                                                DbxException
        Changes a member's access on a shared file.
        Parameters:
        file - File for which we are changing a member's access. Must have length of at least 1, match pattern " ((/|id:).*|nspath:[0-9]+:.*)|ns:[0-9]+(/.*)?", and not be null.
        member - The member whose access we are changing. Must not be null.
        accessLevel - The new access level for the member. Must not be null.
        Returns:
        Contains information about a member's access level to content after an operation.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        FileMemberActionErrorException
        DbxException

      • updateFolderPolicy

        public SharedFolderMetadata updateFolderPolicy​(java.lang.String sharedFolderId)
                                        throws UpdateFolderPolicyErrorException,
                                               DbxException
        Update the sharing policies for a shared folder.

        User must have AccessLevel.OWNER access to the shared folder to update its policies.

        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        The metadata which includes basic information about the shared folder.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
        UpdateFolderPolicyErrorException
        DbxException

      • updateFolderPolicyBuilder

        public UpdateFolderPolicyBuilder updateFolderPolicyBuilder​(java.lang.String sharedFolderId)
        Update the sharing policies for a shared folder. User must have AccessLevel.OWNER access to the shared folder to update its policies.
        Parameters:
        sharedFolderId - The ID for the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.
        Returns:
        Request builder for configuring request parameters and completing the request.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.