Module sharing

Available on crate feature dbx_sharing only.

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.

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().

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.

LinkAudienceOption

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.

VisibilityPolicy

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

AlphaResolvedVisibility

check documentation for ResolvedVisibility.

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

LinkAudienceDisallowedReason

check documentation for VisibilityPolicyDisallowedReason.

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.

VisibilityPolicyDisallowedReason

Type Aliases

DropboxId

GetSharedLinkFileArg

Id

Path

PathOrId

ReadPath

Rev

TeamInfo