Module dropbox_sdk::sharing [−][src]
dbx_sharing only.Expand description
This namespace contains endpoints and data types for creating and managing shared links and shared folders.
Structs
Arguments for add_file_member().
The member and type of access the member should have when added to a shared folder.
Information about the content that has a link audience different than that of this folder.
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.
Information about the shared folder that prevents the link audience for this link from being more restrictive.
Metadata for a collection-based shared link.
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.
The metadata of a file shared link.
Per-member result for add_file_member().
Whether the user is allowed to take the sharing action on the file.
The metadata of a folder shared link.
Whether the user is allowed to take the action on the shared folder.
A set of policies governing membership and privileges for a shared folder.
Arguments of get_file_metadata().
Arguments of get_file_metadata_batch().
Per file results of get_file_metadata_batch().
The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.
The information about a group member of the shared content.
Information about an invited member of a shared content.
Permissions for actions that can be performed on a link.
Settings that apply to a link.
Arguments for list_file_members().
Arguments for list_file_members_batch().
Per-file result for list_file_members_batch().
Arguments for list_file_members_continue().
Arguments for list_received_files().
Arguments for list_received_files_continue().
Success results for list_received_files().
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.
Contains information about a member’s access level to content after an operation.
Whether the user is allowed to take the action on the associated member.
The information about a member of the shared content.
Contains information about a parent folder that a member has access to.
Metadata for a path-based shared link.
Arguments for remove_file_member_2().
Metadata of a shared link for a file or folder.
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().
Properties of the shared file.
Shared folder user and group membership.
The metadata which includes basic information about the shared folder.
Properties of the shared folder.
Information about a team member.
Arguments for unshare_file().
Arguments for update_file_member().
If any of the policies are unset, then they retain their current setting.
The information about a user member of the shared content with an appended last seen timestamp.
Basic information about a user. Use users::get_account() and
users::get_account_batch() to obtain more detailed
information.
The information about a user member of the shared content.
Enums
Information about the inheritance policy of a shared folder.
Defines the access levels for collaborators.
Who can change a shared folder’s access control list (ACL). In other words, who can add, remove, or change the privileges of members.
Errors for add_file_member().
check documentation for ResolvedVisibility.
Sharing actions that may be taken on files.
Actions that may be taken on shared folders.
Error result for get_file_metadata().
Information about the recipient of a shared content invitation.
Error occurred while performing an asynchronous job from unshare_folder() or
remove_folder_member().
Actions that can be performed on a link.
check documentation for VisibilityPolicyDisallowedReason.
Metadata for a shared link. This can be either a PathLinkMetadata or
CollectionLinkMetadata.
Error for list_file_members_continue().
Error for list_file_members().
Error results for list_received_files_continue().
Actions that may be taken on members of a shared folder.
Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.
Includes different ways to identify a member of a shared folder.
Flag to indicate pending upload default (for linking to not-yet-existing paths).
Possible reasons the user is denied a permission.
Errors for remove_file_member_2().
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.
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.
There is an error accessing the shared folder.
The metadata of a shared link.
Who can view shared links in this folder.
User could not access this file.
User account had a problem preventing this action.
Error result for unshare_file().
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
Adds specified members to a file.
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.
Returns the status of an asynchronous job.
Returns the status of an asynchronous job for sharing a folder.
Returns the status of an asynchronous job for sharing a folder.
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 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).
Returns shared file metadata.
Returns shared file metadata.
Returns shared folder metadata by its folder ID.
Download the shared link’s file from a user’s Dropbox.
Get the shared link’s metadata.
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.
Use to obtain the members who have been invited to a file, both inherited and uninherited members.
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.
Once a cursor has been retrieved from list_file_members() or
list_file_members_batch(), use this to paginate through all shared
file members.
Returns shared folder membership by its folder ID.
Once a cursor has been retrieved from list_folder_members(), use this
to paginate through all shared folder members.
Return the list of all shared folders the current user has access to.
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().
Return the list of all shared folders the current user can mount or unmount.
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().
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.
Get more results with a cursor from list_received_files().
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.
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.
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.
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.
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.
Identical to remove_file_member_2 but with less information returned.
Removes a specified member from the file.
Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.
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.
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 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 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.
The current user unmounts the designated folder. They can re-mount the folder at a later time
using mount_folder().
Remove all members from this file. Does not remove inherited members.
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.
Changes a member’s access on a shared file.
Allows an owner or editor of a shared folder to update another member’s permissions.
Update the sharing policies for a shared folder. User must have
AccessLevel::Owner access to the shared folder to update its policies.