`dropbox.sharing` – Sharing

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

class dropbox.sharing.AccessInheritance(tag, value=None)

Bases: Union

Information about the inheritance policy of a shared folder.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.AccessInheritance.inherit – The shared folder inherits its members from the parent folder.
sharing.AccessInheritance.no_inherit – The shared folder does not inherit its members from the parent folder.

inherit = AccessInheritance('inherit', None)

is_inherit()

Check if the union tag is inherit.

Return type:: bool

is_no_inherit()

Check if the union tag is no_inherit.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

no_inherit = AccessInheritance('no_inherit', None)

other = AccessInheritance('other', None)

class dropbox.sharing.AccessLevel(tag, value=None)

Bases: Union

Defines the access levels for collaborators.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.AccessLevel.owner – The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder’s policies using dropbox.dropbox_client.Dropbox.sharing_update_folder_policy().
sharing.AccessLevel.editor – The collaborator can both view and edit the shared folder.
sharing.AccessLevel.viewer – The collaborator can only view the shared folder.
sharing.AccessLevel.viewer_no_comment – The collaborator can only view the shared folder and does not have any access to comments.
sharing.AccessLevel.traverse – The collaborator can only view the shared folder that they have access to.
sharing.AccessLevel.no_access – If there is a Righteous Link on the folder which grants access and the user has visited such link, they are allowed to perform certain action (i.e. add themselves to the folder) via the link access even though the user themselves are not a member on the shared folder yet.

editor = AccessLevel('editor', None)

is_editor()

Check if the union tag is editor.

Return type:: bool

is_no_access()

Check if the union tag is no_access.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_owner()

Check if the union tag is owner.

Return type:: bool

is_traverse()

Check if the union tag is traverse.

Return type:: bool

is_viewer()

Check if the union tag is viewer.

Return type:: bool

is_viewer_no_comment()

Check if the union tag is viewer_no_comment.

Return type:: bool

no_access = AccessLevel('no_access', None)

other = AccessLevel('other', None)

owner = AccessLevel('owner', None)

traverse = AccessLevel('traverse', None)

viewer = AccessLevel('viewer', None)

viewer_no_comment = AccessLevel('viewer_no_comment', None)

class dropbox.sharing.AclUpdatePolicy(tag, value=None)

Bases: Union

Who can change a shared folder’s access control list (ACL). In other words, who can add, remove, or change the privileges of members.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.AclUpdatePolicy.owner – Only the owner can update the ACL.
sharing.AclUpdatePolicy.editors – Any editor can update the ACL. This may be further restricted to editors on the same team.

editors = AclUpdatePolicy('editors', None)

is_editors()

Check if the union tag is editors.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_owner()

Check if the union tag is owner.

Return type:: bool

other = AclUpdatePolicy('other', None)

owner = AclUpdatePolicy('owner', None)

class dropbox.sharing.AddFileMemberArgs(file=None, members=None, custom_message=None, quiet=None, access_level=None, add_message_as_comment=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_add_file_member().

Variables:

sharing.AddFileMemberArgs.file – File to which to add members.
sharing.AddFileMemberArgs.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.
sharing.AddFileMemberArgs.custom_message – Message to send to added members in their invitation.
sharing.AddFileMemberArgs.quiet – Whether added members should be notified via email and device notifications of their invitation.
sharing.AddFileMemberArgs.access_level – AccessLevel union object, describing what access level we want to give new members.
sharing.AddFileMemberArgs.add_message_as_comment – If the custom message should be added as a comment on the file.

__init__(file=None, members=None, custom_message=None, quiet=None, access_level=None, add_message_as_comment=None)

access_level

add_message_as_comment

custom_message

file

members

quiet

class dropbox.sharing.AddFileMemberError(tag, value=None)

Bases: Union

Errors for dropbox.dropbox_client.Dropbox.sharing_add_file_member().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.AddFileMemberError.rate_limit – The user has reached the rate limit for invitations.
sharing.AddFileMemberError.invalid_comment – The custom message did not pass comment permissions checks.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: AddFileMemberError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_user_error()

Only call this if is_user_error() is true.

Return type:: SharingUserError

invalid_comment = AddFileMemberError('invalid_comment', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_invalid_comment()

Check if the union tag is invalid_comment.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_rate_limit()

Check if the union tag is rate_limit.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

other = AddFileMemberError('other', None)

rate_limit = AddFileMemberError('rate_limit', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: AddFileMemberError

class dropbox.sharing.AddFolderMemberArg(shared_folder_id=None, members=None, quiet=None, custom_message=None)

Bases: Struct

Variables:

sharing.AddFolderMemberArg.shared_folder_id – The ID for the shared folder.
sharing.AddFolderMemberArg.members – The intended list of members to add. Added members will receive invites to join the shared folder.
sharing.AddFolderMemberArg.quiet – Whether added members should be notified via email and device notifications of their invite.
sharing.AddFolderMemberArg.custom_message – Optional message to display to added members in their invitation.

__init__(shared_folder_id=None, members=None, quiet=None, custom_message=None)

custom_message

members

quiet

shared_folder_id

class dropbox.sharing.AddFolderMemberError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

AddFolderMemberError.access_error (SharedFolderAccessError) – Unable to access shared folder.
sharing.AddFolderMemberError.email_unverified – This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.
sharing.AddFolderMemberError.banned_member – The current user has been banned.
AddFolderMemberError.bad_member (AddMemberSelectorError) – AddFolderMemberArg.members contains a bad invitation recipient.
sharing.AddFolderMemberError.cant_share_outside_team – Your team policy does not allow sharing outside of the team.
sharing.AddFolderMemberError.too_many_members (int) – The value is the member limit that was reached.
sharing.AddFolderMemberError.too_many_pending_invites (int) – The value is the pending invite limit that was reached.
sharing.AddFolderMemberError.rate_limit – The current user has hit the limit of invites they can send per day. Try again in 24 hours.
sharing.AddFolderMemberError.too_many_invitees – The current user is trying to share with too many people at once.
sharing.AddFolderMemberError.insufficient_plan – The current user’s account doesn’t support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan.
sharing.AddFolderMemberError.team_folder – This action cannot be performed on a team shared folder.
sharing.AddFolderMemberError.no_permission – The current user does not have permission to perform this action.
sharing.AddFolderMemberError.invalid_shared_folder – Invalid shared folder error will be returned as an access_error.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: AddFolderMemberError

classmethod bad_member(val)

Create an instance of this class set to the bad_member tag with value val.

Parameters:: val (AddMemberSelectorError) –
Return type:: AddFolderMemberError

banned_member = AddFolderMemberError('banned_member', None)

cant_share_outside_team = AddFolderMemberError('cant_share_outside_team', None)

email_unverified = AddFolderMemberError('email_unverified', None)

get_access_error()

Unable to access shared folder.

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

get_bad_member()

AddFolderMemberArg.members contains a bad invitation recipient.

Only call this if is_bad_member() is true.

Return type:: AddMemberSelectorError

get_too_many_members()

The value is the member limit that was reached.

Only call this if is_too_many_members() is true.

Return type:: int

get_too_many_pending_invites()

The value is the pending invite limit that was reached.

Only call this if is_too_many_pending_invites() is true.

Return type:: int

insufficient_plan = AddFolderMemberError('insufficient_plan', None)

invalid_shared_folder = AddFolderMemberError('invalid_shared_folder', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_bad_member()

Check if the union tag is bad_member.

Return type:: bool

is_banned_member()

Check if the union tag is banned_member.

Return type:: bool

is_cant_share_outside_team()

Check if the union tag is cant_share_outside_team.

Return type:: bool

is_email_unverified()

Check if the union tag is email_unverified.

Return type:: bool

is_insufficient_plan()

Check if the union tag is insufficient_plan.

Return type:: bool

is_invalid_shared_folder()

Check if the union tag is invalid_shared_folder.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_rate_limit()

Check if the union tag is rate_limit.

Return type:: bool

is_team_folder()

Check if the union tag is team_folder.

Return type:: bool

is_too_many_invitees()

Check if the union tag is too_many_invitees.

Return type:: bool

is_too_many_members()

Check if the union tag is too_many_members.

Return type:: bool

is_too_many_pending_invites()

Check if the union tag is too_many_pending_invites.

Return type:: bool

no_permission = AddFolderMemberError('no_permission', None)

other = AddFolderMemberError('other', None)

rate_limit = AddFolderMemberError('rate_limit', None)

team_folder = AddFolderMemberError('team_folder', None)

too_many_invitees = AddFolderMemberError('too_many_invitees', None)

classmethod too_many_members(val)

Create an instance of this class set to the too_many_members tag with value val.

Parameters:: val (int) –
Return type:: AddFolderMemberError

classmethod too_many_pending_invites(val)

Create an instance of this class set to the too_many_pending_invites tag with value val.

Parameters:: val (int) –
Return type:: AddFolderMemberError

class dropbox.sharing.AddMember(member=None, access_level=None)

Bases: Struct

The member and type of access the member should have when added to a shared folder.

Variables:

sharing.AddMember.member – The member to add to the shared folder.
sharing.AddMember.access_level – The access level to grant member to the shared folder. AccessLevel.owner is disallowed.

__init__(member=None, access_level=None)

access_level

member

class dropbox.sharing.AddMemberSelectorError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.AddMemberSelectorError.automatic_group – Automatically created groups can only be added to team folders.
sharing.AddMemberSelectorError.invalid_dropbox_id (str) – The value is the ID that could not be identified.
sharing.AddMemberSelectorError.invalid_email (str) – The value is the e-email address that is malformed.
sharing.AddMemberSelectorError.unverified_dropbox_id (str) – The value is the ID of the Dropbox user with an unverified email address. Invite unverified users by email address instead of by their Dropbox ID.
sharing.AddMemberSelectorError.group_deleted – At least one of the specified groups in AddFolderMemberArg.members is deleted.
sharing.AddMemberSelectorError.group_not_on_team – Sharing to a group that is not on the current user’s team.

automatic_group = AddMemberSelectorError('automatic_group', None)

get_invalid_dropbox_id()

The value is the ID that could not be identified.

Only call this if is_invalid_dropbox_id() is true.

Return type:: str

get_invalid_email()

The value is the e-email address that is malformed.

Only call this if is_invalid_email() is true.

Return type:: str

get_unverified_dropbox_id()

The value is the ID of the Dropbox user with an unverified email address. Invite unverified users by email address instead of by their Dropbox ID.

Only call this if is_unverified_dropbox_id() is true.

Return type:: str

group_deleted = AddMemberSelectorError('group_deleted', None)

group_not_on_team = AddMemberSelectorError('group_not_on_team', None)

classmethod invalid_dropbox_id(val)

Create an instance of this class set to the invalid_dropbox_id tag with value val.

Parameters:: val (str) –
Return type:: AddMemberSelectorError

classmethod invalid_email(val)

Create an instance of this class set to the invalid_email tag with value val.

Parameters:: val (str) –
Return type:: AddMemberSelectorError

is_automatic_group()

Check if the union tag is automatic_group.

Return type:: bool

is_group_deleted()

Check if the union tag is group_deleted.

Return type:: bool

is_group_not_on_team()

Check if the union tag is group_not_on_team.

Return type:: bool

is_invalid_dropbox_id()

Check if the union tag is invalid_dropbox_id.

Return type:: bool

is_invalid_email()

Check if the union tag is invalid_email.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_unverified_dropbox_id()

Check if the union tag is unverified_dropbox_id.

Return type:: bool

other = AddMemberSelectorError('other', None)

classmethod unverified_dropbox_id(val)

Create an instance of this class set to the unverified_dropbox_id tag with value val.

Parameters:: val (str) –
Return type:: AddMemberSelectorError

class dropbox.sharing.AlphaResolvedVisibility(tag, value=None)

Bases: ResolvedVisibility

check documentation for ResolvedVisibility.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.sharing.AudienceExceptionContentInfo(name=None)

Bases: Struct

Information about the content that has a link audience different than that of this folder.

Variables:: sharing.AudienceExceptionContentInfo.name – The name of the content, which is either a file or a folder.

__init__(name=None)

name

class dropbox.sharing.AudienceExceptions(count=None, exceptions=None)

Bases: Struct

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.

Variables:: sharing.AudienceExceptions.exceptions – A truncated list of some of the content that is an exception. The length of this list could be smaller than the count since it is only a sample but will not be empty as long as count is not 0.

__init__(count=None, exceptions=None)

count

exceptions

class dropbox.sharing.AudienceRestrictingSharedFolder(shared_folder_id=None, name=None, audience=None)

Bases: Struct

Information about the shared folder that prevents the link audience for this link from being more restrictive.

Variables:

sharing.AudienceRestrictingSharedFolder.shared_folder_id – The ID of the shared folder.
sharing.AudienceRestrictingSharedFolder.name – The name of the shared folder.
sharing.AudienceRestrictingSharedFolder.audience – The link audience of the shared folder.

__init__(shared_folder_id=None, name=None, audience=None)

audience

name

shared_folder_id

class dropbox.sharing.CollectionLinkMetadata(url=None, visibility=None, expires=None)

Bases: LinkMetadata

Metadata for a collection-based shared link.

__init__(url=None, visibility=None, expires=None)

class dropbox.sharing.CreateSharedLinkArg(path=None, short_url=None, pending_upload=None)

Bases: Struct

Variables:

sharing.CreateSharedLinkArg.path – The path to share.
sharing.CreateSharedLinkArg.pending_upload – If it’s okay to share a path that does not yet exist, set this to either PendingUploadMode.file or PendingUploadMode.folder to indicate whether to assume it’s a file or folder.

__init__(path=None, short_url=None, pending_upload=None)

path

pending_upload

short_url

class dropbox.sharing.CreateSharedLinkError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:: files.LookupError

is_other()

Check if the union tag is other.

Return type:: bool

is_path()

Check if the union tag is path.

Return type:: bool

other = CreateSharedLinkError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:: val (files.LookupError) –
Return type:: CreateSharedLinkError

class dropbox.sharing.CreateSharedLinkWithSettingsArg(path=None, settings=None)

Bases: Struct

Variables:

sharing.CreateSharedLinkWithSettingsArg.path – The path to be shared by the shared link.
sharing.CreateSharedLinkWithSettingsArg.settings – The requested settings for the newly created shared link.

__init__(path=None, settings=None)

path

settings

class dropbox.sharing.CreateSharedLinkWithSettingsError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.CreateSharedLinkWithSettingsError.email_not_verified –

This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.

:ivar Optional[SharedLinkAlreadyExistsMetadata]: sharing.CreateSharedLinkWithSettingsError.shared_link_already_exists: The shared link already exists. You can call :route:`list_shared_links` to get the existing link, or use the provided metadata if it is returned.
:ivar SharedLinkSettingsError: CreateSharedLinkWithSettingsError.settings_error: There is an error with the given settings.

Variables:: sharing.CreateSharedLinkWithSettingsError.access_denied – The user is not allowed to create a shared link to the specified file. For example, this can occur if the file is restricted or if the user’s links are banned.

access_denied = CreateSharedLinkWithSettingsError('access_denied', None)

email_not_verified = CreateSharedLinkWithSettingsError('email_not_verified', None)

get_path()

Only call this if is_path() is true.

Return type:: files.LookupError

get_settings_error()

There is an error with the given settings.

Only call this if is_settings_error() is true.

Return type:: SharedLinkSettingsError

get_shared_link_already_exists()

The shared link already exists. You can call dropbox.dropbox_client.Dropbox.sharing_list_shared_links() to get the existing link, or use the provided metadata if it is returned.

Only call this if is_shared_link_already_exists() is true.

Return type:: SharedLinkAlreadyExistsMetadata

is_access_denied()

Check if the union tag is access_denied.

Return type:: bool

is_email_not_verified()

Check if the union tag is email_not_verified.

Return type:: bool

is_path()

Check if the union tag is path.

Return type:: bool

is_settings_error()

Check if the union tag is settings_error.

Return type:: bool

is_shared_link_already_exists()

Check if the union tag is shared_link_already_exists.

Return type:: bool

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:: val (files.LookupError) –
Return type:: CreateSharedLinkWithSettingsError

classmethod settings_error(val)

Create an instance of this class set to the settings_error tag with value val.

Parameters:: val (SharedLinkSettingsError) –
Return type:: CreateSharedLinkWithSettingsError

classmethod shared_link_already_exists(val)

Create an instance of this class set to the shared_link_already_exists tag with value val.

Parameters:: val (SharedLinkAlreadyExistsMetadata) –
Return type:: CreateSharedLinkWithSettingsError

class dropbox.sharing.ExpectedSharedContentLinkMetadata(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

Bases: SharedContentLinkMetadataBase

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.

__init__(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

class dropbox.sharing.FileAction(tag, value=None)

Bases: Union

Sharing actions that may be taken on files.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.FileAction.disable_viewer_info – Disable viewer information on the file.
sharing.FileAction.edit_contents – Change or edit contents of the file.
sharing.FileAction.enable_viewer_info – Enable viewer information on the file.
sharing.FileAction.invite_viewer – Add a member with view permissions.
sharing.FileAction.invite_viewer_no_comment – Add a member with view permissions but no comment permissions.
sharing.FileAction.invite_editor – Add a member with edit permissions.
sharing.FileAction.unshare – Stop sharing this file.
sharing.FileAction.relinquish_membership – Relinquish one’s own membership to the file.
sharing.FileAction.share_link – Use create_view_link and create_edit_link instead.
sharing.FileAction.create_link – Use create_view_link and create_edit_link instead.
sharing.FileAction.create_view_link – Create a shared link to a file that only allows users to view the content.
sharing.FileAction.create_edit_link – Create a shared link to a file that allows users to edit the content.

create_edit_link = FileAction('create_edit_link', None)

create_link = FileAction('create_link', None)

create_view_link = FileAction('create_view_link', None)

disable_viewer_info = FileAction('disable_viewer_info', None)

edit_contents = FileAction('edit_contents', None)

enable_viewer_info = FileAction('enable_viewer_info', None)

invite_editor = FileAction('invite_editor', None)

invite_viewer = FileAction('invite_viewer', None)

invite_viewer_no_comment = FileAction('invite_viewer_no_comment', None)

is_create_edit_link()

Check if the union tag is create_edit_link.

Return type:: bool

is_create_link()

Check if the union tag is create_link.

Return type:: bool

is_create_view_link()

Check if the union tag is create_view_link.

Return type:: bool

is_disable_viewer_info()

Check if the union tag is disable_viewer_info.

Return type:: bool

is_edit_contents()

Check if the union tag is edit_contents.

Return type:: bool

is_enable_viewer_info()

Check if the union tag is enable_viewer_info.

Return type:: bool

is_invite_editor()

Check if the union tag is invite_editor.

Return type:: bool

is_invite_viewer()

Check if the union tag is invite_viewer.

Return type:: bool

is_invite_viewer_no_comment()

Check if the union tag is invite_viewer_no_comment.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_relinquish_membership()

Check if the union tag is relinquish_membership.

Return type:: bool

is_share_link()

Check if the union tag is share_link.

Return type:: bool

is_unshare()

Check if the union tag is unshare.

Return type:: bool

other = FileAction('other', None)

relinquish_membership = FileAction('relinquish_membership', None)

share_link = FileAction('share_link', None)

unshare = FileAction('unshare', None)

class dropbox.sharing.FileErrorResult(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.FileErrorResult.file_not_found_error (str) – File specified by id was not found.
sharing.FileErrorResult.invalid_file_action_error (str) – User does not have permission to take the specified action on the file.
sharing.FileErrorResult.permission_denied_error (str) – User does not have permission to access file specified by file.Id.

classmethod file_not_found_error(val)

Create an instance of this class set to the file_not_found_error tag with value val.

Parameters:: val (str) –
Return type:: FileErrorResult

get_file_not_found_error()

File specified by id was not found.

Only call this if is_file_not_found_error() is true.

Return type:: str

get_invalid_file_action_error()

User does not have permission to take the specified action on the file.

Only call this if is_invalid_file_action_error() is true.

Return type:: str

get_permission_denied_error()

User does not have permission to access file specified by file.Id.

Only call this if is_permission_denied_error() is true.

Return type:: str

classmethod invalid_file_action_error(val)

Create an instance of this class set to the invalid_file_action_error tag with value val.

Parameters:: val (str) –
Return type:: FileErrorResult

is_file_not_found_error()

Check if the union tag is file_not_found_error.

Return type:: bool

is_invalid_file_action_error()

Check if the union tag is invalid_file_action_error.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_permission_denied_error()

Check if the union tag is permission_denied_error.

Return type:: bool

other = FileErrorResult('other', None)

classmethod permission_denied_error(val)

Create an instance of this class set to the permission_denied_error tag with value val.

Parameters:: val (str) –
Return type:: FileErrorResult

class dropbox.sharing.FileLinkMetadata(url=None, name=None, link_permissions=None, client_modified=None, server_modified=None, rev=None, size=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

Bases: SharedLinkMetadata

The metadata of a file shared link.

Variables:

sharing.FileLinkMetadata.client_modified – The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
sharing.FileLinkMetadata.server_modified – The last time the file was modified on Dropbox.
sharing.FileLinkMetadata.rev – A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
sharing.FileLinkMetadata.size – The file size in bytes.

__init__(url=None, name=None, link_permissions=None, client_modified=None, server_modified=None, rev=None, size=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

client_modified

rev

server_modified

size

class dropbox.sharing.FileMemberActionError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.FileMemberActionError.invalid_member – Specified member was not found.
sharing.FileMemberActionError.no_permission – User does not have permission to perform this action on this member.
FileMemberActionError.access_error (SharingFileAccessError) – Specified file was invalid or user does not have access.
FileMemberActionError.no_explicit_access (MemberAccessLevelResult) – The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: FileMemberActionError

get_access_error()

Specified file was invalid or user does not have access.

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_no_explicit_access()

The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

Only call this if is_no_explicit_access() is true.

Return type:: MemberAccessLevelResult

invalid_member = FileMemberActionError('invalid_member', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_invalid_member()

Check if the union tag is invalid_member.

Return type:: bool

is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

classmethod no_explicit_access(val)

Create an instance of this class set to the no_explicit_access tag with value val.

Parameters:: val (MemberAccessLevelResult) –
Return type:: FileMemberActionError

no_permission = FileMemberActionError('no_permission', None)

other = FileMemberActionError('other', None)

class dropbox.sharing.FileMemberActionIndividualResult(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

:ivar Optional[AccessLevel]: sharing.FileMemberActionIndividualResult.success: Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.

Variables:: FileMemberActionIndividualResult.member_error (FileMemberActionError) – User was not able to perform this action.

get_member_error()

User was not able to perform this action.

Only call this if is_member_error() is true.

Return type:: FileMemberActionError

get_success()

Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder.

Only call this if is_success() is true.

Return type:: AccessLevel

is_member_error()

Check if the union tag is member_error.

Return type:: bool

is_success()

Check if the union tag is success.

Return type:: bool

classmethod member_error(val)

Create an instance of this class set to the member_error tag with value val.

Parameters:: val (FileMemberActionError) –
Return type:: FileMemberActionIndividualResult

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:: val (AccessLevel) –
Return type:: FileMemberActionIndividualResult

class dropbox.sharing.FileMemberActionResult(member=None, result=None, sckey_sha1=None, invitation_signature=None)

Bases: Struct

Per-member result for dropbox.dropbox_client.Dropbox.sharing_add_file_member().

Variables:

sharing.FileMemberActionResult.member – One of specified input members.
sharing.FileMemberActionResult.result – The outcome of the action on this member.
sharing.FileMemberActionResult.sckey_sha1 – The SHA-1 encrypted shared content key.
sharing.FileMemberActionResult.invitation_signature – The sharing sender-recipient invitation signatures for the input member_id. A member_id can be a group and thus have multiple users and multiple invitation signatures.

__init__(member=None, result=None, sckey_sha1=None, invitation_signature=None)

invitation_signature

member

result

sckey_sha1

class dropbox.sharing.FileMemberRemoveActionResult(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

FileMemberRemoveActionResult.success (MemberAccessLevelResult) – Member was successfully removed from this file.
FileMemberRemoveActionResult.member_error (FileMemberActionError) – User was not able to remove this member.

get_member_error()

User was not able to remove this member.

Only call this if is_member_error() is true.

Return type:: FileMemberActionError

get_success()

Member was successfully removed from this file.

Only call this if is_success() is true.

Return type:: MemberAccessLevelResult

is_member_error()

Check if the union tag is member_error.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_success()

Check if the union tag is success.

Return type:: bool

classmethod member_error(val)

Create an instance of this class set to the member_error tag with value val.

Parameters:: val (FileMemberActionError) –
Return type:: FileMemberRemoveActionResult

other = FileMemberRemoveActionResult('other', None)

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:: val (MemberAccessLevelResult) –
Return type:: FileMemberRemoveActionResult

class dropbox.sharing.FilePermission(action=None, allow=None, reason=None)

Bases: Struct

Whether the user is allowed to take the sharing action on the file.

Variables:

sharing.FilePermission.action – The action that the user may wish to take on the file.
sharing.FilePermission.allow – True if the user is allowed to take the action.
sharing.FilePermission.reason – The reason why the user is denied the permission. Not present if the action is allowed.

__init__(action=None, allow=None, reason=None)

action

allow

reason

class dropbox.sharing.FolderAction(tag, value=None)

Bases: Union

Actions that may be taken on shared folders.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.FolderAction.change_options – Change folder options, such as who can be invited to join the folder.
sharing.FolderAction.disable_viewer_info – Disable viewer information for this folder.
sharing.FolderAction.edit_contents – Change or edit contents of the folder.
sharing.FolderAction.enable_viewer_info – Enable viewer information on the folder.
sharing.FolderAction.invite_editor – Invite a user or group to join the folder with read and write permission.
sharing.FolderAction.invite_viewer – Invite a user or group to join the folder with read permission.
sharing.FolderAction.invite_viewer_no_comment – Invite a user or group to join the folder with read permission but no comment permissions.
sharing.FolderAction.relinquish_membership – Relinquish one’s own membership in the folder.
sharing.FolderAction.unmount – Unmount the folder.
sharing.FolderAction.unshare – Stop sharing this folder.
sharing.FolderAction.leave_a_copy – Keep a copy of the contents upon leaving or being kicked from the folder.
sharing.FolderAction.share_link – Use create_link instead.
sharing.FolderAction.create_link – Create a shared link for folder.
sharing.FolderAction.set_access_inheritance – Set whether the folder inherits permissions from its parent.

change_options = FolderAction('change_options', None)

create_link = FolderAction('create_link', None)

disable_viewer_info = FolderAction('disable_viewer_info', None)

edit_contents = FolderAction('edit_contents', None)

enable_viewer_info = FolderAction('enable_viewer_info', None)

invite_editor = FolderAction('invite_editor', None)

invite_viewer = FolderAction('invite_viewer', None)

invite_viewer_no_comment = FolderAction('invite_viewer_no_comment', None)

is_change_options()

Check if the union tag is change_options.

Return type:: bool

is_create_link()

Check if the union tag is create_link.

Return type:: bool

is_disable_viewer_info()

Check if the union tag is disable_viewer_info.

Return type:: bool

is_edit_contents()

Check if the union tag is edit_contents.

Return type:: bool

is_enable_viewer_info()

Check if the union tag is enable_viewer_info.

Return type:: bool

is_invite_editor()

Check if the union tag is invite_editor.

Return type:: bool

is_invite_viewer()

Check if the union tag is invite_viewer.

Return type:: bool

is_invite_viewer_no_comment()

Check if the union tag is invite_viewer_no_comment.

Return type:: bool

is_leave_a_copy()

Check if the union tag is leave_a_copy.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_relinquish_membership()

Check if the union tag is relinquish_membership.

Return type:: bool

is_set_access_inheritance()

Check if the union tag is set_access_inheritance.

Return type:: bool

is_share_link()

Check if the union tag is share_link.

Return type:: bool

is_unmount()

Check if the union tag is unmount.

Return type:: bool

is_unshare()

Check if the union tag is unshare.

Return type:: bool

leave_a_copy = FolderAction('leave_a_copy', None)

other = FolderAction('other', None)

relinquish_membership = FolderAction('relinquish_membership', None)

set_access_inheritance = FolderAction('set_access_inheritance', None)

share_link = FolderAction('share_link', None)

unmount = FolderAction('unmount', None)

unshare = FolderAction('unshare', None)

class dropbox.sharing.FolderLinkMetadata(url=None, name=None, link_permissions=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

Bases: SharedLinkMetadata

The metadata of a folder shared link.

__init__(url=None, name=None, link_permissions=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

class dropbox.sharing.FolderPermission(action=None, allow=None, reason=None)

Bases: Struct

Whether the user is allowed to take the action on the shared folder.

Variables:

sharing.FolderPermission.action – The action that the user may wish to take on the folder.
sharing.FolderPermission.allow – True if the user is allowed to take the action.
sharing.FolderPermission.reason – The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available.

__init__(action=None, allow=None, reason=None)

action

allow

reason

class dropbox.sharing.FolderPolicy(acl_update_policy=None, shared_link_policy=None, member_policy=None, resolved_member_policy=None, viewer_info_policy=None)

Bases: Struct

A set of policies governing membership and privileges for a shared folder.

Variables:

sharing.FolderPolicy.member_policy – Who can be a member of this shared folder, as set on the folder itself. The effective policy may differ from this value if the team-wide policy is more restrictive. Present only if the folder is owned by a team.
sharing.FolderPolicy.resolved_member_policy – Who can be a member of this shared folder, taking into account both the folder and the team-wide policy. This value may differ from that of member_policy if the team-wide policy is more restrictive than the folder policy. Present only if the folder is owned by a team.
sharing.FolderPolicy.acl_update_policy – Who can add and remove members from this shared folder.
sharing.FolderPolicy.shared_link_policy – Who links can be shared with.
sharing.FolderPolicy.viewer_info_policy – Who can enable/disable viewer info for this shared folder.

__init__(acl_update_policy=None, shared_link_policy=None, member_policy=None, resolved_member_policy=None, viewer_info_policy=None)

acl_update_policy

member_policy

resolved_member_policy

shared_link_policy

viewer_info_policy

class dropbox.sharing.GetFileMetadataArg(file=None, actions=None)

Bases: Struct

Arguments of dropbox.dropbox_client.Dropbox.sharing_get_file_metadata().

Variables:

sharing.GetFileMetadataArg.file – The file to query.
sharing.GetFileMetadataArg.actions – A list of FileAction`s corresponding to `FilePermission`s that should appear in the response’s ``SharedFileMetadata.permissions` field describing the actions the authenticated user can perform on the file.

__init__(file=None, actions=None)

actions

file

class dropbox.sharing.GetFileMetadataBatchArg(files=None, actions=None)

Bases: Struct

Arguments of dropbox.dropbox_client.Dropbox.sharing_get_file_metadata_batch().

Variables:

sharing.GetFileMetadataBatchArg.files – The files to query.
sharing.GetFileMetadataBatchArg.actions – A list of FileAction`s corresponding to `FilePermission`s that should appear in the response’s ``SharedFileMetadata.permissions` field describing the actions the authenticated user can perform on the file.

__init__(files=None, actions=None)

actions

files

class dropbox.sharing.GetFileMetadataBatchResult(file=None, result=None)

Bases: Struct

Per file results of dropbox.dropbox_client.Dropbox.sharing_get_file_metadata_batch().

Variables:

sharing.GetFileMetadataBatchResult.file – This is the input file identifier corresponding to one of GetFileMetadataBatchArg.files.
sharing.GetFileMetadataBatchResult.result – The result for this particular file.

__init__(file=None, result=None)

file

result

class dropbox.sharing.GetFileMetadataError(tag, value=None)

Bases: Union

Error result for dropbox.dropbox_client.Dropbox.sharing_get_file_metadata().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: GetFileMetadataError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_user_error()

Only call this if is_user_error() is true.

Return type:: SharingUserError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

other = GetFileMetadataError('other', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: GetFileMetadataError

class dropbox.sharing.GetFileMetadataIndividualResult(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

GetFileMetadataIndividualResult.metadata (SharedFileMetadata) – The result for this file if it was successful.
GetFileMetadataIndividualResult.access_error (SharingFileAccessError) – The result for this file if it was an error.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: GetFileMetadataIndividualResult

get_access_error()

The result for this file if it was an error.

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_metadata()

The result for this file if it was successful.

Only call this if is_metadata() is true.

Return type:: SharedFileMetadata

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_metadata()

Check if the union tag is metadata.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

classmethod metadata(val)

Create an instance of this class set to the metadata tag with value val.

Parameters:: val (SharedFileMetadata) –
Return type:: GetFileMetadataIndividualResult

other = GetFileMetadataIndividualResult('other', None)

class dropbox.sharing.GetMetadataArgs(shared_folder_id=None, actions=None)

Bases: Struct

Variables:

sharing.GetMetadataArgs.shared_folder_id – The ID for the shared folder.
sharing.GetMetadataArgs.actions – A list of FolderAction`s corresponding to `FolderPermission`s that should appear in the response’s ``SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder.

__init__(shared_folder_id=None, actions=None)

actions

shared_folder_id

dropbox.sharing.GetSharedLinkFileArg: alias of GetSharedLinkMetadataArg

class dropbox.sharing.GetSharedLinkFileError(tag, value=None)

Bases: SharedLinkError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.GetSharedLinkFileError.shared_link_is_directory – Directories cannot be retrieved by this endpoint.

is_shared_link_is_directory()

Check if the union tag is shared_link_is_directory.

Return type:: bool

shared_link_is_directory = GetSharedLinkFileError('shared_link_is_directory', None)

class dropbox.sharing.GetSharedLinkMetadataArg(url=None, path=None, link_password=None)

Bases: Struct

Variables:

sharing.GetSharedLinkMetadataArg.url – URL of the shared link.
sharing.GetSharedLinkMetadataArg.path – If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
sharing.GetSharedLinkMetadataArg.link_password – If the shared link has a password, this parameter can be used.

__init__(url=None, path=None, link_password=None)

link_password

path

url

class dropbox.sharing.GetSharedLinksArg(path=None)

Bases: Struct

Variables:: sharing.GetSharedLinksArg.path – See dropbox.dropbox_client.Dropbox.sharing_get_shared_links() description.

__init__(path=None)

path

class dropbox.sharing.GetSharedLinksError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:: Optional[str]

is_other()

Check if the union tag is other.

Return type:: bool

is_path()

Check if the union tag is path.

Return type:: bool

other = GetSharedLinksError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:: val (Optional[str]) –
Return type:: GetSharedLinksError

class dropbox.sharing.GetSharedLinksResult(links=None)

Bases: Struct

Variables:: sharing.GetSharedLinksResult.links – Shared links applicable to the path argument.

__init__(links=None)

links

class dropbox.sharing.GroupInfo(group_name=None, group_id=None, group_management_type=None, group_type=None, is_member=None, is_owner=None, same_team=None, group_external_id=None, member_count=None)

Bases: GroupSummary

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.

Variables:

sharing.GroupInfo.group_type – The type of group.
sharing.GroupInfo.is_member – If the current user is a member of the group.
sharing.GroupInfo.is_owner – If the current user is an owner of the group.
sharing.GroupInfo.same_team – If the group is owned by the current user’s team.

__init__(group_name=None, group_id=None, group_management_type=None, group_type=None, is_member=None, is_owner=None, same_team=None, group_external_id=None, member_count=None)

group_type

is_member

is_owner

same_team

class dropbox.sharing.GroupMembershipInfo(access_type=None, group=None, permissions=None, initials=None, is_inherited=None)

Bases: MembershipInfo

The information about a group member of the shared content.

Variables:: sharing.GroupMembershipInfo.group – The information about the membership group.

__init__(access_type=None, group=None, permissions=None, initials=None, is_inherited=None)

group

class dropbox.sharing.InsufficientPlan(message=None, upsell_url=None)

Bases: Struct

Variables:

sharing.InsufficientPlan.message – A message to tell the user to upgrade in order to support expected action.
sharing.InsufficientPlan.upsell_url – A URL to send the user to in order to obtain the account type they need, e.g. upgrading. Absent if there is no action the user can take to upgrade.

__init__(message=None, upsell_url=None)

message

upsell_url

class dropbox.sharing.InsufficientQuotaAmounts(space_needed=None, space_shortage=None, space_left=None)

Bases: Struct

Variables:

sharing.InsufficientQuotaAmounts.space_needed – The amount of space needed to add the item (the size of the item).
sharing.InsufficientQuotaAmounts.space_shortage – The amount of extra space needed to add the item.
sharing.InsufficientQuotaAmounts.space_left – The amount of space left in the user’s Dropbox, less than space_needed.

__init__(space_needed=None, space_shortage=None, space_left=None)

space_left

space_needed

space_shortage

class dropbox.sharing.InviteeInfo(tag, value=None)

Bases: Union

Information about the recipient of a shared content invitation.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.InviteeInfo.email (str) – Email address of invited user.

classmethod email(val)

Create an instance of this class set to the email tag with value val.

Parameters:: val (str) –
Return type:: InviteeInfo

get_email()

Email address of invited user.

Only call this if is_email() is true.

Return type:: str

is_email()

Check if the union tag is email.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

other = InviteeInfo('other', None)

class dropbox.sharing.InviteeMembershipInfo(access_type=None, invitee=None, permissions=None, initials=None, is_inherited=None, user=None)

Bases: MembershipInfo

Information about an invited member of a shared content.

Variables:

sharing.InviteeMembershipInfo.invitee – Recipient of the invitation.
sharing.InviteeMembershipInfo.user – The user this invitation is tied to, if available.

__init__(access_type=None, invitee=None, permissions=None, initials=None, is_inherited=None, user=None)

invitee

user

class dropbox.sharing.JobError(tag, value=None)

Bases: Union

Error occurred while performing an asynchronous job from dropbox.dropbox_client.Dropbox.sharing_unshare_folder() or dropbox.dropbox_client.Dropbox.sharing_remove_folder_member().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

JobError.unshare_folder_error (UnshareFolderError) – Error occurred while performing dropbox.dropbox_client.Dropbox.sharing_unshare_folder() action.
JobError.remove_folder_member_error (RemoveFolderMemberError) – Error occurred while performing dropbox.dropbox_client.Dropbox.sharing_remove_folder_member() action.

:ivar RelinquishFolderMembershipError: JobError.relinquish_folder_membership_error: Error occurred while performing dropbox.dropbox_client.Dropbox.sharing_relinquish_folder_membership() action.

get_relinquish_folder_membership_error()

Error occurred while performing dropbox.dropbox_client.Dropbox.sharing_relinquish_folder_membership() action.

Only call this if is_relinquish_folder_membership_error() is true.

Return type:: RelinquishFolderMembershipError

get_remove_folder_member_error()

Error occurred while performing dropbox.dropbox_client.Dropbox.sharing_remove_folder_member() action.

Only call this if is_remove_folder_member_error() is true.

Return type:: RemoveFolderMemberError

get_unshare_folder_error()

Error occurred while performing dropbox.dropbox_client.Dropbox.sharing_unshare_folder() action.

Only call this if is_unshare_folder_error() is true.

Return type:: UnshareFolderError

is_other()

Check if the union tag is other.

Return type:: bool

is_relinquish_folder_membership_error()

Check if the union tag is relinquish_folder_membership_error.

Return type:: bool

is_remove_folder_member_error()

Check if the union tag is remove_folder_member_error.

Return type:: bool

is_unshare_folder_error()

Check if the union tag is unshare_folder_error.

Return type:: bool

other = JobError('other', None)

classmethod relinquish_folder_membership_error(val)

Create an instance of this class set to the relinquish_folder_membership_error tag with value val.

Parameters:: val (RelinquishFolderMembershipError) –
Return type:: JobError

classmethod remove_folder_member_error(val)

Create an instance of this class set to the remove_folder_member_error tag with value val.

Parameters:: val (RemoveFolderMemberError) –
Return type:: JobError

classmethod unshare_folder_error(val)

Create an instance of this class set to the unshare_folder_error tag with value val.

Parameters:: val (UnshareFolderError) –
Return type:: JobError

class dropbox.sharing.JobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.JobStatus.complete – The asynchronous job has finished.
JobStatus.failed (JobError) – The asynchronous job returned an error.

complete = JobStatus('complete', None)

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:: val (JobError) –
Return type:: JobStatus

get_failed()

The asynchronous job returned an error.

Only call this if is_failed() is true.

Return type:: JobError

is_complete()

Check if the union tag is complete.

Return type:: bool

is_failed()

Check if the union tag is failed.

Return type:: bool

class dropbox.sharing.LinkAccessLevel(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.LinkAccessLevel.viewer – Users who use the link can view and comment on the content.
sharing.LinkAccessLevel.editor – Users who use the link can edit, view and comment on the content.

editor = LinkAccessLevel('editor', None)

is_editor()

Check if the union tag is editor.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_viewer()

Check if the union tag is viewer.

Return type:: bool

other = LinkAccessLevel('other', None)

viewer = LinkAccessLevel('viewer', None)

class dropbox.sharing.LinkAction(tag, value=None)

Bases: Union

Actions that can be performed on a link.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.LinkAction.change_access_level – Change the access level of the link.
sharing.LinkAction.change_audience – Change the audience of the link.
sharing.LinkAction.remove_expiry – Remove the expiry date of the link.
sharing.LinkAction.remove_password – Remove the password of the link.
sharing.LinkAction.set_expiry – Create or modify the expiry date of the link.
sharing.LinkAction.set_password – Create or modify the password of the link.

change_access_level = LinkAction('change_access_level', None)

change_audience = LinkAction('change_audience', None)

is_change_access_level()

Check if the union tag is change_access_level.

Return type:: bool

is_change_audience()

Check if the union tag is change_audience.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_remove_expiry()

Check if the union tag is remove_expiry.

Return type:: bool

is_remove_password()

Check if the union tag is remove_password.

Return type:: bool

is_set_expiry()

Check if the union tag is set_expiry.

Return type:: bool

is_set_password()

Check if the union tag is set_password.

Return type:: bool

other = LinkAction('other', None)

remove_expiry = LinkAction('remove_expiry', None)

remove_password = LinkAction('remove_password', None)

set_expiry = LinkAction('set_expiry', None)

set_password = LinkAction('set_password', None)

class dropbox.sharing.LinkAudience(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.LinkAudience.public – Link is accessible by anyone.
sharing.LinkAudience.team – Link is accessible only by team members.
sharing.LinkAudience.no_one – The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights.
sharing.LinkAudience.password – Use require_password instead. A link-specific password is required to access the link. Login is not required.
sharing.LinkAudience.members – Link is accessible only by members of the content.

is_members()

Check if the union tag is members.

Return type:: bool

is_no_one()

Check if the union tag is no_one.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_password()

Check if the union tag is password.

Return type:: bool

is_public()

Check if the union tag is public.

Return type:: bool

is_team()

Check if the union tag is team.

Return type:: bool

members = LinkAudience('members', None)

no_one = LinkAudience('no_one', None)

other = LinkAudience('other', None)

password = LinkAudience('password', None)

public = LinkAudience('public', None)

team = LinkAudience('team', None)

class dropbox.sharing.LinkAudienceDisallowedReason(tag, value=None)

Bases: VisibilityPolicyDisallowedReason

check documentation for VisibilityPolicyDisallowedReason.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

class dropbox.sharing.LinkAudienceOption(audience=None, allowed=None, disallowed_reason=None)

Bases: Struct

Variables:

sharing.LinkAudienceOption.audience – Specifies who can access the link.
sharing.LinkAudienceOption.allowed – Whether the user calling this API can select this audience option.
sharing.LinkAudienceOption.disallowed_reason – If allowed is False, this will provide the reason that the user is not permitted to set the visibility to this policy.

__init__(audience=None, allowed=None, disallowed_reason=None)

allowed

audience

disallowed_reason

class dropbox.sharing.LinkExpiry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.LinkExpiry.remove_expiry – Remove the currently set expiry for the link.
sharing.LinkExpiry.set_expiry (datetime.datetime) – Set a new expiry or change an existing expiry.

get_set_expiry()

Set a new expiry or change an existing expiry.

Only call this if is_set_expiry() is true.

Return type:: datetime.datetime

is_other()

Check if the union tag is other.

Return type:: bool

is_remove_expiry()

Check if the union tag is remove_expiry.

Return type:: bool

is_set_expiry()

Check if the union tag is set_expiry.

Return type:: bool

other = LinkExpiry('other', None)

remove_expiry = LinkExpiry('remove_expiry', None)

classmethod set_expiry(val)

Create an instance of this class set to the set_expiry tag with value val.

Parameters:: val (datetime.datetime) –
Return type:: LinkExpiry

class dropbox.sharing.LinkMetadata(url=None, visibility=None, expires=None)

Bases: Struct

Metadata for a shared link. This can be either a PathLinkMetadata or CollectionLinkMetadata.

Variables:

sharing.LinkMetadata.url – URL of the shared link.
sharing.LinkMetadata.visibility – Who can access the link.
sharing.LinkMetadata.expires – Expiration time, if set. By default the link won’t expire.

__init__(url=None, visibility=None, expires=None)

expires

url

visibility

class dropbox.sharing.LinkPassword(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.LinkPassword.remove_password – Remove the currently set password for the link.
sharing.LinkPassword.set_password (str) – Set a new password or change an existing password.

get_set_password()

Set a new password or change an existing password.

Only call this if is_set_password() is true.

Return type:: str

is_other()

Check if the union tag is other.

Return type:: bool

is_remove_password()

Check if the union tag is remove_password.

Return type:: bool

is_set_password()

Check if the union tag is set_password.

Return type:: bool

other = LinkPassword('other', None)

remove_password = LinkPassword('remove_password', None)

classmethod set_password(val)

Create an instance of this class set to the set_password tag with value val.

Parameters:: val (str) –
Return type:: LinkPassword

class dropbox.sharing.LinkPermission(action=None, allow=None, reason=None)

Bases: Struct

Permissions for actions that can be performed on a link.

__init__(action=None, allow=None, reason=None)

action

allow

reason

class dropbox.sharing.LinkPermissions(can_revoke=None, visibility_policies=None, can_set_expiry=None, can_remove_expiry=None, allow_download=None, can_allow_download=None, can_disallow_download=None, allow_comments=None, team_restricts_comments=None, resolved_visibility=None, requested_visibility=None, revoke_failure_reason=None, effective_audience=None, link_access_level=None, audience_options=None, can_set_password=None, can_remove_password=None, require_password=None, can_use_extended_sharing_controls=None)

Bases: Struct

Variables:

sharing.LinkPermissions.resolved_visibility – The current visibility of the link after considering the shared links policies of the the team (in case the link’s owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link’s owner always has access to this data). For some links, an effective_audience value is returned instead.
sharing.LinkPermissions.requested_visibility – The shared link’s requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in resolved_visibility. This is shown only if the caller is the link’s owner and resolved_visibility is returned instead of effective_audience.
sharing.LinkPermissions.can_revoke – Whether the caller can revoke the shared link.
sharing.LinkPermissions.revoke_failure_reason – The failure reason for revoking the link. This field will only be present if the can_revoke is False.
sharing.LinkPermissions.effective_audience – The type of audience who can benefit from the access level specified by the link_access_level field.
sharing.LinkPermissions.link_access_level – The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with link_access_level set to editor, then they will gain editor privileges. The link_access_level is a property of the link, and does not depend on who is calling this API. In particular, link_access_level does not take into account the API caller’s current permissions to the content.
sharing.LinkPermissions.visibility_policies – A list of policies that the user might be able to set for the visibility.
sharing.LinkPermissions.can_set_expiry – Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry.
sharing.LinkPermissions.can_remove_expiry – Whether the user can remove the expiry of the link.
sharing.LinkPermissions.allow_download – Whether the link can be downloaded or not.
sharing.LinkPermissions.can_allow_download – Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link.
sharing.LinkPermissions.can_disallow_download – Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link.
sharing.LinkPermissions.allow_comments – Whether comments are enabled for the linked file. This takes the team commenting policy into account.
sharing.LinkPermissions.team_restricts_comments – Whether the team has disabled commenting globally.
sharing.LinkPermissions.audience_options – A list of link audience options the user might be able to set as the new audience.
sharing.LinkPermissions.can_set_password – Whether the user can set a password for the link.
sharing.LinkPermissions.can_remove_password – Whether the user can remove the password of the link.
sharing.LinkPermissions.require_password – Whether the user is required to provide a password to view the link.
sharing.LinkPermissions.can_use_extended_sharing_controls – Whether the user can use extended sharing controls, based on their account type.

__init__(can_revoke=None, visibility_policies=None, can_set_expiry=None, can_remove_expiry=None, allow_download=None, can_allow_download=None, can_disallow_download=None, allow_comments=None, team_restricts_comments=None, resolved_visibility=None, requested_visibility=None, revoke_failure_reason=None, effective_audience=None, link_access_level=None, audience_options=None, can_set_password=None, can_remove_password=None, require_password=None, can_use_extended_sharing_controls=None)

allow_comments

allow_download

audience_options

can_allow_download

can_disallow_download

can_remove_expiry

can_remove_password

can_revoke

can_set_expiry

can_set_password

can_use_extended_sharing_controls

effective_audience

link_access_level

requested_visibility

require_password

resolved_visibility

revoke_failure_reason

team_restricts_comments

visibility_policies

class dropbox.sharing.LinkSettings(access_level=None, audience=None, expiry=None, password=None)

Bases: Struct

Settings that apply to a link.

Variables:

sharing.LinkSettings.access_level – The access level on the link for this file. Currently, it only accepts ‘viewer’ and ‘viewer_no_comment’.
sharing.LinkSettings.audience – The type of audience on the link for this file.
sharing.LinkSettings.expiry – An expiry timestamp to set on a link.
sharing.LinkSettings.password – The password for the link.

__init__(access_level=None, audience=None, expiry=None, password=None)

access_level

audience

expiry

password

class dropbox.sharing.ListFileMembersArg(file=None, actions=None, include_inherited=None, limit=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_list_file_members().

Variables:

sharing.ListFileMembersArg.file – The file for which you want to see members.
sharing.ListFileMembersArg.actions – The actions for which to return permissions on a member.
sharing.ListFileMembersArg.include_inherited – Whether to include members who only have access from a parent shared folder.
sharing.ListFileMembersArg.limit – Number of members to return max per query. Defaults to 100 if no limit is specified.

__init__(file=None, actions=None, include_inherited=None, limit=None)

actions

file

include_inherited

limit

class dropbox.sharing.ListFileMembersBatchArg(files=None, limit=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_list_file_members_batch().

Variables:

sharing.ListFileMembersBatchArg.files – Files for which to return members.
sharing.ListFileMembersBatchArg.limit – Number of members to return max per query. Defaults to 10 if no limit is specified.

__init__(files=None, limit=None)

files

limit

class dropbox.sharing.ListFileMembersBatchResult(file=None, result=None)

Bases: Struct

Per-file result for dropbox.dropbox_client.Dropbox.sharing_list_file_members_batch().

Variables:

sharing.ListFileMembersBatchResult.file – This is the input file identifier, whether an ID or a path.
sharing.ListFileMembersBatchResult.result – The result for this particular file.

__init__(file=None, result=None)

file

result

class dropbox.sharing.ListFileMembersContinueArg(cursor=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_list_file_members_continue().

Variables:: sharing.ListFileMembersContinueArg.cursor – The cursor returned by your last call to dropbox.dropbox_client.Dropbox.sharing_list_file_members(), dropbox.dropbox_client.Dropbox.sharing_list_file_members_continue(), or dropbox.dropbox_client.Dropbox.sharing_list_file_members_batch().

__init__(cursor=None)

cursor

class dropbox.sharing.ListFileMembersContinueError(tag, value=None)

Bases: Union

Error for dropbox.dropbox_client.Dropbox.sharing_list_file_members_continue().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.ListFileMembersContinueError.invalid_cursor – ListFileMembersContinueArg.cursor is invalid.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: ListFileMembersContinueError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_user_error()

Only call this if is_user_error() is true.

Return type:: SharingUserError

invalid_cursor = ListFileMembersContinueError('invalid_cursor', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

other = ListFileMembersContinueError('other', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: ListFileMembersContinueError

class dropbox.sharing.ListFileMembersCountResult(members=None, member_count=None)

Bases: Struct

Variables:

sharing.ListFileMembersCountResult.members – A list of members on this file.
sharing.ListFileMembersCountResult.member_count – The number of members on this file. This does not include inherited members.

__init__(members=None, member_count=None)

member_count

members

class dropbox.sharing.ListFileMembersError(tag, value=None)

Bases: Union

Error for dropbox.dropbox_client.Dropbox.sharing_list_file_members().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: ListFileMembersError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_user_error()

Only call this if is_user_error() is true.

Return type:: SharingUserError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

other = ListFileMembersError('other', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: ListFileMembersError

class dropbox.sharing.ListFileMembersIndividualResult(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

ListFileMembersIndividualResult.result (ListFileMembersCountResult) – The results of the query for this file if it was successful.
ListFileMembersIndividualResult.access_error (SharingFileAccessError) – The result of the query for this file if it was an error.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: ListFileMembersIndividualResult

get_access_error()

The result of the query for this file if it was an error.

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_result()

The results of the query for this file if it was successful.

Only call this if is_result() is true.

Return type:: ListFileMembersCountResult

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_result()

Check if the union tag is result.

Return type:: bool

other = ListFileMembersIndividualResult('other', None)

classmethod result(val)

Create an instance of this class set to the result tag with value val.

Parameters:: val (ListFileMembersCountResult) –
Return type:: ListFileMembersIndividualResult

class dropbox.sharing.ListFilesArg(limit=None, actions=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_list_received_files().

Variables:

sharing.ListFilesArg.limit – Number of files to return max per query. Defaults to 100 if no limit is specified.
sharing.ListFilesArg.actions – A list of FileAction`s corresponding to `FilePermission`s that should appear in the response’s ``SharedFileMetadata.permissions` field describing the actions the authenticated user can perform on the file.

__init__(limit=None, actions=None)

actions

limit

class dropbox.sharing.ListFilesContinueArg(cursor=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_list_received_files_continue().

Variables:: sharing.ListFilesContinueArg.cursor – Cursor in ListFilesResult.cursor.

__init__(cursor=None)

cursor

class dropbox.sharing.ListFilesContinueError(tag, value=None)

Bases: Union

Error results for dropbox.dropbox_client.Dropbox.sharing_list_received_files_continue().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

ListFilesContinueError.user_error (SharingUserError) – User account had a problem.
sharing.ListFilesContinueError.invalid_cursor – ListFilesContinueArg.cursor is invalid.

get_user_error()

User account had a problem.

Only call this if is_user_error() is true.

Return type:: SharingUserError

invalid_cursor = ListFilesContinueError('invalid_cursor', None)

is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

other = ListFilesContinueError('other', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: ListFilesContinueError

class dropbox.sharing.ListFilesResult(entries=None, cursor=None)

Bases: Struct

Success results for dropbox.dropbox_client.Dropbox.sharing_list_received_files().

Variables:

sharing.ListFilesResult.entries – Information about the files shared with current user.
sharing.ListFilesResult.cursor – Cursor used to obtain additional shared files.

__init__(entries=None, cursor=None)

cursor

entries

class dropbox.sharing.ListFolderMembersArgs(shared_folder_id=None, actions=None, limit=None)

Bases: ListFolderMembersCursorArg

Variables:: sharing.ListFolderMembersArgs.shared_folder_id – The ID for the shared folder.

__init__(shared_folder_id=None, actions=None, limit=None)

shared_folder_id

class dropbox.sharing.ListFolderMembersContinueArg(cursor=None)

Bases: Struct

Variables:: sharing.ListFolderMembersContinueArg.cursor – The cursor returned by your last call to dropbox.dropbox_client.Dropbox.sharing_list_folder_members() or dropbox.dropbox_client.Dropbox.sharing_list_folder_members_continue().

__init__(cursor=None)

cursor

class dropbox.sharing.ListFolderMembersContinueError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.ListFolderMembersContinueError.invalid_cursor – ListFolderMembersContinueArg.cursor is invalid.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: ListFolderMembersContinueError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

invalid_cursor = ListFolderMembersContinueError('invalid_cursor', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

other = ListFolderMembersContinueError('other', None)

class dropbox.sharing.ListFolderMembersCursorArg(actions=None, limit=None)

Bases: Struct

Variables:

sharing.ListFolderMembersCursorArg.actions – This is a list indicating whether each returned member will include a boolean value MemberPermission.allow that describes whether the current user can perform the MemberAction on the member.
sharing.ListFolderMembersCursorArg.limit – The maximum number of results that include members, groups and invitees to return per request.

__init__(actions=None, limit=None)

actions

limit

class dropbox.sharing.ListFoldersArgs(limit=None, actions=None)

Bases: Struct

Variables:

sharing.ListFoldersArgs.limit – The maximum number of results to return per request.
sharing.ListFoldersArgs.actions – A list of FolderAction`s corresponding to `FolderPermission`s that should appear in the response’s ``SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder.

__init__(limit=None, actions=None)

actions

limit

class dropbox.sharing.ListFoldersContinueArg(cursor=None)

Bases: Struct

Variables:: sharing.ListFoldersContinueArg.cursor – The cursor returned by the previous API call specified in the endpoint description.

__init__(cursor=None)

cursor

class dropbox.sharing.ListFoldersContinueError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.ListFoldersContinueError.invalid_cursor – ListFoldersContinueArg.cursor is invalid.

invalid_cursor = ListFoldersContinueError('invalid_cursor', None)

is_invalid_cursor()

Check if the union tag is invalid_cursor.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

other = ListFoldersContinueError('other', None)

class dropbox.sharing.ListFoldersResult(entries=None, cursor=None)

Bases: Struct

Result for dropbox.dropbox_client.Dropbox.sharing_list_folders() or dropbox.dropbox_client.Dropbox.sharing_list_mountable_folders(), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.path_lower.

Variables:

sharing.ListFoldersResult.entries – List of all shared folders the authenticated user has access to.
sharing.ListFoldersResult.cursor – Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either dropbox.dropbox_client.Dropbox.sharing_list_folders_continue() or dropbox.dropbox_client.Dropbox.sharing_list_mountable_folders_continue()) to list additional folders.

__init__(entries=None, cursor=None)

cursor

entries

class dropbox.sharing.ListSharedLinksArg(path=None, cursor=None, direct_only=None)

Bases: Struct

Variables:

sharing.ListSharedLinksArg.path – See dropbox.dropbox_client.Dropbox.sharing_list_shared_links() description.
sharing.ListSharedLinksArg.cursor – The cursor returned by your last call to dropbox.dropbox_client.Dropbox.sharing_list_shared_links().
sharing.ListSharedLinksArg.direct_only – See dropbox.dropbox_client.Dropbox.sharing_list_shared_links() description.

__init__(path=None, cursor=None, direct_only=None)

cursor

direct_only

path

class dropbox.sharing.ListSharedLinksError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.ListSharedLinksError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.sharing_list_shared_links() to obtain a new cursor.

get_path()

Only call this if is_path() is true.

Return type:: files.LookupError

is_other()

Check if the union tag is other.

Return type:: bool

is_path()

Check if the union tag is path.

Return type:: bool

is_reset()

Check if the union tag is reset.

Return type:: bool

other = ListSharedLinksError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:: val (files.LookupError) –
Return type:: ListSharedLinksError

reset = ListSharedLinksError('reset', None)

class dropbox.sharing.ListSharedLinksResult(links=None, has_more=None, cursor=None)

Bases: Struct

Variables:

sharing.ListSharedLinksResult.links – Shared links applicable to the path argument.
sharing.ListSharedLinksResult.has_more – Is true if there are additional shared links that have not been returned yet. Pass the cursor into dropbox.dropbox_client.Dropbox.sharing_list_shared_links() to retrieve them.
sharing.ListSharedLinksResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.sharing_list_shared_links() to obtain the additional links. Cursor is returned only if no path is given.

__init__(links=None, has_more=None, cursor=None)

cursor

has_more

links

class dropbox.sharing.MemberAccessLevelResult(access_level=None, warning=None, access_details=None)

Bases: Struct

Contains information about a member’s access level to content after an operation.

Variables:

sharing.MemberAccessLevelResult.access_level – The member still has this level of access to the content through a parent folder.
sharing.MemberAccessLevelResult.warning – A localized string with additional information about why the user has this access level to the content.
sharing.MemberAccessLevelResult.access_details – The parent folders that a member has access to. The field is present if the user has access to the first parent folder where the member gains access.

__init__(access_level=None, warning=None, access_details=None)

access_details

access_level

warning

class dropbox.sharing.MemberAction(tag, value=None)

Bases: Union

Actions that may be taken on members of a shared folder.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.MemberAction.leave_a_copy – Allow the member to keep a copy of the folder when removing.
sharing.MemberAction.make_editor – Make the member an editor of the folder.
sharing.MemberAction.make_owner – Make the member an owner of the folder.
sharing.MemberAction.make_viewer – Make the member a viewer of the folder.
sharing.MemberAction.make_viewer_no_comment – Make the member a viewer of the folder without commenting permissions.
sharing.MemberAction.remove – Remove the member from the folder.

is_leave_a_copy()

Check if the union tag is leave_a_copy.

Return type:: bool

is_make_editor()

Check if the union tag is make_editor.

Return type:: bool

is_make_owner()

Check if the union tag is make_owner.

Return type:: bool

is_make_viewer()

Check if the union tag is make_viewer.

Return type:: bool

is_make_viewer_no_comment()

Check if the union tag is make_viewer_no_comment.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_remove()

Check if the union tag is remove.

Return type:: bool

leave_a_copy = MemberAction('leave_a_copy', None)

make_editor = MemberAction('make_editor', None)

make_owner = MemberAction('make_owner', None)

make_viewer = MemberAction('make_viewer', None)

make_viewer_no_comment = MemberAction('make_viewer_no_comment', None)

other = MemberAction('other', None)

remove = MemberAction('remove', None)

class dropbox.sharing.MemberPermission(action=None, allow=None, reason=None)

Bases: Struct

Whether the user is allowed to take the action on the associated member.

Variables:

sharing.MemberPermission.action – The action that the user may wish to take on the member.
sharing.MemberPermission.allow – True if the user is allowed to take the action.
sharing.MemberPermission.reason – The reason why the user is denied the permission. Not present if the action is allowed.

__init__(action=None, allow=None, reason=None)

action

allow

reason

class dropbox.sharing.MemberPolicy(tag, value=None)

Bases: Union

Policy governing who can be a member of a shared folder. Only applicable to folders owned by a user on a team.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.MemberPolicy.team – Only a teammate can become a member.
sharing.MemberPolicy.anyone – Anyone can become a member.

anyone = MemberPolicy('anyone', None)

is_anyone()

Check if the union tag is anyone.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team()

Check if the union tag is team.

Return type:: bool

other = MemberPolicy('other', None)

team = MemberPolicy('team', None)

class dropbox.sharing.MemberSelector(tag, value=None)

Bases: Union

Includes different ways to identify a member of a shared folder.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.MemberSelector.dropbox_id (str) – Dropbox account, team member, or group ID of member.
sharing.MemberSelector.email (str) – Email address of member.

classmethod dropbox_id(val)

Create an instance of this class set to the dropbox_id tag with value val.

Parameters:: val (str) –
Return type:: MemberSelector

classmethod email(val)

Create an instance of this class set to the email tag with value val.

Parameters:: val (str) –
Return type:: MemberSelector

get_dropbox_id()

Dropbox account, team member, or group ID of member.

Only call this if is_dropbox_id() is true.

Return type:: str

get_email()

Email address of member.

Only call this if is_email() is true.

Return type:: str

is_dropbox_id()

Check if the union tag is dropbox_id.

Return type:: bool

is_email()

Check if the union tag is email.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

other = MemberSelector('other', None)

class dropbox.sharing.MembershipInfo(access_type=None, permissions=None, initials=None, is_inherited=None)

Bases: Struct

The information about a member of the shared content.

Variables:

sharing.MembershipInfo.access_type – The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
sharing.MembershipInfo.permissions – The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
sharing.MembershipInfo.initials – Never set.
sharing.MembershipInfo.is_inherited – True if the member has access from a parent folder.

__init__(access_type=None, permissions=None, initials=None, is_inherited=None)

access_type

initials

is_inherited

permissions

class dropbox.sharing.ModifySharedLinkSettingsArgs(url=None, settings=None, remove_expiration=None)

Bases: Struct

Variables:

sharing.ModifySharedLinkSettingsArgs.url – URL of the shared link to change its settings.
sharing.ModifySharedLinkSettingsArgs.settings – Set of settings for the shared link.
sharing.ModifySharedLinkSettingsArgs.remove_expiration – If set to true, removes the expiration of the shared link.

__init__(url=None, settings=None, remove_expiration=None)

remove_expiration

settings

url

class dropbox.sharing.ModifySharedLinkSettingsError(tag, value=None)

Bases: SharedLinkError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

ModifySharedLinkSettingsError.settings_error (SharedLinkSettingsError) – There is an error with the given settings.
sharing.ModifySharedLinkSettingsError.email_not_verified –
This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.

email_not_verified = ModifySharedLinkSettingsError('email_not_verified', None)

get_settings_error()

There is an error with the given settings.

Only call this if is_settings_error() is true.

Return type:: SharedLinkSettingsError

is_email_not_verified()

Check if the union tag is email_not_verified.

Return type:: bool

is_settings_error()

Check if the union tag is settings_error.

Return type:: bool

classmethod settings_error(val)

Create an instance of this class set to the settings_error tag with value val.

Parameters:: val (SharedLinkSettingsError) –
Return type:: ModifySharedLinkSettingsError

class dropbox.sharing.MountFolderArg(shared_folder_id=None)

Bases: Struct

Variables:: sharing.MountFolderArg.shared_folder_id – The ID of the shared folder to mount.

__init__(shared_folder_id=None)

shared_folder_id

class dropbox.sharing.MountFolderError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.MountFolderError.inside_shared_folder – Mounting would cause a shared folder to be inside another, which is disallowed.
MountFolderError.insufficient_quota (InsufficientQuotaAmounts) – The current user does not have enough space to mount the shared folder.
sharing.MountFolderError.already_mounted – The shared folder is already mounted.
sharing.MountFolderError.no_permission – The current user does not have permission to perform this action.
sharing.MountFolderError.not_mountable – The shared folder is not mountable. One example where this can occur is when the shared folder belongs within a team folder in the user’s Dropbox.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: MountFolderError

already_mounted = MountFolderError('already_mounted', None)

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

get_insufficient_quota()

The current user does not have enough space to mount the shared folder.

Only call this if is_insufficient_quota() is true.

Return type:: InsufficientQuotaAmounts

inside_shared_folder = MountFolderError('inside_shared_folder', None)

classmethod insufficient_quota(val)

Create an instance of this class set to the insufficient_quota tag with value val.

Parameters:: val (InsufficientQuotaAmounts) –
Return type:: MountFolderError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_already_mounted()

Check if the union tag is already_mounted.

Return type:: bool

is_inside_shared_folder()

Check if the union tag is inside_shared_folder.

Return type:: bool

is_insufficient_quota()

Check if the union tag is insufficient_quota.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_not_mountable()

Check if the union tag is not_mountable.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

no_permission = MountFolderError('no_permission', None)

not_mountable = MountFolderError('not_mountable', None)

other = MountFolderError('other', None)

class dropbox.sharing.ParentFolderAccessInfo(folder_name=None, shared_folder_id=None, permissions=None, path=None)

Bases: Struct

Contains information about a parent folder that a member has access to.

Variables:

sharing.ParentFolderAccessInfo.folder_name – Display name for the folder.
sharing.ParentFolderAccessInfo.shared_folder_id – The identifier of the parent shared folder.
sharing.ParentFolderAccessInfo.permissions – The user’s permissions for the parent shared folder.
sharing.ParentFolderAccessInfo.path – The full path to the parent shared folder relative to the acting user’s root.

__init__(folder_name=None, shared_folder_id=None, permissions=None, path=None)

folder_name

path

permissions

shared_folder_id

class dropbox.sharing.PathLinkMetadata(url=None, visibility=None, path=None, expires=None)

Bases: LinkMetadata

Metadata for a path-based shared link.

Variables:: sharing.PathLinkMetadata.path – Path in user’s Dropbox.

__init__(url=None, visibility=None, path=None, expires=None)

path

class dropbox.sharing.PendingUploadMode(tag, value=None)

Bases: Union

Flag to indicate pending upload default (for linking to not-yet-existing paths).

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.PendingUploadMode.file – Assume pending uploads are files.
sharing.PendingUploadMode.folder – Assume pending uploads are folders.

file = PendingUploadMode('file', None)

folder = PendingUploadMode('folder', None)

is_file()

Check if the union tag is file.

Return type:: bool

is_folder()

Check if the union tag is folder.

Return type:: bool

class dropbox.sharing.PermissionDeniedReason(tag, value=None)

Bases: Union

Possible reasons the user is denied a permission.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.PermissionDeniedReason.user_not_same_team_as_owner – User is not on the same team as the folder owner.
sharing.PermissionDeniedReason.user_not_allowed_by_owner – User is prohibited by the owner from taking the action.
sharing.PermissionDeniedReason.target_is_indirect_member – Target is indirectly a member of the folder, for example by being part of a group.
sharing.PermissionDeniedReason.target_is_owner – Target is the owner of the folder.
sharing.PermissionDeniedReason.target_is_self – Target is the user itself.
sharing.PermissionDeniedReason.target_not_active – Target is not an active member of the team.
sharing.PermissionDeniedReason.folder_is_limited_team_folder – Folder is team folder for a limited team.
sharing.PermissionDeniedReason.owner_not_on_team – The content owner needs to be on a Dropbox team to perform this action.
sharing.PermissionDeniedReason.permission_denied – The user does not have permission to perform this action on the link.
sharing.PermissionDeniedReason.restricted_by_team – The user’s team policy prevents performing this action on the link.
sharing.PermissionDeniedReason.user_account_type – The user’s account type does not support this action.
sharing.PermissionDeniedReason.user_not_on_team – The user needs to be on a Dropbox team to perform this action.
sharing.PermissionDeniedReason.folder_is_inside_shared_folder – Folder is inside of another shared folder.
sharing.PermissionDeniedReason.restricted_by_parent_folder – Policy cannot be changed due to restrictions from parent folder.

folder_is_inside_shared_folder = PermissionDeniedReason('folder_is_inside_shared_folder', None)

folder_is_limited_team_folder = PermissionDeniedReason('folder_is_limited_team_folder', None)

get_insufficient_plan()

Only call this if is_insufficient_plan() is true.

Return type:: InsufficientPlan

classmethod insufficient_plan(val)

Create an instance of this class set to the insufficient_plan tag with value val.

Parameters:: val (InsufficientPlan) –
Return type:: PermissionDeniedReason

is_folder_is_inside_shared_folder()

Check if the union tag is folder_is_inside_shared_folder.

Return type:: bool

is_folder_is_limited_team_folder()

Check if the union tag is folder_is_limited_team_folder.

Return type:: bool

is_insufficient_plan()

Check if the union tag is insufficient_plan.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_owner_not_on_team()

Check if the union tag is owner_not_on_team.

Return type:: bool

is_permission_denied()

Check if the union tag is permission_denied.

Return type:: bool

is_restricted_by_parent_folder()

Check if the union tag is restricted_by_parent_folder.

Return type:: bool

is_restricted_by_team()

Check if the union tag is restricted_by_team.

Return type:: bool

is_target_is_indirect_member()

Check if the union tag is target_is_indirect_member.

Return type:: bool

is_target_is_owner()

Check if the union tag is target_is_owner.

Return type:: bool

is_target_is_self()

Check if the union tag is target_is_self.

Return type:: bool

is_target_not_active()

Check if the union tag is target_not_active.

Return type:: bool

is_user_account_type()

Check if the union tag is user_account_type.

Return type:: bool

is_user_not_allowed_by_owner()

Check if the union tag is user_not_allowed_by_owner.

Return type:: bool

is_user_not_on_team()

Check if the union tag is user_not_on_team.

Return type:: bool

is_user_not_same_team_as_owner()

Check if the union tag is user_not_same_team_as_owner.

Return type:: bool

other = PermissionDeniedReason('other', None)

owner_not_on_team = PermissionDeniedReason('owner_not_on_team', None)

permission_denied = PermissionDeniedReason('permission_denied', None)

restricted_by_parent_folder = PermissionDeniedReason('restricted_by_parent_folder', None)

restricted_by_team = PermissionDeniedReason('restricted_by_team', None)

target_is_indirect_member = PermissionDeniedReason('target_is_indirect_member', None)

target_is_owner = PermissionDeniedReason('target_is_owner', None)

target_is_self = PermissionDeniedReason('target_is_self', None)

target_not_active = PermissionDeniedReason('target_not_active', None)

user_account_type = PermissionDeniedReason('user_account_type', None)

user_not_allowed_by_owner = PermissionDeniedReason('user_not_allowed_by_owner', None)

user_not_on_team = PermissionDeniedReason('user_not_on_team', None)

user_not_same_team_as_owner = PermissionDeniedReason('user_not_same_team_as_owner', None)

class dropbox.sharing.RelinquishFileMembershipArg(file=None)

Bases: Struct

Variables:: sharing.RelinquishFileMembershipArg.file – The path or id for the file.

__init__(file=None)

file

class dropbox.sharing.RelinquishFileMembershipError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.RelinquishFileMembershipError.group_access – The current user has access to the shared file via a group. You can’t relinquish membership to a file shared via groups.
sharing.RelinquishFileMembershipError.no_permission – The current user does not have permission to perform this action.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: RelinquishFileMembershipError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

group_access = RelinquishFileMembershipError('group_access', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_group_access()

Check if the union tag is group_access.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

no_permission = RelinquishFileMembershipError('no_permission', None)

other = RelinquishFileMembershipError('other', None)

class dropbox.sharing.RelinquishFolderMembershipArg(shared_folder_id=None, leave_a_copy=None)

Bases: Struct

Variables:

sharing.RelinquishFolderMembershipArg.shared_folder_id – The ID for the shared folder.
sharing.RelinquishFolderMembershipArg.leave_a_copy – 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.

__init__(shared_folder_id=None, leave_a_copy=None)

leave_a_copy

shared_folder_id

class dropbox.sharing.RelinquishFolderMembershipError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.RelinquishFolderMembershipError.folder_owner – The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first.
sharing.RelinquishFolderMembershipError.mounted – The shared folder is currently mounted. Unmount the shared folder before relinquishing membership.
sharing.RelinquishFolderMembershipError.group_access – The current user has access to the shared folder via a group. You can’t relinquish membership to folders shared via groups.
sharing.RelinquishFolderMembershipError.team_folder – This action cannot be performed on a team shared folder.
sharing.RelinquishFolderMembershipError.no_permission – The current user does not have permission to perform this action.
sharing.RelinquishFolderMembershipError.no_explicit_access – The current user only has inherited access to the shared folder. You can’t relinquish inherited membership to folders.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: RelinquishFolderMembershipError

folder_owner = RelinquishFolderMembershipError('folder_owner', None)

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

group_access = RelinquishFolderMembershipError('group_access', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_folder_owner()

Check if the union tag is folder_owner.

Return type:: bool

is_group_access()

Check if the union tag is group_access.

Return type:: bool

is_mounted()

Check if the union tag is mounted.

Return type:: bool

is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team_folder()

Check if the union tag is team_folder.

Return type:: bool

mounted = RelinquishFolderMembershipError('mounted', None)

no_explicit_access = RelinquishFolderMembershipError('no_explicit_access', None)

no_permission = RelinquishFolderMembershipError('no_permission', None)

other = RelinquishFolderMembershipError('other', None)

team_folder = RelinquishFolderMembershipError('team_folder', None)

class dropbox.sharing.RemoveFileMemberArg(file=None, member=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_remove_file_member_2().

Variables:

sharing.RemoveFileMemberArg.file – File from which to remove members.
sharing.RemoveFileMemberArg.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.

__init__(file=None, member=None)

file

member

class dropbox.sharing.RemoveFileMemberError(tag, value=None)

Bases: Union

Errors for dropbox.dropbox_client.Dropbox.sharing_remove_file_member_2().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: RemoveFileMemberError.no_explicit_access (MemberAccessLevelResult) – This member does not have explicit access to the file and therefore cannot be removed. The return value is the access that a user might have to the file from a parent folder.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: RemoveFileMemberError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_no_explicit_access()

This member does not have explicit access to the file and therefore cannot be removed. The return value is the access that a user might have to the file from a parent folder.

Only call this if is_no_explicit_access() is true.

Return type:: MemberAccessLevelResult

get_user_error()

Only call this if is_user_error() is true.

Return type:: SharingUserError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

classmethod no_explicit_access(val)

Create an instance of this class set to the no_explicit_access tag with value val.

Parameters:: val (MemberAccessLevelResult) –
Return type:: RemoveFileMemberError

other = RemoveFileMemberError('other', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: RemoveFileMemberError

class dropbox.sharing.RemoveFolderMemberArg(shared_folder_id=None, member=None, leave_a_copy=None)

Bases: Struct

Variables:

sharing.RemoveFolderMemberArg.shared_folder_id – The ID for the shared folder.
sharing.RemoveFolderMemberArg.member – The member to remove from the folder.
sharing.RemoveFolderMemberArg.leave_a_copy – 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.

__init__(shared_folder_id=None, member=None, leave_a_copy=None)

leave_a_copy

member

shared_folder_id

class dropbox.sharing.RemoveFolderMemberError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.RemoveFolderMemberError.folder_owner – The target user is the owner of the shared folder. You can’t remove this user until ownership has been transferred to another member.
sharing.RemoveFolderMemberError.group_access – The target user has access to the shared folder via a group.
sharing.RemoveFolderMemberError.team_folder – This action cannot be performed on a team shared folder.
sharing.RemoveFolderMemberError.no_permission – The current user does not have permission to perform this action.
sharing.RemoveFolderMemberError.too_many_files – This shared folder has too many files for leaving a copy. You can still remove this user without leaving a copy.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: RemoveFolderMemberError

folder_owner = RemoveFolderMemberError('folder_owner', None)

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

get_member_error()

Only call this if is_member_error() is true.

Return type:: SharedFolderMemberError

group_access = RemoveFolderMemberError('group_access', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_folder_owner()

Check if the union tag is folder_owner.

Return type:: bool

is_group_access()

Check if the union tag is group_access.

Return type:: bool

is_member_error()

Check if the union tag is member_error.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team_folder()

Check if the union tag is team_folder.

Return type:: bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:: bool

classmethod member_error(val)

Create an instance of this class set to the member_error tag with value val.

Parameters:: val (SharedFolderMemberError) –
Return type:: RemoveFolderMemberError

no_permission = RemoveFolderMemberError('no_permission', None)

other = RemoveFolderMemberError('other', None)

team_folder = RemoveFolderMemberError('team_folder', None)

too_many_files = RemoveFolderMemberError('too_many_files', None)

class dropbox.sharing.RemoveMemberJobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: RemoveMemberJobStatus.complete (MemberAccessLevelResult) – Removing the folder member has finished. The value is information about whether the member has another form of access.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:: val (MemberAccessLevelResult) –
Return type:: RemoveMemberJobStatus

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:: val (RemoveFolderMemberError) –
Return type:: RemoveMemberJobStatus

get_complete()

Removing the folder member has finished. The value is information about whether the member has another form of access.

Only call this if is_complete() is true.

Return type:: MemberAccessLevelResult

get_failed()

Only call this if is_failed() is true.

Return type:: RemoveFolderMemberError

is_complete()

Check if the union tag is complete.

Return type:: bool

is_failed()

Check if the union tag is failed.

Return type:: bool

class dropbox.sharing.RequestedLinkAccessLevel(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.RequestedLinkAccessLevel.viewer – Users who use the link can view and comment on the content.
sharing.RequestedLinkAccessLevel.editor – Users who use the link can edit, view and comment on the content. Note not all file types support edit links yet.
sharing.RequestedLinkAccessLevel.max – Request for the maximum access level you can set the link to.
sharing.RequestedLinkAccessLevel.default – Request for the default access level the user has set.

default = RequestedLinkAccessLevel('default', None)

editor = RequestedLinkAccessLevel('editor', None)

is_default()

Check if the union tag is default.

Return type:: bool

is_editor()

Check if the union tag is editor.

Return type:: bool

is_max()

Check if the union tag is max.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_viewer()

Check if the union tag is viewer.

Return type:: bool

max = RequestedLinkAccessLevel('max', None)

other = RequestedLinkAccessLevel('other', None)

viewer = RequestedLinkAccessLevel('viewer', None)

class dropbox.sharing.RequestedVisibility(tag, value=None)

Bases: Union

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.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.RequestedVisibility.public – Anyone who has received the link can access it. No login required.
sharing.RequestedVisibility.team_only – Only members of the same team can access the link. Login is required.
sharing.RequestedVisibility.password – A link-specific password is required to access the link. Login is not required.

is_password()

Check if the union tag is password.

Return type:: bool

is_public()

Check if the union tag is public.

Return type:: bool

is_team_only()

Check if the union tag is team_only.

Return type:: bool

password = RequestedVisibility('password', None)

public = RequestedVisibility('public', None)

team_only = RequestedVisibility('team_only', None)

class dropbox.sharing.ResolvedVisibility(tag, value=None)

Bases: RequestedVisibility

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.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.ResolvedVisibility.team_and_password – Only members of the same team who have the link-specific password can access the link. Login is required.
sharing.ResolvedVisibility.shared_folder_only – Only members of the shared folder containing the linked file can access the link. Login is required.
sharing.ResolvedVisibility.no_one – The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder.
sharing.ResolvedVisibility.only_you – Only the current user can view this link.

is_no_one()

Check if the union tag is no_one.

Return type:: bool

is_only_you()

Check if the union tag is only_you.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_shared_folder_only()

Check if the union tag is shared_folder_only.

Return type:: bool

is_team_and_password()

Check if the union tag is team_and_password.

Return type:: bool

no_one = ResolvedVisibility('no_one', None)

only_you = ResolvedVisibility('only_you', None)

other = ResolvedVisibility('other', None)

shared_folder_only = ResolvedVisibility('shared_folder_only', None)

team_and_password = ResolvedVisibility('team_and_password', None)

class dropbox.sharing.RevokeSharedLinkArg(url=None)

Bases: Struct

Variables:: sharing.RevokeSharedLinkArg.url – URL of the shared link.

__init__(url=None)

url

class dropbox.sharing.RevokeSharedLinkError(tag, value=None)

Bases: SharedLinkError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.RevokeSharedLinkError.shared_link_malformed – Shared link is malformed.

is_shared_link_malformed()

Check if the union tag is shared_link_malformed.

Return type:: bool

shared_link_malformed = RevokeSharedLinkError('shared_link_malformed', None)

class dropbox.sharing.SetAccessInheritanceArg(shared_folder_id=None, access_inheritance=None)

Bases: Struct

Variables:

sharing.SetAccessInheritanceArg.access_inheritance – The access inheritance settings for the folder.
sharing.SetAccessInheritanceArg.shared_folder_id – The ID for the shared folder.

__init__(shared_folder_id=None, access_inheritance=None)

access_inheritance

shared_folder_id

class dropbox.sharing.SetAccessInheritanceError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

SetAccessInheritanceError.access_error (SharedFolderAccessError) – Unable to access shared folder.
sharing.SetAccessInheritanceError.no_permission – The current user does not have permission to perform this action.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: SetAccessInheritanceError

get_access_error()

Unable to access shared folder.

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

no_permission = SetAccessInheritanceError('no_permission', None)

other = SetAccessInheritanceError('other', None)

class dropbox.sharing.ShareFolderArg(path=None, acl_update_policy=None, force_async=None, member_policy=None, shared_link_policy=None, viewer_info_policy=None, access_inheritance=None, actions=None, link_settings=None)

Bases: ShareFolderArgBase

Variables:

sharing.ShareFolderArg.actions – A list of FolderAction`s corresponding to `FolderPermission`s that should appear in the response’s ``SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder.
sharing.ShareFolderArg.link_settings – Settings on the link for this folder.

__init__(path=None, acl_update_policy=None, force_async=None, member_policy=None, shared_link_policy=None, viewer_info_policy=None, access_inheritance=None, actions=None, link_settings=None)

actions

link_settings

class dropbox.sharing.ShareFolderArgBase(path=None, acl_update_policy=None, force_async=None, member_policy=None, shared_link_policy=None, viewer_info_policy=None, access_inheritance=None)

Bases: Struct

Variables:

sharing.ShareFolderArgBase.acl_update_policy – Who can add and remove members of this shared folder.
sharing.ShareFolderArgBase.force_async – Whether to force the share to happen asynchronously.
sharing.ShareFolderArgBase.member_policy – Who can be a member of this shared folder. Only applicable if the current user is on a team.
sharing.ShareFolderArgBase.path – The path or the file id to the folder to share. If it does not exist, then a new one is created.
sharing.ShareFolderArgBase.shared_link_policy – The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.
sharing.ShareFolderArgBase.viewer_info_policy – Who can enable/disable viewer info for this shared folder.
sharing.ShareFolderArgBase.access_inheritance – The access inheritance settings for the folder.

__init__(path=None, acl_update_policy=None, force_async=None, member_policy=None, shared_link_policy=None, viewer_info_policy=None, access_inheritance=None)

access_inheritance

acl_update_policy

force_async

member_policy

path

shared_link_policy

viewer_info_policy

class dropbox.sharing.ShareFolderError(tag, value=None)

Bases: ShareFolderErrorBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: sharing.ShareFolderError.no_permission – The current user does not have permission to perform this action.

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

no_permission = ShareFolderError('no_permission', None)

class dropbox.sharing.ShareFolderErrorBase(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.ShareFolderErrorBase.email_unverified –
This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.
ShareFolderErrorBase.bad_path (SharePathError) – ShareFolderArg.path is invalid.
sharing.ShareFolderErrorBase.team_policy_disallows_member_policy – Team policy is more restrictive than ShareFolderArg.member_policy.
sharing.ShareFolderErrorBase.disallowed_shared_link_policy – The current user’s account is not allowed to select the specified ShareFolderArg.shared_link_policy.

classmethod bad_path(val)

Create an instance of this class set to the bad_path tag with value val.

Parameters:: val (SharePathError) –
Return type:: ShareFolderErrorBase

disallowed_shared_link_policy = ShareFolderErrorBase('disallowed_shared_link_policy', None)

email_unverified = ShareFolderErrorBase('email_unverified', None)

get_bad_path()

ShareFolderArg.path is invalid.

Only call this if is_bad_path() is true.

Return type:: SharePathError

is_bad_path()

Check if the union tag is bad_path.

Return type:: bool

is_disallowed_shared_link_policy()

Check if the union tag is disallowed_shared_link_policy.

Return type:: bool

is_email_unverified()

Check if the union tag is email_unverified.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team_policy_disallows_member_policy()

Check if the union tag is team_policy_disallows_member_policy.

Return type:: bool

other = ShareFolderErrorBase('other', None)

team_policy_disallows_member_policy = ShareFolderErrorBase('team_policy_disallows_member_policy', None)

class dropbox.sharing.ShareFolderJobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: ShareFolderJobStatus.complete (SharedFolderMetadata) – The share job has finished. The value is the metadata for the folder.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:: val (SharedFolderMetadata) –
Return type:: ShareFolderJobStatus

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:: val (ShareFolderError) –
Return type:: ShareFolderJobStatus

get_complete()

The share job has finished. The value is the metadata for the folder.

Only call this if is_complete() is true.

Return type:: SharedFolderMetadata

get_failed()

Only call this if is_failed() is true.

Return type:: ShareFolderError

is_complete()

Check if the union tag is complete.

Return type:: bool

is_failed()

Check if the union tag is failed.

Return type:: bool

class dropbox.sharing.ShareFolderLaunch(tag, value=None)

Bases: LaunchResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:: val (SharedFolderMetadata) –
Return type:: ShareFolderLaunch

get_complete()

Only call this if is_complete() is true.

Return type:: SharedFolderMetadata

is_complete()

Check if the union tag is complete.

Return type:: bool

class dropbox.sharing.SharePathError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharePathError.is_file – A file is at the specified path.
sharing.SharePathError.inside_shared_folder – We do not support sharing a folder inside a shared folder.
sharing.SharePathError.contains_shared_folder – We do not support shared folders that contain shared folders.
sharing.SharePathError.contains_app_folder – We do not support shared folders that contain app folders.
sharing.SharePathError.contains_team_folder – We do not support shared folders that contain team folders.
sharing.SharePathError.is_app_folder – We do not support sharing an app folder.
sharing.SharePathError.inside_app_folder – We do not support sharing a folder inside an app folder.
sharing.SharePathError.is_public_folder – A public folder can’t be shared this way. Use a public link instead.
sharing.SharePathError.inside_public_folder – A folder inside a public folder can’t be shared this way. Use a public link instead.
SharePathError.already_shared (SharedFolderMetadata) – Folder is already shared. Contains metadata about the existing shared folder.
sharing.SharePathError.invalid_path – Path is not valid.
sharing.SharePathError.is_osx_package – We do not support sharing a Mac OS X package.
sharing.SharePathError.inside_osx_package – We do not support sharing a folder inside a Mac OS X package.
sharing.SharePathError.is_vault – We do not support sharing the Vault folder.
sharing.SharePathError.is_vault_locked – We do not support sharing a folder inside a locked Vault.
sharing.SharePathError.is_family – We do not support sharing the Family folder.

classmethod already_shared(val)

Create an instance of this class set to the already_shared tag with value val.

Parameters:: val (SharedFolderMetadata) –
Return type:: SharePathError

contains_app_folder = SharePathError('contains_app_folder', None)

contains_shared_folder = SharePathError('contains_shared_folder', None)

contains_team_folder = SharePathError('contains_team_folder', None)

get_already_shared()

Folder is already shared. Contains metadata about the existing shared folder.

Only call this if is_already_shared() is true.

Return type:: SharedFolderMetadata

inside_app_folder = SharePathError('inside_app_folder', None)

inside_osx_package = SharePathError('inside_osx_package', None)

inside_public_folder = SharePathError('inside_public_folder', None)

inside_shared_folder = SharePathError('inside_shared_folder', None)

invalid_path = SharePathError('invalid_path', None)

is_already_shared()

Check if the union tag is already_shared.

Return type:: bool

is_app_folder = SharePathError('is_app_folder', None)

is_contains_app_folder()

Check if the union tag is contains_app_folder.

Return type:: bool

is_contains_shared_folder()

Check if the union tag is contains_shared_folder.

Return type:: bool

is_contains_team_folder()

Check if the union tag is contains_team_folder.

Return type:: bool

is_family = SharePathError('is_family', None)

is_file = SharePathError('is_file', None)

is_inside_app_folder()

Check if the union tag is inside_app_folder.

Return type:: bool

is_inside_osx_package()

Check if the union tag is inside_osx_package.

Return type:: bool

is_inside_public_folder()

Check if the union tag is inside_public_folder.

Return type:: bool

is_inside_shared_folder()

Check if the union tag is inside_shared_folder.

Return type:: bool

is_invalid_path()

Check if the union tag is invalid_path.

Return type:: bool

is_is_app_folder()

Check if the union tag is is_app_folder.

Return type:: bool

is_is_family()

Check if the union tag is is_family.

Return type:: bool

is_is_file()

Check if the union tag is is_file.

Return type:: bool

is_is_osx_package()

Check if the union tag is is_osx_package.

Return type:: bool

is_is_public_folder()

Check if the union tag is is_public_folder.

Return type:: bool

is_is_vault()

Check if the union tag is is_vault.

Return type:: bool

is_is_vault_locked()

Check if the union tag is is_vault_locked.

Return type:: bool

is_osx_package = SharePathError('is_osx_package', None)

is_other()

Check if the union tag is other.

Return type:: bool

is_public_folder = SharePathError('is_public_folder', None)

is_vault = SharePathError('is_vault', None)

is_vault_locked = SharePathError('is_vault_locked', None)

other = SharePathError('other', None)

class dropbox.sharing.SharedContentLinkMetadata(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, url=None, access_level=None, audience_restricting_shared_folder=None, expiry=None, audience_exceptions=None)

Bases: SharedContentLinkMetadataBase

Metadata of a shared link for a file or folder.

Variables:

sharing.SharedContentLinkMetadata.audience_exceptions – The content inside this folder with link audience different than this folder’s. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.
sharing.SharedContentLinkMetadata.url – The URL of the link.

__init__(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, url=None, access_level=None, audience_restricting_shared_folder=None, expiry=None, audience_exceptions=None)

audience_exceptions

url

class dropbox.sharing.SharedContentLinkMetadataBase(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

Bases: Struct

Variables:

sharing.SharedContentLinkMetadataBase.access_level – The access level on the link for this file.
sharing.SharedContentLinkMetadataBase.audience_options – The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The ‘default’ audience option is always available if the user can modify link settings.

:ivar: sharing.SharedContentLinkMetadataBase.audience_restricting_shared_folder: The shared folder that prevents the link audience for this link from being more restrictive.

Variables:

sharing.SharedContentLinkMetadataBase.current_audience – The current audience of the link.
sharing.SharedContentLinkMetadataBase.expiry – Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.
sharing.SharedContentLinkMetadataBase.link_permissions – A list of permissions for actions you can perform on the link.
sharing.SharedContentLinkMetadataBase.password_protected – Whether the link is protected by a password.

__init__(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

access_level

audience_options

audience_restricting_shared_folder

current_audience

expiry

link_permissions

password_protected

class dropbox.sharing.SharedFileMembers(users=None, groups=None, invitees=None, cursor=None)

Bases: Struct

Shared file user, group, and invitee membership. Used for the results of dropbox.dropbox_client.Dropbox.sharing_list_file_members() and dropbox.dropbox_client.Dropbox.sharing_list_file_members_continue(), and used as part of the results for dropbox.dropbox_client.Dropbox.sharing_list_file_members_batch().

Variables:

sharing.SharedFileMembers.users – The list of user members of the shared file.
sharing.SharedFileMembers.groups – The list of group members of the shared file.
sharing.SharedFileMembers.invitees – The list of invited members of a file, but have not logged in and claimed this.
sharing.SharedFileMembers.cursor – Present if there are additional shared file members that have not been returned yet. Pass the cursor into dropbox.dropbox_client.Dropbox.sharing_list_file_members_continue() to list additional members.

__init__(users=None, groups=None, invitees=None, cursor=None)

cursor

groups

invitees

users

class dropbox.sharing.SharedFileMetadata(id=None, name=None, policy=None, preview_url=None, access_type=None, expected_link_metadata=None, link_metadata=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, permissions=None, time_invited=None)

Bases: Struct

Properties of the shared file.

Variables:

sharing.SharedFileMetadata.access_type – The current user’s access level for this shared file.
sharing.SharedFileMetadata.id – The ID of the file.
sharing.SharedFileMetadata.expected_link_metadata – The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.
sharing.SharedFileMetadata.link_metadata – The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.
sharing.SharedFileMetadata.name – The name of this file.
sharing.SharedFileMetadata.owner_display_names – The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
sharing.SharedFileMetadata.owner_team – The team that owns the file. This field is not present if the file is not owned by a team.
sharing.SharedFileMetadata.parent_shared_folder_id – The ID of the parent shared folder. This field is present only if the file is contained within a shared folder.
sharing.SharedFileMetadata.path_display – The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user’s filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.
sharing.SharedFileMetadata.path_lower – The lower-case full path of this file. Absent for unmounted files.
sharing.SharedFileMetadata.permissions – The sharing permissions that requesting user has on this file. This corresponds to the entries given in GetFileMetadataBatchArg.actions or GetFileMetadataArg.actions.
sharing.SharedFileMetadata.policy – Policies governing this shared file.
sharing.SharedFileMetadata.preview_url – URL for displaying a web preview of the shared file.
sharing.SharedFileMetadata.time_invited – Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

__init__(id=None, name=None, policy=None, preview_url=None, access_type=None, expected_link_metadata=None, link_metadata=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, permissions=None, time_invited=None)

access_type

expected_link_metadata

id

link_metadata

name

owner_display_names

owner_team

parent_shared_folder_id

path_display

path_lower

permissions

policy

preview_url

time_invited

class dropbox.sharing.SharedFolderAccessError(tag, value=None)

Bases: Union

There is an error accessing the shared folder.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharedFolderAccessError.invalid_id – This shared folder ID is invalid.
sharing.SharedFolderAccessError.not_a_member – The user is not a member of the shared folder thus cannot access it.
sharing.SharedFolderAccessError.invalid_member – The user does not exist or their account is disabled.
sharing.SharedFolderAccessError.email_unverified – Never set.
sharing.SharedFolderAccessError.unmounted – The shared folder is unmounted.

email_unverified = SharedFolderAccessError('email_unverified', None)

invalid_id = SharedFolderAccessError('invalid_id', None)

invalid_member = SharedFolderAccessError('invalid_member', None)

is_email_unverified()

Check if the union tag is email_unverified.

Return type:: bool

is_invalid_id()

Check if the union tag is invalid_id.

Return type:: bool

is_invalid_member()

Check if the union tag is invalid_member.

Return type:: bool

is_not_a_member()

Check if the union tag is not_a_member.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_unmounted()

Check if the union tag is unmounted.

Return type:: bool

not_a_member = SharedFolderAccessError('not_a_member', None)

other = SharedFolderAccessError('other', None)

unmounted = SharedFolderAccessError('unmounted', None)

class dropbox.sharing.SharedFolderMemberError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharedFolderMemberError.invalid_dropbox_id – The target dropbox_id is invalid.
sharing.SharedFolderMemberError.not_a_member – The target dropbox_id is not a member of the shared folder.
SharedFolderMemberError.no_explicit_access (MemberAccessLevelResult) – The target member only has inherited access to the shared folder.

get_no_explicit_access()

The target member only has inherited access to the shared folder.

Only call this if is_no_explicit_access() is true.

Return type:: MemberAccessLevelResult

invalid_dropbox_id = SharedFolderMemberError('invalid_dropbox_id', None)

is_invalid_dropbox_id()

Check if the union tag is invalid_dropbox_id.

Return type:: bool

is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:: bool

is_not_a_member()

Check if the union tag is not_a_member.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

classmethod no_explicit_access(val)

Create an instance of this class set to the no_explicit_access tag with value val.

Parameters:: val (MemberAccessLevelResult) –
Return type:: SharedFolderMemberError

not_a_member = SharedFolderMemberError('not_a_member', None)

other = SharedFolderMemberError('other', None)

class dropbox.sharing.SharedFolderMembers(users=None, groups=None, invitees=None, cursor=None)

Bases: Struct

Shared folder user and group membership.

Variables:

sharing.SharedFolderMembers.users – The list of user members of the shared folder.
sharing.SharedFolderMembers.groups – The list of group members of the shared folder.
sharing.SharedFolderMembers.invitees – The list of invitees to the shared folder.
sharing.SharedFolderMembers.cursor – Present if there are additional shared folder members that have not been returned yet. Pass the cursor into dropbox.dropbox_client.Dropbox.sharing_list_folder_members_continue() to list additional members.

__init__(users=None, groups=None, invitees=None, cursor=None)

cursor

groups

invitees

users

class dropbox.sharing.SharedFolderMetadata(access_type=None, is_inside_team_folder=None, is_team_folder=None, name=None, policy=None, preview_url=None, shared_folder_id=None, time_invited=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, parent_folder_name=None, link_metadata=None, permissions=None, access_inheritance=None)

Bases: SharedFolderMetadataBase

The metadata which includes basic information about the shared folder.

Variables:

sharing.SharedFolderMetadata.link_metadata – The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.
sharing.SharedFolderMetadata.name – The name of the this shared folder.
sharing.SharedFolderMetadata.permissions – Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.
sharing.SharedFolderMetadata.policy – Policies governing this shared folder.
sharing.SharedFolderMetadata.preview_url – URL for displaying a web preview of the shared folder.
sharing.SharedFolderMetadata.shared_folder_id – The ID of the shared folder.
sharing.SharedFolderMetadata.time_invited – Timestamp indicating when the current user was invited to this shared folder.
sharing.SharedFolderMetadata.access_inheritance – Whether the folder inherits its members from its parent.

__init__(access_type=None, is_inside_team_folder=None, is_team_folder=None, name=None, policy=None, preview_url=None, shared_folder_id=None, time_invited=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, parent_folder_name=None, link_metadata=None, permissions=None, access_inheritance=None)

access_inheritance

link_metadata

name

permissions

policy

preview_url

shared_folder_id

time_invited

class dropbox.sharing.SharedFolderMetadataBase(access_type=None, is_inside_team_folder=None, is_team_folder=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, parent_folder_name=None)

Bases: Struct

Properties of the shared folder.

Variables:

sharing.SharedFolderMetadataBase.access_type – The current user’s access level for this shared folder.
sharing.SharedFolderMetadataBase.is_inside_team_folder – Whether this folder is inside of a team folder.
sharing.SharedFolderMetadataBase.is_team_folder – Whether this folder is a team folder.
sharing.SharedFolderMetadataBase.owner_display_names – The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.
sharing.SharedFolderMetadataBase.owner_team – The team that owns the folder. This field is not present if the folder is not owned by a team.
sharing.SharedFolderMetadataBase.parent_shared_folder_id – The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
sharing.SharedFolderMetadataBase.path_display – The full path of this shared folder. Absent for unmounted folders.
sharing.SharedFolderMetadataBase.path_lower – The lower-cased full path of this shared folder. Absent for unmounted folders.
sharing.SharedFolderMetadataBase.parent_folder_name – Display name for the parent folder.

__init__(access_type=None, is_inside_team_folder=None, is_team_folder=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_display=None, path_lower=None, parent_folder_name=None)

access_type

is_inside_team_folder

is_team_folder

owner_display_names

owner_team

parent_folder_name

parent_shared_folder_id

path_display

path_lower

class dropbox.sharing.SharedLinkAccessFailureReason(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharedLinkAccessFailureReason.login_required – User is not logged in.
sharing.SharedLinkAccessFailureReason.email_verify_required –
This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.
sharing.SharedLinkAccessFailureReason.password_required – The link is password protected.
sharing.SharedLinkAccessFailureReason.team_only – Access is allowed for team members only.
sharing.SharedLinkAccessFailureReason.owner_only – Access is allowed for the shared link’s owner only.

email_verify_required = SharedLinkAccessFailureReason('email_verify_required', None)

is_email_verify_required()

Check if the union tag is email_verify_required.

Return type:: bool

is_login_required()

Check if the union tag is login_required.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_owner_only()

Check if the union tag is owner_only.

Return type:: bool

is_password_required()

Check if the union tag is password_required.

Return type:: bool

is_team_only()

Check if the union tag is team_only.

Return type:: bool

login_required = SharedLinkAccessFailureReason('login_required', None)

other = SharedLinkAccessFailureReason('other', None)

owner_only = SharedLinkAccessFailureReason('owner_only', None)

password_required = SharedLinkAccessFailureReason('password_required', None)

team_only = SharedLinkAccessFailureReason('team_only', None)

class dropbox.sharing.SharedLinkAlreadyExistsMetadata(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:: SharedLinkAlreadyExistsMetadata.metadata (SharedLinkMetadata) – Metadata of the shared link that already exists.

get_metadata()

Metadata of the shared link that already exists.

Only call this if is_metadata() is true.

Return type:: SharedLinkMetadata

is_metadata()

Check if the union tag is metadata.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

classmethod metadata(val)

Create an instance of this class set to the metadata tag with value val.

Parameters:: val (SharedLinkMetadata) –
Return type:: SharedLinkAlreadyExistsMetadata

other = SharedLinkAlreadyExistsMetadata('other', None)

class dropbox.sharing.SharedLinkError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharedLinkError.shared_link_not_found – The shared link wasn’t found.
sharing.SharedLinkError.shared_link_access_denied – The caller is not allowed to access this shared link.
sharing.SharedLinkError.unsupported_link_type – This type of link is not supported; use dropbox.dropbox_client.Dropbox.sharing_files() instead.

is_other()

Check if the union tag is other.

Return type:: bool

is_shared_link_access_denied()

Check if the union tag is shared_link_access_denied.

Return type:: bool

is_shared_link_not_found()

Check if the union tag is shared_link_not_found.

Return type:: bool

is_unsupported_link_type()

Check if the union tag is unsupported_link_type.

Return type:: bool

other = SharedLinkError('other', None)

shared_link_access_denied = SharedLinkError('shared_link_access_denied', None)

shared_link_not_found = SharedLinkError('shared_link_not_found', None)

unsupported_link_type = SharedLinkError('unsupported_link_type', None)

class dropbox.sharing.SharedLinkMetadata(url=None, name=None, link_permissions=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

Bases: Struct

The metadata of a shared link.

Variables:

sharing.SharedLinkMetadata.url – URL of the shared link.
sharing.SharedLinkMetadata.id – A unique identifier for the linked file.
sharing.SharedLinkMetadata.name – The linked file name (including extension). This never contains a slash.
sharing.SharedLinkMetadata.expires – Expiration time, if set. By default the link won’t expire.
sharing.SharedLinkMetadata.path_lower – The lowercased full path in the user’s Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user’s dropbox.
sharing.SharedLinkMetadata.link_permissions – The link’s access permissions.
sharing.SharedLinkMetadata.team_member_info – The team membership information of the link’s owner. This field will only be present if the link’s owner is a team member.
sharing.SharedLinkMetadata.content_owner_team_info – The team information of the content’s owner. This field will only be present if the content’s owner is a team member and the content’s owner team is different from the link’s owner team.

__init__(url=None, name=None, link_permissions=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

content_owner_team_info

expires

id

link_permissions

name

path_lower

team_member_info

url

class dropbox.sharing.SharedLinkPolicy(tag, value=None)

Bases: Union

Who can view shared links in this folder.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharedLinkPolicy.anyone – Links can be shared with anyone.
sharing.SharedLinkPolicy.team – Links can be shared with anyone on the same team as the owner.
sharing.SharedLinkPolicy.members – Links can only be shared among members of the shared folder.

anyone = SharedLinkPolicy('anyone', None)

is_anyone()

Check if the union tag is anyone.

Return type:: bool

is_members()

Check if the union tag is members.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team()

Check if the union tag is team.

Return type:: bool

members = SharedLinkPolicy('members', None)

other = SharedLinkPolicy('other', None)

team = SharedLinkPolicy('team', None)

class dropbox.sharing.SharedLinkSettings(require_password=None, link_password=None, expires=None, audience=None, access=None, requested_visibility=None, allow_download=None)

Bases: Struct

Variables:

sharing.SharedLinkSettings.require_password – Boolean flag to enable or disable password protection.
sharing.SharedLinkSettings.link_password – If require_password is true, this is needed to specify the password to access the link.
sharing.SharedLinkSettings.expires – Expiration time of the shared link. By default the link won’t expire.
sharing.SharedLinkSettings.audience – The new audience who can benefit from the access level specified by the link’s access level specified in the link_access_level field of LinkPermissions. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the effective_audience field of `LinkPermissions.
sharing.SharedLinkSettings.access – Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.
sharing.SharedLinkSettings.requested_visibility – Use audience instead. The requested access for this shared link.
sharing.SharedLinkSettings.allow_download – Boolean flag to allow or not download capabilities for shared links.

__init__(require_password=None, link_password=None, expires=None, audience=None, access=None, requested_visibility=None, allow_download=None)

access

allow_download

audience

expires

link_password

requested_visibility

require_password

class dropbox.sharing.SharedLinkSettingsError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharedLinkSettingsError.invalid_settings – The given settings are invalid (for example, all attributes of the SharedLinkSettings are empty, the requested visibility is RequestedVisibility.password but the SharedLinkSettings.link_password is missing, SharedLinkSettings.expires is set to the past, etc.).
sharing.SharedLinkSettingsError.not_authorized – User is not allowed to modify the settings of this link. Note that basic users can only set RequestedVisibility.public as the SharedLinkSettings.requested_visibility and cannot set SharedLinkSettings.expires.

invalid_settings = SharedLinkSettingsError('invalid_settings', None)

is_invalid_settings()

Check if the union tag is invalid_settings.

Return type:: bool

is_not_authorized()

Check if the union tag is not_authorized.

Return type:: bool

not_authorized = SharedLinkSettingsError('not_authorized', None)

class dropbox.sharing.SharingFileAccessError(tag, value=None)

Bases: Union

User could not access this file.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharingFileAccessError.no_permission – Current user does not have sufficient privileges to perform the desired action.
sharing.SharingFileAccessError.invalid_file – File specified was not found.
sharing.SharingFileAccessError.is_folder – A folder can’t be shared this way. Use folder sharing or a shared link instead.
sharing.SharingFileAccessError.inside_public_folder – A file inside a public folder can’t be shared this way. Use a public link instead.
sharing.SharingFileAccessError.inside_osx_package – A Mac OS X package can’t be shared this way. Use a shared link instead.

inside_osx_package = SharingFileAccessError('inside_osx_package', None)

inside_public_folder = SharingFileAccessError('inside_public_folder', None)

invalid_file = SharingFileAccessError('invalid_file', None)

is_folder = SharingFileAccessError('is_folder', None)

is_inside_osx_package()

Check if the union tag is inside_osx_package.

Return type:: bool

is_inside_public_folder()

Check if the union tag is inside_public_folder.

Return type:: bool

is_invalid_file()

Check if the union tag is invalid_file.

Return type:: bool

is_is_folder()

Check if the union tag is is_folder.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

no_permission = SharingFileAccessError('no_permission', None)

other = SharingFileAccessError('other', None)

class dropbox.sharing.SharingUserError(tag, value=None)

Bases: Union

User account had a problem preventing this action.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.SharingUserError.email_unverified –

This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.

email_unverified = SharingUserError('email_unverified', None)

is_email_unverified()

Check if the union tag is email_unverified.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

other = SharingUserError('other', None)

class dropbox.sharing.TeamMemberInfo(team_info=None, display_name=None, member_id=None)

Bases: Struct

Information about a team member.

Variables:

sharing.TeamMemberInfo.team_info – Information about the member’s team.
sharing.TeamMemberInfo.display_name – The display name of the user.
sharing.TeamMemberInfo.member_id – ID of user as a member of a team. This field will only be present if the member is in the same team as current user.

__init__(team_info=None, display_name=None, member_id=None)

display_name

member_id

team_info

class dropbox.sharing.TransferFolderArg(shared_folder_id=None, to_dropbox_id=None)

Bases: Struct

Variables:

sharing.TransferFolderArg.shared_folder_id – The ID for the shared folder.
sharing.TransferFolderArg.to_dropbox_id – A account or team member ID to transfer ownership to.

__init__(shared_folder_id=None, to_dropbox_id=None)

shared_folder_id

to_dropbox_id

class dropbox.sharing.TransferFolderError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.TransferFolderError.invalid_dropbox_id – TransferFolderArg.to_dropbox_id is invalid.
sharing.TransferFolderError.new_owner_not_a_member – The new designated owner is not currently a member of the shared folder.
sharing.TransferFolderError.new_owner_unmounted – The new designated owner has not added the folder to their Dropbox.
sharing.TransferFolderError.new_owner_email_unverified –
The new designated owner’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.
sharing.TransferFolderError.team_folder – This action cannot be performed on a team shared folder.
sharing.TransferFolderError.no_permission – The current user does not have permission to perform this action.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: TransferFolderError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

invalid_dropbox_id = TransferFolderError('invalid_dropbox_id', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_invalid_dropbox_id()

Check if the union tag is invalid_dropbox_id.

Return type:: bool

is_new_owner_email_unverified()

Check if the union tag is new_owner_email_unverified.

Return type:: bool

is_new_owner_not_a_member()

Check if the union tag is new_owner_not_a_member.

Return type:: bool

is_new_owner_unmounted()

Check if the union tag is new_owner_unmounted.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team_folder()

Check if the union tag is team_folder.

Return type:: bool

new_owner_email_unverified = TransferFolderError('new_owner_email_unverified', None)

new_owner_not_a_member = TransferFolderError('new_owner_not_a_member', None)

new_owner_unmounted = TransferFolderError('new_owner_unmounted', None)

no_permission = TransferFolderError('no_permission', None)

other = TransferFolderError('other', None)

team_folder = TransferFolderError('team_folder', None)

class dropbox.sharing.UnmountFolderArg(shared_folder_id=None)

Bases: Struct

Variables:: sharing.UnmountFolderArg.shared_folder_id – The ID for the shared folder.

__init__(shared_folder_id=None)

shared_folder_id

class dropbox.sharing.UnmountFolderError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.UnmountFolderError.no_permission – The current user does not have permission to perform this action.
sharing.UnmountFolderError.not_unmountable – The shared folder can’t be unmounted. One example where this can occur is when the shared folder’s parent folder is also a shared folder that resides in the current user’s Dropbox.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: UnmountFolderError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_not_unmountable()

Check if the union tag is not_unmountable.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

no_permission = UnmountFolderError('no_permission', None)

not_unmountable = UnmountFolderError('not_unmountable', None)

other = UnmountFolderError('other', None)

class dropbox.sharing.UnshareFileArg(file=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_unshare_file().

Variables:: sharing.UnshareFileArg.file – The file to unshare.

__init__(file=None)

file

class dropbox.sharing.UnshareFileError(tag, value=None)

Bases: Union

Error result for dropbox.dropbox_client.Dropbox.sharing_unshare_file().

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharingFileAccessError) –
Return type:: UnshareFileError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharingFileAccessError

get_user_error()

Only call this if is_user_error() is true.

Return type:: SharingUserError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_user_error()

Check if the union tag is user_error.

Return type:: bool

other = UnshareFileError('other', None)

classmethod user_error(val)

Create an instance of this class set to the user_error tag with value val.

Parameters:: val (SharingUserError) –
Return type:: UnshareFileError

class dropbox.sharing.UnshareFolderArg(shared_folder_id=None, leave_a_copy=None)

Bases: Struct

Variables:

sharing.UnshareFolderArg.shared_folder_id – The ID for the shared folder.
sharing.UnshareFolderArg.leave_a_copy – 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.

__init__(shared_folder_id=None, leave_a_copy=None)

leave_a_copy

shared_folder_id

class dropbox.sharing.UnshareFolderError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.UnshareFolderError.team_folder – This action cannot be performed on a team shared folder.
sharing.UnshareFolderError.no_permission – The current user does not have permission to perform this action.
sharing.UnshareFolderError.too_many_files – This shared folder has too many files to be unshared.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: UnshareFolderError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team_folder()

Check if the union tag is team_folder.

Return type:: bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:: bool

no_permission = UnshareFolderError('no_permission', None)

other = UnshareFolderError('other', None)

team_folder = UnshareFolderError('team_folder', None)

too_many_files = UnshareFolderError('too_many_files', None)

class dropbox.sharing.UpdateFileMemberArgs(file=None, member=None, access_level=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.sharing_update_file_member().

Variables:

sharing.UpdateFileMemberArgs.file – File for which we are changing a member’s access.
sharing.UpdateFileMemberArgs.member – The member whose access we are changing.
sharing.UpdateFileMemberArgs.access_level – The new access level for the member.

__init__(file=None, member=None, access_level=None)

access_level

file

member

class dropbox.sharing.UpdateFolderMemberArg(shared_folder_id=None, member=None, access_level=None)

Bases: Struct

Variables:

sharing.UpdateFolderMemberArg.shared_folder_id – The ID for the shared folder.
sharing.UpdateFolderMemberArg.member – The member of the shared folder to update. Only the MemberSelector.dropbox_id may be set at this time.
sharing.UpdateFolderMemberArg.access_level – The new access level for member. AccessLevel.owner is disallowed.

__init__(shared_folder_id=None, member=None, access_level=None)

access_level

member

shared_folder_id

class dropbox.sharing.UpdateFolderMemberError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

UpdateFolderMemberError.no_explicit_access (AddFolderMemberError) – If updating the access type required the member to be added to the shared folder and there was an error when adding the member.
sharing.UpdateFolderMemberError.insufficient_plan – The current user’s account doesn’t support this action. An example of this is when downgrading a member from editor to viewer. This action can only be performed by users that have upgraded to a Pro or Business plan.
sharing.UpdateFolderMemberError.no_permission – The current user does not have permission to perform this action.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: UpdateFolderMemberError

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

get_member_error()

Only call this if is_member_error() is true.

Return type:: SharedFolderMemberError

get_no_explicit_access()

If updating the access type required the member to be added to the shared folder and there was an error when adding the member.

Only call this if is_no_explicit_access() is true.

Return type:: AddFolderMemberError

insufficient_plan = UpdateFolderMemberError('insufficient_plan', None)

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_insufficient_plan()

Check if the union tag is insufficient_plan.

Return type:: bool

is_member_error()

Check if the union tag is member_error.

Return type:: bool

is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

classmethod member_error(val)

Create an instance of this class set to the member_error tag with value val.

Parameters:: val (SharedFolderMemberError) –
Return type:: UpdateFolderMemberError

classmethod no_explicit_access(val)

Create an instance of this class set to the no_explicit_access tag with value val.

Parameters:: val (AddFolderMemberError) –
Return type:: UpdateFolderMemberError

no_permission = UpdateFolderMemberError('no_permission', None)

other = UpdateFolderMemberError('other', None)

class dropbox.sharing.UpdateFolderPolicyArg(shared_folder_id=None, member_policy=None, acl_update_policy=None, viewer_info_policy=None, shared_link_policy=None, link_settings=None, actions=None)

Bases: Struct

If any of the policies are unset, then they retain their current setting.

Variables:

sharing.UpdateFolderPolicyArg.shared_folder_id – The ID for the shared folder.
sharing.UpdateFolderPolicyArg.member_policy – Who can be a member of this shared folder. Only applicable if the current user is on a team.
sharing.UpdateFolderPolicyArg.acl_update_policy – Who can add and remove members of this shared folder.
sharing.UpdateFolderPolicyArg.viewer_info_policy – Who can enable/disable viewer info for this shared folder.
sharing.UpdateFolderPolicyArg.shared_link_policy – The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.
sharing.UpdateFolderPolicyArg.link_settings – Settings on the link for this folder.
sharing.UpdateFolderPolicyArg.actions – A list of FolderAction`s corresponding to `FolderPermission`s that should appear in the response’s ``SharedFolderMetadata.permissions` field describing the actions the authenticated user can perform on the folder.

__init__(shared_folder_id=None, member_policy=None, acl_update_policy=None, viewer_info_policy=None, shared_link_policy=None, link_settings=None, actions=None)

acl_update_policy

actions

link_settings

member_policy

shared_folder_id

shared_link_policy

viewer_info_policy

class dropbox.sharing.UpdateFolderPolicyError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.UpdateFolderPolicyError.not_on_team – UpdateFolderPolicyArg.member_policy was set even though user is not on a team.
sharing.UpdateFolderPolicyError.team_policy_disallows_member_policy – Team policy is more restrictive than ShareFolderArg.member_policy.
sharing.UpdateFolderPolicyError.disallowed_shared_link_policy – The current account is not allowed to select the specified ShareFolderArg.shared_link_policy.
sharing.UpdateFolderPolicyError.no_permission – The current user does not have permission to perform this action.
sharing.UpdateFolderPolicyError.team_folder – This action cannot be performed on a team shared folder.

classmethod access_error(val)

Create an instance of this class set to the access_error tag with value val.

Parameters:: val (SharedFolderAccessError) –
Return type:: UpdateFolderPolicyError

disallowed_shared_link_policy = UpdateFolderPolicyError('disallowed_shared_link_policy', None)

get_access_error()

Only call this if is_access_error() is true.

Return type:: SharedFolderAccessError

is_access_error()

Check if the union tag is access_error.

Return type:: bool

is_disallowed_shared_link_policy()

Check if the union tag is disallowed_shared_link_policy.

Return type:: bool

is_no_permission()

Check if the union tag is no_permission.

Return type:: bool

is_not_on_team()

Check if the union tag is not_on_team.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_team_folder()

Check if the union tag is team_folder.

Return type:: bool

is_team_policy_disallows_member_policy()

Check if the union tag is team_policy_disallows_member_policy.

Return type:: bool

no_permission = UpdateFolderPolicyError('no_permission', None)

not_on_team = UpdateFolderPolicyError('not_on_team', None)

other = UpdateFolderPolicyError('other', None)

team_folder = UpdateFolderPolicyError('team_folder', None)

team_policy_disallows_member_policy = UpdateFolderPolicyError('team_policy_disallows_member_policy', None)

class dropbox.sharing.UserFileMembershipInfo(access_type=None, user=None, permissions=None, initials=None, is_inherited=None, time_last_seen=None, platform_type=None)

Bases: UserMembershipInfo

The information about a user member of the shared content with an appended last seen timestamp.

Variables:

sharing.UserFileMembershipInfo.time_last_seen – The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history.
sharing.UserFileMembershipInfo.platform_type – The platform on which the user has last seen the content, or unknown.

__init__(access_type=None, user=None, permissions=None, initials=None, is_inherited=None, time_last_seen=None, platform_type=None)

platform_type

time_last_seen

class dropbox.sharing.UserInfo(account_id=None, email=None, display_name=None, same_team=None, team_member_id=None)

Bases: Struct

Basic information about a user. Use dropbox.dropbox_client.Dropbox.sharing_users_account() and dropbox.dropbox_client.Dropbox.sharing_users_account_batch() to obtain more detailed information.

Variables:

sharing.UserInfo.account_id – The account ID of the user.
sharing.UserInfo.email – Email address of user.
sharing.UserInfo.display_name – The display name of the user.
sharing.UserInfo.same_team – If the user is in the same team as current user.
sharing.UserInfo.team_member_id – The team member ID of the shared folder member. Only present if same_team is true.

__init__(account_id=None, email=None, display_name=None, same_team=None, team_member_id=None)

account_id

display_name

email

same_team

team_member_id

class dropbox.sharing.UserMembershipInfo(access_type=None, user=None, permissions=None, initials=None, is_inherited=None)

Bases: MembershipInfo

The information about a user member of the shared content.

Variables:: sharing.UserMembershipInfo.user – The account information for the membership user.

__init__(access_type=None, user=None, permissions=None, initials=None, is_inherited=None)

user

class dropbox.sharing.ViewerInfoPolicy(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.ViewerInfoPolicy.enabled – Viewer information is available on this file.
sharing.ViewerInfoPolicy.disabled – Viewer information is disabled on this file.

disabled = ViewerInfoPolicy('disabled', None)

enabled = ViewerInfoPolicy('enabled', None)

is_disabled()

Check if the union tag is disabled.

Return type:: bool

is_enabled()

Check if the union tag is enabled.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

other = ViewerInfoPolicy('other', None)

class dropbox.sharing.Visibility(tag, value=None)

Bases: Union

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.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.Visibility.public – Anyone who has received the link can access it. No login required.
sharing.Visibility.team_only – Only members of the same team can access the link. Login is required.
sharing.Visibility.password – A link-specific password is required to access the link. Login is not required.
sharing.Visibility.team_and_password – Only members of the same team who have the link-specific password can access the link.
sharing.Visibility.shared_folder_only – Only members of the shared folder containing the linked file can access the link. Login is required.

is_other()

Check if the union tag is other.

Return type:: bool

is_password()

Check if the union tag is password.

Return type:: bool

is_public()

Check if the union tag is public.

Return type:: bool

is_shared_folder_only()

Check if the union tag is shared_folder_only.

Return type:: bool

is_team_and_password()

Check if the union tag is team_and_password.

Return type:: bool

is_team_only()

Check if the union tag is team_only.

Return type:: bool

other = Visibility('other', None)

password = Visibility('password', None)

public = Visibility('public', None)

shared_folder_only = Visibility('shared_folder_only', None)

team_and_password = Visibility('team_and_password', None)

team_only = Visibility('team_only', None)

class dropbox.sharing.VisibilityPolicy(policy=None, resolved_policy=None, allowed=None, disallowed_reason=None)

Bases: Struct

Variables:

sharing.VisibilityPolicy.policy – This is the value to submit when saving the visibility setting.
sharing.VisibilityPolicy.resolved_policy – This is what the effective policy would be, if you selected this option. The resolved policy is obtained after considering external effects such as shared folder settings and team policy. This value is guaranteed to be provided.
sharing.VisibilityPolicy.allowed – Whether the user is permitted to set the visibility to this policy.
sharing.VisibilityPolicy.disallowed_reason – If allowed is False, this will provide the reason that the user is not permitted to set the visibility to this policy.

__init__(policy=None, resolved_policy=None, allowed=None, disallowed_reason=None)

allowed

disallowed_reason

policy

resolved_policy

class dropbox.sharing.VisibilityPolicyDisallowedReason(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

sharing.VisibilityPolicyDisallowedReason.delete_and_recreate – The user needs to delete and recreate the link to change the visibility policy.
sharing.VisibilityPolicyDisallowedReason.restricted_by_shared_folder – The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder.
sharing.VisibilityPolicyDisallowedReason.restricted_by_team – The team policy prevents links being shared outside the team.
sharing.VisibilityPolicyDisallowedReason.user_not_on_team – The user needs to be on a team to set this policy.
sharing.VisibilityPolicyDisallowedReason.user_account_type – The user is a basic user or is on a limited team.
sharing.VisibilityPolicyDisallowedReason.permission_denied – The user does not have permission.

delete_and_recreate = VisibilityPolicyDisallowedReason('delete_and_recreate', None)

is_delete_and_recreate()

Check if the union tag is delete_and_recreate.

Return type:: bool

is_other()

Check if the union tag is other.

Return type:: bool

is_permission_denied()

Check if the union tag is permission_denied.

Return type:: bool

is_restricted_by_shared_folder()

Check if the union tag is restricted_by_shared_folder.

Return type:: bool

is_restricted_by_team()

Check if the union tag is restricted_by_team.

Return type:: bool

is_user_account_type()

Check if the union tag is user_account_type.

Return type:: bool

is_user_not_on_team()

Check if the union tag is user_not_on_team.

Return type:: bool

other = VisibilityPolicyDisallowedReason('other', None)

permission_denied = VisibilityPolicyDisallowedReason('permission_denied', None)

restricted_by_shared_folder = VisibilityPolicyDisallowedReason('restricted_by_shared_folder', None)

restricted_by_team = VisibilityPolicyDisallowedReason('restricted_by_team', None)

user_account_type = VisibilityPolicyDisallowedReason('user_account_type', None)

user_not_on_team = VisibilityPolicyDisallowedReason('user_not_on_team', None)

dropbox.sharing – Sharing

`dropbox.sharing` – Sharing