public final class DbxUserSharingRequests extends Object
| Constructor and Description |
|---|
DbxUserSharingRequests(DbxRawClientV2 client) |
| Modifier and Type | Method and Description |
|---|---|
List<FileMemberActionResult> |
addFileMember(String file,
List<MemberSelector> members)
Adds specified members to a file.
|
AddFileMemberBuilder |
addFileMemberBuilder(String file,
List<MemberSelector> members)
Adds specified members to a file.
|
void |
addFolderMember(String sharedFolderId,
List<AddMember> members)
Allows an owner or editor (if the ACL update policy allows) of a shared
folder to add another member.
|
AddFolderMemberBuilder |
addFolderMemberBuilder(String sharedFolderId,
List<AddMember> members)
Allows an owner or editor (if the ACL update policy allows) of a shared
folder to add another member.
|
JobStatus |
checkJobStatus(String asyncJobId)
Returns the status of an asynchronous job.
|
RemoveMemberJobStatus |
checkRemoveMemberJobStatus(String asyncJobId)
Returns the status of an asynchronous job for sharing a folder.
|
ShareFolderJobStatus |
checkShareJobStatus(String asyncJobId)
Returns the status of an asynchronous job for sharing a folder.
|
PathLinkMetadata |
createSharedLink(String path)
Deprecated.
use
createSharedLinkWithSettings(String) instead. |
CreateSharedLinkBuilder |
createSharedLinkBuilder(String path)
Deprecated.
use
createSharedLinkWithSettings(String) instead. |
SharedLinkMetadata |
createSharedLinkWithSettings(String path)
Create a shared link with custom settings.
|
SharedLinkMetadata |
createSharedLinkWithSettings(String path,
SharedLinkSettings settings)
Create a shared link with custom settings.
|
SharedFileMetadata |
getFileMetadata(String file)
Returns shared file metadata.
|
SharedFileMetadata |
getFileMetadata(String file,
List<FileAction> actions)
Returns shared file metadata.
|
List<GetFileMetadataBatchResult> |
getFileMetadataBatch(List<String> files)
Returns shared file metadata.
|
List<GetFileMetadataBatchResult> |
getFileMetadataBatch(List<String> files,
List<FileAction> actions)
Returns shared file metadata.
|
SharedFolderMetadata |
getFolderMetadata(String sharedFolderId)
Returns shared folder metadata by its folder ID.
|
SharedFolderMetadata |
getFolderMetadata(String sharedFolderId,
List<FolderAction> actions)
Returns shared folder metadata by its folder ID.
|
DbxDownloader<SharedLinkMetadata> |
getSharedLinkFile(String url)
Download the shared link's file from a user's Dropbox.
|
GetSharedLinkFileBuilder |
getSharedLinkFileBuilder(String url)
Download the shared link's file from a user's Dropbox.
|
SharedLinkMetadata |
getSharedLinkMetadata(String url)
Get the shared link's metadata.
|
GetSharedLinkMetadataBuilder |
getSharedLinkMetadataBuilder(String url)
Get the shared link's metadata.
|
GetSharedLinksResult |
getSharedLinks()
Deprecated.
use
listSharedLinks() instead. |
GetSharedLinksResult |
getSharedLinks(String path)
Deprecated.
use
listSharedLinks() instead. |
SharedFileMembers |
listFileMembers(String file)
Use to obtain the members who have been invited to a file, both inherited
and uninherited members.
|
List<ListFileMembersBatchResult> |
listFileMembersBatch(List<String> files)
Get members of multiple files at once.
|
List<ListFileMembersBatchResult> |
listFileMembersBatch(List<String> files,
long limit)
Get members of multiple files at once.
|
ListFileMembersBuilder |
listFileMembersBuilder(String file)
Use to obtain the members who have been invited to a file, both inherited
and uninherited members.
|
SharedFileMembers |
listFileMembersContinue(String cursor)
Once a cursor has been retrieved from
listFileMembers(String) or listFileMembersBatch(List), use this to paginate
through all shared file members. |
SharedFolderMembers |
listFolderMembers(String sharedFolderId)
Returns shared folder membership by its folder ID.
|
ListFolderMembersBuilder |
listFolderMembersBuilder(String sharedFolderId)
Returns shared folder membership by its folder ID.
|
SharedFolderMembers |
listFolderMembersContinue(String cursor)
Once a cursor has been retrieved from
listFolderMembers(String), use this to paginate
through all shared folder members. |
ListFoldersResult |
listFolders()
Return the list of all shared folders the current user has access to.
|
ListFoldersBuilder |
listFoldersBuilder()
Return the list of all shared folders the current user has access to.
|
ListFoldersResult |
listFoldersContinue(String cursor)
Once a cursor has been retrieved from
listFolders(), use this to paginate through all
shared folders. |
ListFoldersResult |
listMountableFolders()
Return the list of all shared folders the current user can mount or
unmount.
|
ListMountableFoldersBuilder |
listMountableFoldersBuilder()
Return the list of all shared folders the current user can mount or
unmount.
|
ListFoldersResult |
listMountableFoldersContinue(String cursor)
Once a cursor has been retrieved from
listMountableFolders(), use this to paginate
through all mountable shared folders. |
ListFilesResult |
listReceivedFiles()
Returns a list of all files shared with current user.
|
ListReceivedFilesBuilder |
listReceivedFilesBuilder()
Returns a list of all files shared with current user.
|
ListFilesResult |
listReceivedFilesContinue(String cursor)
Get more results with a cursor from
listReceivedFiles(). |
ListSharedLinksResult |
listSharedLinks()
List shared links of this user.
|
ListSharedLinksBuilder |
listSharedLinksBuilder()
List shared links of this user.
|
SharedLinkMetadata |
modifySharedLinkSettings(String url,
SharedLinkSettings settings)
Modify the shared link's settings.
|
SharedLinkMetadata |
modifySharedLinkSettings(String url,
SharedLinkSettings settings,
boolean removeExpiration)
Modify the shared link's settings.
|
SharedFolderMetadata |
mountFolder(String sharedFolderId)
The current user mounts the designated folder.
|
void |
relinquishFileMembership(String file)
The current user relinquishes their membership in the designated file.
|
LaunchEmptyResult |
relinquishFolderMembership(String sharedFolderId)
The current user relinquishes their membership in the designated shared
folder and will no longer have access to the folder.
|
LaunchEmptyResult |
relinquishFolderMembership(String sharedFolderId,
boolean leaveACopy)
The current user relinquishes their membership in the designated shared
folder and will no longer have access to the folder.
|
FileMemberActionIndividualResult |
removeFileMember(String file,
MemberSelector member)
Deprecated.
use
removeFileMember2(String,MemberSelector)
instead. |
FileMemberRemoveActionResult |
removeFileMember2(String file,
MemberSelector member)
Removes a specified member from the file.
|
LaunchResultBase |
removeFolderMember(String sharedFolderId,
MemberSelector member,
boolean leaveACopy)
Allows an owner or editor (if the ACL update policy allows) of a shared
folder to remove another member.
|
void |
revokeSharedLink(String url)
Revoke a shared link.
|
ShareFolderLaunch |
shareFolder(String path)
Share a folder with collaborators.
|
ShareFolderBuilder |
shareFolderBuilder(String path)
Share a folder with collaborators.
|
void |
transferFolder(String sharedFolderId,
String toDropboxId)
Transfer ownership of a shared folder to a member of the shared folder.
|
void |
unmountFolder(String sharedFolderId)
The current user unmounts the designated folder.
|
void |
unshareFile(String file)
Remove all members from this file.
|
LaunchEmptyResult |
unshareFolder(String sharedFolderId)
Allows a shared folder owner to unshare the folder.
|
LaunchEmptyResult |
unshareFolder(String sharedFolderId,
boolean leaveACopy)
Allows a shared folder owner to unshare the folder.
|
MemberAccessLevelResult |
updateFolderMember(String sharedFolderId,
MemberSelector member,
AccessLevel accessLevel)
Allows an owner or editor of a shared folder to update another member's
permissions.
|
SharedFolderMetadata |
updateFolderPolicy(String sharedFolderId)
Update the sharing policies for a shared folder.
|
UpdateFolderPolicyBuilder |
updateFolderPolicyBuilder(String sharedFolderId)
Update the sharing policies for a shared folder.
|
public DbxUserSharingRequests(DbxRawClientV2 client)
public List<FileMemberActionResult> addFileMember(String file, List<MemberSelector> members) throws AddFileMemberErrorException, DbxException
The default values for the optional request parameters will be used.
See AddFileMemberBuilder for more details.
file - File to which to add members. Must have length of at least
1, match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be
null.members - Members to add. Note that even an email address is given,
this may result in a user being directy added to the membership if
that email is the user's main account email. Must not contain a
null item and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.AddFileMemberErrorExceptionDbxExceptionpublic AddFileMemberBuilder addFileMemberBuilder(String file, List<MemberSelector> members)
file - File to which to add members. Must have length of at least
1, match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be
null.members - Members to add. Note that even an email address is given,
this may result in a user being directy added to the membership if
that email is the user's main account email. Must not contain a
null item and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.public void addFolderMember(String sharedFolderId, List<AddMember> members) throws AddFolderMemberErrorException, DbxException
mountFolder(String) on their behalf. Apps must
have full Dropbox access to use this endpoint.
The default values for the optional request parameters will be used.
See AddFolderMemberBuilder for more details.
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.IllegalArgumentException - If any argument does not meet its
preconditions.AddFolderMemberErrorExceptionDbxExceptionpublic AddFolderMemberBuilder addFolderMemberBuilder(String sharedFolderId, List<AddMember> members)
mountFolder(String) on their behalf. Apps must
have full Dropbox access to use this endpoint.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.IllegalArgumentException - If any argument does not meet its
preconditions.public JobStatus checkJobStatus(String asyncJobId) throws PollErrorException, DbxException
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.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic RemoveMemberJobStatus checkRemoveMemberJobStatus(String asyncJobId) throws PollErrorException, DbxException
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.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic ShareFolderJobStatus checkShareJobStatus(String asyncJobId) throws PollErrorException, DbxException
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.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxException@Deprecated public PathLinkMetadata createSharedLink(String path) throws CreateSharedLinkErrorException, DbxException
createSharedLinkWithSettings(String) instead.PathLinkMetadata, the LinkMetadata.getUrl() field is the shortened
URL if the shortUrl argument to createSharedLink(String) argument is set to
true. 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).
The default values for the optional request parameters will be used.
See CreateSharedLinkBuilder for more details.
path - The path to share. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.CreateSharedLinkErrorExceptionDbxException@Deprecated public CreateSharedLinkBuilder createSharedLinkBuilder(String path)
createSharedLinkWithSettings(String) instead.PathLinkMetadata, the LinkMetadata.getUrl() field is the shortened
URL if the shortUrl argument to createSharedLink(String) argument is set to
true. 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).path - The path to share. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.public SharedLinkMetadata createSharedLinkWithSettings(String path) throws CreateSharedLinkWithSettingsErrorException, DbxException
RequestedVisibility.PUBLIC (The
resolved visibility, though, may depend on other aspects such as team and
shared folder settings).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.IllegalArgumentException - If any argument does not meet its
preconditions.CreateSharedLinkWithSettingsErrorExceptionDbxExceptionpublic SharedLinkMetadata createSharedLinkWithSettings(String path, SharedLinkSettings settings) throws CreateSharedLinkWithSettingsErrorException, DbxException
RequestedVisibility.PUBLIC (The
resolved visibility, though, may depend on other aspects such as team and
shared folder settings).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.IllegalArgumentException - If any argument does not meet its
preconditions.CreateSharedLinkWithSettingsErrorExceptionDbxExceptionpublic SharedFileMetadata getFileMetadata(String file) throws GetFileMetadataErrorException, DbxException
file - The file to query. Must have length of at least 1, match
pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.GetFileMetadataErrorExceptionDbxExceptionpublic SharedFileMetadata getFileMetadata(String file, List<FileAction> actions) throws GetFileMetadataErrorException, DbxException
file - The file to query. Must have length of at least 1, match
pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be null.actions - File actions to query. Must not contain a null
item.IllegalArgumentException - If any argument does not meet its
preconditions.GetFileMetadataErrorExceptionDbxExceptionpublic List<GetFileMetadataBatchResult> getFileMetadataBatch(List<String> files) throws SharingUserErrorException, DbxException
files - The files to query. Must contain at most 100 items, not
contain a null item, and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.SharingUserErrorExceptionDbxExceptionpublic List<GetFileMetadataBatchResult> getFileMetadataBatch(List<String> files, List<FileAction> actions) throws SharingUserErrorException, DbxException
files - The files to query. Must contain at most 100 items, not
contain a null item, and not be null.actions - File actions to query. Must not contain a null
item.IllegalArgumentException - If any argument does not meet its
preconditions.SharingUserErrorExceptionDbxExceptionpublic SharedFolderMetadata getFolderMetadata(String sharedFolderId) throws SharedFolderAccessErrorException, DbxException
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.SharedFolderAccessErrorExceptionDbxExceptionpublic SharedFolderMetadata getFolderMetadata(String sharedFolderId, List<FolderAction> actions) throws SharedFolderAccessErrorException, DbxException
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.actions - This is a list indicating whether the returned folder
data will include a boolean value FolderPermission.getAllow()
that describes whether the current user can perform the FolderAction
on the folder. Must not contain a null item.IllegalArgumentException - If any argument does not meet its
preconditions.SharedFolderAccessErrorExceptionDbxExceptionpublic DbxDownloader<SharedLinkMetadata> getSharedLinkFile(String url) throws GetSharedLinkFileErrorException, DbxException
url - URL of the shared link. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.GetSharedLinkFileErrorExceptionDbxExceptionpublic GetSharedLinkFileBuilder getSharedLinkFileBuilder(String url)
url - URL of the shared link. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.public SharedLinkMetadata getSharedLinkMetadata(String url) throws SharedLinkErrorException, DbxException
url - URL of the shared link. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.SharedLinkErrorExceptionDbxExceptionpublic GetSharedLinkMetadataBuilder getSharedLinkMetadataBuilder(String url)
url - URL of the shared link. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.@Deprecated public GetSharedLinksResult getSharedLinks() throws GetSharedLinksErrorException, DbxException
listSharedLinks() instead.LinkMetadata objects for this user, including
collection links. If no path is given or the path is empty, returns a
list of all shared links for the current user, including collection
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. Note that the url field in the response is never the
shortened URL.@Deprecated public GetSharedLinksResult getSharedLinks(String path) throws GetSharedLinksErrorException, DbxException
listSharedLinks() instead.LinkMetadata objects for this user, including
collection links. If no path is given or the path is empty, returns a
list of all shared links for the current user, including collection
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. Note that the url field in the response is never the
shortened URL.path - See getSharedLinks()
description.GetSharedLinksErrorExceptionDbxExceptionpublic SharedFileMembers listFileMembers(String file) throws ListFileMembersErrorException, DbxException
The default values for the optional request parameters will be used.
See ListFileMembersBuilder for more details.
file - The file for which you want to see members. Must have length
of at least 1, match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be null.listFileMembers(String) and
listFileMembersContinue(String), and
used as part of the results for listFileMembersBatch(List).IllegalArgumentException - If any argument does not meet its
preconditions.ListFileMembersErrorExceptionDbxExceptionpublic ListFileMembersBuilder listFileMembersBuilder(String file)
file - The file for which you want to see members. Must have length
of at least 1, match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.public List<ListFileMembersBatchResult> listFileMembersBatch(List<String> files) throws SharingUserErrorException, DbxException
The limit request parameter will default to 10L (see
listFileMembersBatch(List,long)).
files - Files for which to return members. Must contain at most 100
items, not contain a null item, and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.SharingUserErrorExceptionDbxExceptionpublic List<ListFileMembersBatchResult> listFileMembersBatch(List<String> files, long limit) throws SharingUserErrorException, DbxException
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.IllegalArgumentException - If any argument does not meet its
preconditions.SharingUserErrorExceptionDbxExceptionpublic SharedFileMembers listFileMembersContinue(String cursor) throws ListFileMembersContinueErrorException, DbxException
listFileMembers(String) or listFileMembersBatch(List), use this to paginate
through all shared file members.cursor - The cursor returned by your last call to listFileMembers(String), listFileMembersContinue(String), or listFileMembersBatch(List). Must not be
null.listFileMembers(String) and
listFileMembersContinue(String), and
used as part of the results for listFileMembersBatch(List).IllegalArgumentException - If any argument does not meet its
preconditions.ListFileMembersContinueErrorExceptionDbxExceptionpublic SharedFolderMembers listFolderMembers(String sharedFolderId) throws SharedFolderAccessErrorException, DbxException
The default values for the optional request parameters will be used.
See ListFolderMembersBuilder for more details.
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.SharedFolderAccessErrorExceptionDbxExceptionpublic ListFolderMembersBuilder listFolderMembersBuilder(String sharedFolderId)
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.public SharedFolderMembers listFolderMembersContinue(String cursor) throws ListFolderMembersContinueErrorException, DbxException
listFolderMembers(String), use this to paginate
through all shared folder members. Apps must have full Dropbox access to
use this endpoint.cursor - The cursor returned by your last call to listFolderMembers(String) or listFolderMembersContinue(String). Must not
be null.IllegalArgumentException - If any argument does not meet its
preconditions.ListFolderMembersContinueErrorExceptionDbxExceptionpublic ListFoldersResult listFolders() throws DbxException
The default values for the optional request parameters will be used.
See ListFoldersBuilder for more details.
listFolders() or listMountableFolders(), depending on which
endpoint was requested. Unmounted shared folders can be identified by
the absence of SharedFolderMetadata.getPathLower().DbxExceptionpublic ListFoldersBuilder listFoldersBuilder()
public ListFoldersResult listFoldersContinue(String cursor) throws ListFoldersContinueErrorException, DbxException
listFolders(), use this to paginate through all
shared folders. The cursor must come from a previous call to listFolders() or listFoldersContinue(String). Apps must have full
Dropbox access to use this endpoint.cursor - The cursor returned by the previous API call specified in
the endpoint description. Must not be null.listFolders() or listMountableFolders(), depending on which
endpoint was requested. Unmounted shared folders can be identified by
the absence of SharedFolderMetadata.getPathLower().IllegalArgumentException - If any argument does not meet its
preconditions.ListFoldersContinueErrorExceptionDbxExceptionpublic ListFoldersResult listMountableFolders() throws DbxException
The default values for the optional request parameters will be used.
See ListMountableFoldersBuilder for more details.
listFolders() or listMountableFolders(), depending on which
endpoint was requested. Unmounted shared folders can be identified by
the absence of SharedFolderMetadata.getPathLower().DbxExceptionpublic ListMountableFoldersBuilder listMountableFoldersBuilder()
public ListFoldersResult listMountableFoldersContinue(String cursor) throws ListFoldersContinueErrorException, DbxException
listMountableFolders(), use this to paginate
through all mountable shared folders. The cursor must come from a
previous call to listMountableFolders() or
listMountableFoldersContinue(String). Apps
must have full Dropbox access to use this endpoint.cursor - The cursor returned by the previous API call specified in
the endpoint description. Must not be null.listFolders() or listMountableFolders(), depending on which
endpoint was requested. Unmounted shared folders can be identified by
the absence of SharedFolderMetadata.getPathLower().IllegalArgumentException - If any argument does not meet its
preconditions.ListFoldersContinueErrorExceptionDbxExceptionpublic ListFilesResult listReceivedFiles() throws SharingUserErrorException, DbxException
The default values for the optional request parameters will be used.
See ListReceivedFilesBuilder for more details.
listReceivedFiles().SharingUserErrorExceptionDbxExceptionpublic ListReceivedFilesBuilder listReceivedFilesBuilder()
public ListFilesResult listReceivedFilesContinue(String cursor) throws ListFilesContinueErrorException, DbxException
listReceivedFiles().cursor - Cursor in ListFilesResult.getCursor(). Must not be
null.listReceivedFiles().IllegalArgumentException - If any argument does not meet its
preconditions.ListFilesContinueErrorExceptionDbxExceptionpublic ListSharedLinksResult listSharedLinks() throws ListSharedLinksErrorException, DbxException
public ListSharedLinksBuilder listSharedLinksBuilder()
public SharedLinkMetadata modifySharedLinkSettings(String url, SharedLinkSettings settings) throws ModifySharedLinkSettingsErrorException, DbxException
LinkPermissions.getResolvedVisibility() of the returned SharedLinkMetadata will reflect the actual visibility of the shared link
and the LinkPermissions.getRequestedVisibility() will reflect the
requested visibility.
The removeExpiration request parameter will default to false (see modifySharedLinkSettings(String,SharedLinkSettings,boolean)).
url - URL of the shared link to change its settings. Must not be
null.settings - Set of settings for the shared link. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.ModifySharedLinkSettingsErrorExceptionDbxExceptionpublic SharedLinkMetadata modifySharedLinkSettings(String url, SharedLinkSettings settings, boolean removeExpiration) throws ModifySharedLinkSettingsErrorException, DbxException
LinkPermissions.getResolvedVisibility() of the returned SharedLinkMetadata will reflect the actual visibility of the shared link
and the LinkPermissions.getRequestedVisibility() will reflect the
requested visibility.url - URL of the shared link to change its settings. Must not be
null.settings - Set of settings for the shared link. Must not be null.removeExpiration - If set to true, removes the expiration of the
shared link.IllegalArgumentException - If any argument does not meet its
preconditions.ModifySharedLinkSettingsErrorExceptionDbxExceptionpublic SharedFolderMetadata mountFolder(String sharedFolderId) throws MountFolderErrorException, DbxException
sharedFolderId - The ID of the shared folder to mount. Must match
pattern "[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.MountFolderErrorExceptionDbxExceptionpublic void relinquishFileMembership(String file) throws RelinquishFileMembershipErrorException, DbxException
file - The path or id for the file. Must have length of at least 1,
match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be
null.IllegalArgumentException - If any argument does not meet its
preconditions.RelinquishFileMembershipErrorExceptionDbxExceptionpublic LaunchEmptyResult relinquishFolderMembership(String sharedFolderId) throws RelinquishFolderMembershipErrorException, DbxException
The leaveACopy request parameter will default to false (see relinquishFolderMembership(String,boolean)).
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.RelinquishFolderMembershipErrorExceptionDbxExceptionpublic LaunchEmptyResult relinquishFolderMembership(String sharedFolderId, boolean leaveACopy) throws RelinquishFolderMembershipErrorException, DbxException
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.IllegalArgumentException - If any argument does not meet its
preconditions.RelinquishFolderMembershipErrorExceptionDbxException@Deprecated public FileMemberActionIndividualResult removeFileMember(String file, MemberSelector member) throws RemoveFileMemberErrorException, DbxException
removeFileMember2(String,MemberSelector)
instead.file - File from which to remove members. Must have length of at
least 1, match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", 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.IllegalArgumentException - If any argument does not meet its
preconditions.RemoveFileMemberErrorExceptionDbxExceptionpublic FileMemberRemoveActionResult removeFileMember2(String file, MemberSelector member) throws RemoveFileMemberErrorException, DbxException
file - File from which to remove members. Must have length of at
least 1, match pattern "((/|id:).*|nspath:[^:]*:[^:]*)", 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.IllegalArgumentException - If any argument does not meet its
preconditions.RemoveFileMemberErrorExceptionDbxExceptionpublic LaunchResultBase removeFolderMember(String sharedFolderId, MemberSelector member, boolean leaveACopy) throws RemoveFolderMemberErrorException, DbxException
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. Also, this must be set to false
when kicking a group.LaunchEmptyResult for an example.IllegalArgumentException - If any argument does not meet its
preconditions.RemoveFolderMemberErrorExceptionDbxExceptionpublic void revokeSharedLink(String url) throws RevokeSharedLinkErrorException, DbxException
listSharedLinks() with the file as the the path argument to listSharedLinks()
argument.url - URL of the shared link. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.RevokeSharedLinkErrorExceptionDbxExceptionpublic ShareFolderLaunch shareFolder(String path) throws ShareFolderErrorException, DbxException
ShareFolderLaunch.asyncJobId(java.lang.String) is returned, you'll need to call
checkShareJobStatus(String) until the
action completes to get the metadata for the folder. Apps must have full
Dropbox access to use this endpoint.
The default values for the optional request parameters will be used.
See ShareFolderBuilder for more details.
path - The path to the folder to share. If it does not exist, then
a new one is created. Must match pattern "/(.|[\\r\\n])*" and
not be null.IllegalArgumentException - If any argument does not meet its
preconditions.ShareFolderErrorExceptionDbxExceptionpublic ShareFolderBuilder shareFolderBuilder(String path)
ShareFolderLaunch.asyncJobId(java.lang.String) is returned, you'll need to call
checkShareJobStatus(String) until the
action completes to get the metadata for the folder. Apps must have full
Dropbox access to use this endpoint.path - The path to the folder to share. If it does not exist, then
a new one is created. Must match pattern "/(.|[\\r\\n])*" and
not be null.IllegalArgumentException - If any argument does not meet its
preconditions.public void transferFolder(String sharedFolderId, String toDropboxId) throws TransferFolderErrorException, DbxException
AccessLevel.OWNER access to the shared folder to
perform a transfer. Apps must have full Dropbox access to use this
endpoint.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.IllegalArgumentException - If any argument does not meet its
preconditions.TransferFolderErrorExceptionDbxExceptionpublic void unmountFolder(String sharedFolderId) throws UnmountFolderErrorException, DbxException
mountFolder(String). Apps must have full Dropbox
access to use this endpoint.sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.UnmountFolderErrorExceptionDbxExceptionpublic void unshareFile(String file) throws UnshareFileErrorException, DbxException
file - The file to unshare. Must have length of at least 1, match
pattern "((/|id:).*|nspath:[^:]*:[^:]*)", and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.UnshareFileErrorExceptionDbxExceptionpublic LaunchEmptyResult unshareFolder(String sharedFolderId) throws UnshareFolderErrorException, DbxException
checkJobStatus(String) to determine if the
action has completed successfully. Apps must have full Dropbox access to
use this endpoint.
The leaveACopy request parameter will default to false (see unshareFolder(String,boolean)).
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.UnshareFolderErrorExceptionDbxExceptionpublic LaunchEmptyResult unshareFolder(String sharedFolderId, boolean leaveACopy) throws UnshareFolderErrorException, DbxException
checkJobStatus(String) to determine if the
action has completed successfully. Apps must have full Dropbox access to
use this endpoint.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.IllegalArgumentException - If any argument does not meet its
preconditions.UnshareFolderErrorExceptionDbxExceptionpublic MemberAccessLevelResult updateFolderMember(String sharedFolderId, MemberSelector member, AccessLevel accessLevel) throws UpdateFolderMemberErrorException, DbxException
sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.member - The member of the shared folder to update. Only the
MemberSelector.dropboxId(java.lang.String) may be set at this time. Must not be
null.accessLevel - The new access level for the member argument
to updateFolderMember(String,MemberSelector,AccessLevel).
AccessLevel.OWNER is disallowed. Must not be null.IllegalArgumentException - If any argument does not meet its
preconditions.UpdateFolderMemberErrorExceptionDbxExceptionpublic SharedFolderMetadata updateFolderPolicy(String sharedFolderId) throws UpdateFolderPolicyErrorException, DbxException
AccessLevel.OWNER access to the shared folder to update its policies.
Apps must have full Dropbox access to use this endpoint.sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.UpdateFolderPolicyErrorExceptionDbxExceptionpublic UpdateFolderPolicyBuilder updateFolderPolicyBuilder(String sharedFolderId)
AccessLevel.OWNER access to the shared folder to update its policies.
Apps must have full Dropbox access to use this endpoint.sharedFolderId - The ID for the shared folder. Must match pattern
"[-_0-9a-zA-Z:]+" and not be null.IllegalArgumentException - If any argument does not meet its
preconditions.