Module dropbox_sdk::sharing

This namespace contains endpoints and data types for creating and managing shared links and shared folders.

Structs

AddFileMemberArgs	Arguments for add_file_member().
AddFolderMemberArg
AddMember	The member and type of access the member should have when added to a shared folder.
AudienceExceptionContentInfo	Information about the content that has a link audience different than that of this folder.
AudienceExceptions	The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.
AudienceRestrictingSharedFolder	Information about the shared folder that prevents the link audience for this link from being more restrictive.
ChangeFileMemberAccessArgs	Arguments for change_file_member_access().
CollectionLinkMetadata	Metadata for a collection-based shared link.
CreateSharedLinkArg
CreateSharedLinkWithSettingsArg
ExpectedSharedContentLinkMetadata	The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.
FileLinkMetadata	The metadata of a file shared link.
FileMemberActionResult	Per-member result for add_file_member() or change_file_member_access().
FilePermission	Whether the user is allowed to take the sharing action on the file.
FolderLinkMetadata	The metadata of a folder shared link.
FolderPermission	Whether the user is allowed to take the action on the shared folder.
FolderPolicy	A set of policies governing membership and privileges for a shared folder.
GetFileMetadataArg	Arguments of get_file_metadata().
GetFileMetadataBatchArg	Arguments of get_file_metadata_batch().
GetFileMetadataBatchResult	Per file results of get_file_metadata_batch().
GetMetadataArgs
GetSharedLinkMetadataArg
GetSharedLinksArg
GetSharedLinksResult
GroupInfo	The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.
GroupMembershipInfo	The information about a group member of the shared content.
InsufficientPlan
InsufficientQuotaAmounts
InviteeMembershipInfo	Information about an invited member of a shared content.
LinkPermission	Permissions for actions that can be performed on a link.
LinkPermissions
LinkSettings	Settings that apply to a link.
ListFileMembersArg	Arguments for list_file_members().
ListFileMembersBatchArg	Arguments for list_file_members_batch().
ListFileMembersBatchResult	Per-file result for list_file_members_batch().
ListFileMembersContinueArg	Arguments for list_file_members_continue().
ListFileMembersCountResult
ListFilesArg	Arguments for list_received_files().
ListFilesContinueArg	Arguments for list_received_files_continue().
ListFilesResult	Success results for list_received_files().
ListFolderMembersArgs
ListFolderMembersContinueArg
ListFolderMembersCursorArg
ListFoldersArgs
ListFoldersContinueArg
ListFoldersResult	Result for list_folders() or list_mountable_folders(), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata::path_lower.
ListSharedLinksArg
ListSharedLinksResult
MemberAccessLevelResult	Contains information about a member's access level to content after an operation.
MemberPermission	Whether the user is allowed to take the action on the associated member.
MembershipInfo	The information about a member of the shared content.
ModifySharedLinkSettingsArgs
MountFolderArg
ParentFolderAccessInfo	Contains information about a parent folder that a member has access to.
PathLinkMetadata	Metadata for a path-based shared link.
RelinquishFileMembershipArg
RelinquishFolderMembershipArg
RemoveFileMemberArg	Arguments for remove_file_member_2().
RemoveFolderMemberArg
RevokeSharedLinkArg
SetAccessInheritanceArg
ShareFolderArg
ShareFolderArgBase
SharedContentLinkMetadata	Metadata of a shared link for a file or folder.
SharedContentLinkMetadataBase
SharedFileMembers	Shared file user, group, and invitee membership. Used for the results of list_file_members() and list_file_members_continue(), and used as part of the results for list_file_members_batch().
SharedFileMetadata	Properties of the shared file.
SharedFolderMembers	Shared folder user and group membership.
SharedFolderMetadata	The metadata which includes basic information about the shared folder.
SharedFolderMetadataBase	Properties of the shared folder.
SharedLinkSettings
TeamMemberInfo	Information about a team member.
TransferFolderArg
UnmountFolderArg
UnshareFileArg	Arguments for unshare_file().
UnshareFolderArg
UpdateFileMemberArgs	Arguments for update_file_member().
UpdateFolderMemberArg
UpdateFolderPolicyArg	If any of the policies are unset, then they retain their current setting.
UserFileMembershipInfo	The information about a user member of the shared content with an appended last seen timestamp.
UserInfo	Basic information about a user. Use users::get_account() and users::get_account_batch() to obtain more detailed information.
UserMembershipInfo	The information about a user member of the shared content.

Enums

AccessInheritance	Information about the inheritance policy of a shared folder.
AccessLevel	Defines the access levels for collaborators.
AclUpdatePolicy	Who can change a shared folder's access control list (ACL). In other words, who can add, remove, or change the privileges of members.
AddFileMemberError	Errors for add_file_member().
AddFolderMemberError
AddMemberSelectorError
CreateSharedLinkError
CreateSharedLinkWithSettingsError
FileAction	Sharing actions that may be taken on files.
FileErrorResult
FileMemberActionError
FileMemberActionIndividualResult
FileMemberRemoveActionResult
FolderAction	Actions that may be taken on shared folders.
GetFileMetadataError	Error result for get_file_metadata().
GetFileMetadataIndividualResult
GetSharedLinkFileError
GetSharedLinksError
InviteeInfo	Information about the recipient of a shared content invitation.
JobError	Error occurred while performing an asynchronous job from unshare_folder() or remove_folder_member().
JobStatus
LinkAccessLevel
LinkAction	Actions that can be performed on a link.
LinkAudience
LinkExpiry
LinkMetadata	Metadata for a shared link. This can be either a PathLinkMetadata or CollectionLinkMetadata.
LinkPassword
ListFileMembersContinueError	Error for list_file_members_continue().
ListFileMembersError	Error for list_file_members().
ListFileMembersIndividualResult
ListFilesContinueError	Error results for list_received_files_continue().
ListFolderMembersContinueError
ListFoldersContinueError
ListSharedLinksError
MemberAction	Actions that may be taken on members of a shared folder.
MemberPolicy	Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.
MemberSelector	Includes different ways to identify a member of a shared folder.
ModifySharedLinkSettingsError
MountFolderError
PendingUploadMode	Flag to indicate pending upload default (for linking to not-yet-existing paths).
PermissionDeniedReason	Possible reasons the user is denied a permission.
RelinquishFileMembershipError
RelinquishFolderMembershipError
RemoveFileMemberError	Errors for remove_file_member_2().
RemoveFolderMemberError
RemoveMemberJobStatus
RequestedLinkAccessLevel
RequestedVisibility	The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the ResolvedVisibility for more info on the possible resolved visibility values of shared links.
ResolvedVisibility	The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the RequestedVisibility for more info on the possible visibility values that can be set by the shared link's owner.
RevokeSharedLinkError
SetAccessInheritanceError
ShareFolderError
ShareFolderErrorBase
ShareFolderJobStatus
ShareFolderLaunch
SharePathError
SharedFolderAccessError	There is an error accessing the shared folder.
SharedFolderMemberError
SharedLinkAccessFailureReason
SharedLinkAlreadyExistsMetadata
SharedLinkError
SharedLinkMetadata	The metadata of a shared link.
SharedLinkPolicy	Who can view shared links in this folder.
SharedLinkSettingsError
SharingFileAccessError	User could not access this file.
SharingUserError	User account had a problem preventing this action.
TransferFolderError
UnmountFolderError
UnshareFileError	Error result for unshare_file().
UnshareFolderError
UpdateFolderMemberError
UpdateFolderPolicyError
ViewerInfoPolicy
Visibility	Who can access a shared link. The most open visibility is Public. The default depends on many aspects, such as team and user preferences and shared folder settings.

Functions

add_file_member	Adds specified members to a file.
add_folder_member	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 mount_folder() on their behalf.
change_file_member_access	Identical to update_file_member but with less information returned.
check_job_status	Returns the status of an asynchronous job.
check_remove_member_job_status	Returns the status of an asynchronous job for sharing a folder.
check_share_job_status	Returns the status of an asynchronous job for sharing a folder.
create_shared_link	Create a shared link. If a shared link already exists for the given path, that link is returned. Note that in the returned PathLinkMetadata, the PathLinkMetadata::url field is the shortened URL if CreateSharedLinkArg::short_url 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 revoke_shared_link().
create_shared_link_with_settings	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).
get_file_metadata	Returns shared file metadata.
get_file_metadata_batch	Returns shared file metadata.
get_folder_metadata	Returns shared folder metadata by its folder ID.
get_shared_link_file	Download the shared link's file from a user's Dropbox.
get_shared_link_metadata	Get the shared link's metadata.
get_shared_links	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. Note that the url field in the response is never the shortened URL.
list_file_members	Use to obtain the members who have been invited to a file, both inherited and uninherited members.
list_file_members_batch	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.
list_file_members_continue	Once a cursor has been retrieved from list_file_members() or list_file_members_batch(), use this to paginate through all shared file members.
list_folder_members	Returns shared folder membership by its folder ID.
list_folder_members_continue	Once a cursor has been retrieved from list_folder_members(), use this to paginate through all shared folder members.
list_folders	Return the list of all shared folders the current user has access to.
list_folders_continue	Once a cursor has been retrieved from list_folders(), use this to paginate through all shared folders. The cursor must come from a previous call to list_folders() or list_folders_continue().
list_mountable_folders	Return the list of all shared folders the current user can mount or unmount.
list_mountable_folders_continue	Once a cursor has been retrieved from list_mountable_folders(), use this to paginate through all mountable shared folders. The cursor must come from a previous call to list_mountable_folders() or list_mountable_folders_continue().
list_received_files	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.
list_received_files_continue	Get more results with a cursor from list_received_files().
list_shared_links	List shared links of this user. If no path is given, returns a list of all shared links for the current user. 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.
modify_shared_link_settings	Modify the shared link's settings. If the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the LinkPermissions::resolved_visibility of the returned SharedLinkMetadata will reflect the actual visibility of the shared link and the LinkPermissions::requested_visibility will reflect the requested visibility.
mount_folder	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.
relinquish_file_membership	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.
relinquish_folder_membership	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.
remove_file_member	Identical to remove_file_member_2 but with less information returned.
remove_file_member_2	Removes a specified member from the file.
remove_folder_member	Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.
revoke_shared_link	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 list_shared_links() with the file as the ListSharedLinksArg::path argument.
set_access_inheritance	Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root. If a ShareFolderLaunch::AsyncJobId is returned, you'll need to call check_share_job_status() until the action completes to get the metadata for the folder.
share_folder	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::AsyncJobId is returned, you'll need to call check_share_job_status() until the action completes to get the metadata for the folder.
transfer_folder	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.
unmount_folder	The current user unmounts the designated folder. They can re-mount the folder at a later time using mount_folder().
unshare_file	Remove all members from this file. Does not remove inherited members.
unshare_folder	Allows a shared folder owner to unshare the folder. You'll need to call check_job_status() to determine if the action has completed successfully.
update_file_member	Changes a member's access on a shared file.
update_folder_member	Allows an owner or editor of a shared folder to update another member's permissions.
update_folder_policy	Update the sharing policies for a shared folder. User must have AccessLevel::Owner access to the shared folder to update its policies.

Type Definitions

DropboxId
GetSharedLinkFileArg
Id
Path
PathOrId
ReadPath
Rev
TeamInfo