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: dropbox.stone_base.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:
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: dropbox.stone_base.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:
editor = AccessLevel('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_owner()

Check if the union tag is owner.

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
other = AccessLevel('other', None)
owner = AccessLevel('owner', None)
viewer = AccessLevel('viewer', None)
viewer_no_comment = AccessLevel('viewer_no_comment', None)
class dropbox.sharing.AclUpdatePolicy(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.stone_base.Struct

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

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

x.__init__(…) initializes x; see help(type(x)) for signature

access_level

AccessLevel union object, describing what access level we want to give new members.

Return type:sharing.AccessLevel
add_message_as_comment

If the custom message should be added as a comment on the file.

Return type:bool
custom_message

Message to send to added members in their invitation.

Return type:str
file

File to which to add members.

Return type:str
members

Members to add. Note that even an email address is given, this may result in a user being directy added to the membership if that email is the user’s main account email.

Return type:list of [sharing.MemberSelector]
quiet

Whether added members should be notified via device notifications of their invitation.

Return type:bool
class dropbox.sharing.AddFileMemberError(tag, value=None)

Bases: dropbox.stone_base.Union

Errors for dropbox.dropbox.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharingFileAccessError) –
Return type:sharing.AddFileMemberError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.AddFileMemberError
class dropbox.sharing.AddFolderMemberArg(shared_folder_id=None, members=None, quiet=None, custom_message=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, members=None, quiet=None, custom_message=None)

x.__init__(…) initializes x; see help(type(x)) for signature

custom_message

Optional message to display to added members in their invitation.

Return type:str
members

The intended list of members to add. Added members will receive invites to join the shared folder.

Return type:list of [sharing.AddMember]
quiet

Whether added members should be notified via email and device notifications of their invite.

Return type:bool
shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.AddFolderMemberError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.AddFolderMemberError
classmethod bad_member(val)

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

Parameters:val (sharing.AddMemberSelectorError) –
Return type:sharing.AddFolderMemberError
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:sharing.SharedFolderAccessError
get_bad_member()

AddFolderMemberArg.members contains a bad invitation recipient.

Only call this if is_bad_member() is true.

Return type:sharing.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)
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_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_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:sharing.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:sharing.AddFolderMemberError
class dropbox.sharing.AddMember(member=None, access_level=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(member=None, access_level=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_level

The access level to grant member to the shared folder. AccessLevel.owner is disallowed.

Return type:sharing.AccessLevel
member

The member to add to the shared folder.

Return type:sharing.MemberSelector
class dropbox.sharing.AddMemberSelectorError(tag, value=None)

Bases: dropbox.stone_base.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:
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 e-mail address. Invite unverified users by e-mail 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:sharing.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:sharing.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:sharing.AddMemberSelectorError
class dropbox.sharing.AudienceExceptionContentInfo(name=None)

Bases: dropbox.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

name

The name of the content, which is either a file or a folder.

Return type:str
class dropbox.sharing.AudienceExceptions(count=None, exceptions=None)

Bases: dropbox.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

count
Return type:int
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.

Return type:list of [sharing.AudienceExceptionContentInfo]
class dropbox.sharing.AudienceRestrictingSharedFolder(shared_folder_id=None, name=None, audience=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(shared_folder_id=None, name=None, audience=None)

x.__init__(…) initializes x; see help(type(x)) for signature

audience

The link audience of the shared folder.

Return type:sharing.LinkAudience
name

The name of the shared folder.

Return type:str
shared_folder_id

The ID of the shared folder.

Return type:str
class dropbox.sharing.ChangeFileMemberAccessArgs(file=None, member=None, access_level=None)

Bases: dropbox.stone_base.Struct

Arguments for dropbox.dropbox.Dropbox.sharing_change_file_member_access().

Variables:
__init__(file=None, member=None, access_level=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_level

The new access level for the member.

Return type:sharing.AccessLevel
file

File for which we are changing a member’s access.

Return type:str
member

The member whose access we are changing.

Return type:sharing.MemberSelector
class dropbox.sharing.CollectionLinkMetadata(url=None, visibility=None, expires=None)

Bases: dropbox.sharing.LinkMetadata

Metadata for a collection-based shared link.

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.stone_base.Struct

Variables:
__init__(path=None, short_url=None, pending_upload=None)

x.__init__(…) initializes x; see help(type(x)) for signature

path

The path to share.

Return type:str
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.

Return type:sharing.PendingUploadMode
short_url

Whether to return a shortened URL.

Return type:bool
class dropbox.sharing.CreateSharedLinkError(tag, value=None)

Bases: dropbox.stone_base.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:sharing.CreateSharedLinkError
class dropbox.sharing.CreateSharedLinkWithSettingsArg(path=None, settings=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(path=None, settings=None)

x.__init__(…) initializes x; see help(type(x)) for signature

path

The path to be shared by the shared link.

Return type:str
settings

The requested settings for the newly created shared link.

Return type:sharing.SharedLinkSettings
class dropbox.sharing.CreateSharedLinkWithSettingsError(tag, value=None)

Bases: dropbox.stone_base.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:
:ivar SharedLinkSettingsError
sharing.CreateSharedLinkWithSettingsError.settings_error: There is an error with the given settings.
Variables:sharing.CreateSharedLinkWithSettingsError.access_denied – Access to the requested path is forbidden.
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:sharing.SharedLinkSettingsError
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

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:sharing.CreateSharedLinkWithSettingsError
classmethod settings_error(val)

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

Parameters:val (sharing.SharedLinkSettingsError) –
Return type:sharing.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: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.stone_base.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:
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)

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_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

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)
unshare = FileAction('unshare', None)
class dropbox.sharing.FileErrorResult(tag, value=None)

Bases: dropbox.stone_base.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:
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:sharing.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:sharing.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:sharing.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: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:datetime.datetime
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.

Return type:str
server_modified

The last time the file was modified on Dropbox.

Return type:datetime.datetime
size

The file size in bytes.

Return type:int
class dropbox.sharing.FileMemberActionError(tag, value=None)

Bases: dropbox.stone_base.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:
:ivar MemberAccessLevelResult
sharing.FileMemberActionError.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.
classmethod access_error(val)

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

Parameters:val (sharing.SharingFileAccessError) –
Return type:sharing.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:sharing.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:sharing.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 (sharing.MemberAccessLevelResult) –
Return type:sharing.FileMemberActionError
no_permission = FileMemberActionError('no_permission', None)
other = FileMemberActionError('other', None)
class dropbox.sharing.FileMemberActionIndividualResult(tag, value=None)

Bases: dropbox.stone_base.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[sharing.AccessLevel]
sharing.FileMemberActionIndividualResult.success: Member was successfully removed from this file. If AccessLevel is given, the member still has access via a parent shared folder.
:ivar FileMemberActionError
sharing.FileMemberActionIndividualResult.member_error: 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:sharing.FileMemberActionError
get_success()

Member was successfully removed from this 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:sharing.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 (sharing.FileMemberActionError) –
Return type:sharing.FileMemberActionIndividualResult
classmethod success(val)

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

Parameters:val (sharing.AccessLevel) –
Return type:sharing.FileMemberActionIndividualResult
class dropbox.sharing.FileMemberActionResult(member=None, result=None)

Bases: dropbox.stone_base.Struct

Per-member result for dropbox.dropbox.Dropbox.sharing_add_file_member() or dropbox.dropbox.Dropbox.sharing_change_file_member_access().

Variables:
__init__(member=None, result=None)

x.__init__(…) initializes x; see help(type(x)) for signature

member

One of specified input members.

Return type:sharing.MemberSelector
result

The outcome of the action on this member.

Return type:sharing.FileMemberActionIndividualResult
class dropbox.sharing.FileMemberRemoveActionResult(tag, value=None)

Bases: dropbox.stone_base.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.FileMemberRemoveActionResult.success (MemberAccessLevelResult) – Member was successfully removed from this file.
:ivar FileMemberActionError
sharing.FileMemberRemoveActionResult.member_error: 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:sharing.FileMemberActionError
get_success()

Member was successfully removed from this file.

Only call this if is_success() is true.

Return type:sharing.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 (sharing.FileMemberActionError) –
Return type:sharing.FileMemberRemoveActionResult
other = FileMemberRemoveActionResult('other', None)
classmethod success(val)

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

Parameters:val (sharing.MemberAccessLevelResult) –
Return type:sharing.FileMemberRemoveActionResult
class dropbox.sharing.FilePermission(action=None, allow=None, reason=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(action=None, allow=None, reason=None)

x.__init__(…) initializes x; see help(type(x)) for signature

action

The action that the user may wish to take on the file.

Return type:sharing.FileAction
allow

True if the user is allowed to take the action.

Return type:bool
reason

The reason why the user is denied the permission. Not present if the action is allowed.

Return type:sharing.PermissionDeniedReason
class dropbox.sharing.FolderAction(tag, value=None)

Bases: dropbox.stone_base.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:
change_options = FolderAction('change_options', 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

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

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)
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: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(action=None, allow=None, reason=None)

x.__init__(…) initializes x; see help(type(x)) for signature

action

The action that the user may wish to take on the folder.

Return type:sharing.FolderAction
allow

True if the user is allowed to take the action.

Return type:bool
reason

The reason why the user is denied the permission. Not present if the action is allowed, or if no reason is available.

Return type:sharing.PermissionDeniedReason
class dropbox.sharing.FolderPolicy(acl_update_policy=None, shared_link_policy=None, member_policy=None, resolved_member_policy=None, viewer_info_policy=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(acl_update_policy=None, shared_link_policy=None, member_policy=None, resolved_member_policy=None, viewer_info_policy=None)

x.__init__(…) initializes x; see help(type(x)) for signature

acl_update_policy

Who can add and remove members from this shared folder.

Return type:sharing.AclUpdatePolicy
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.

Return type:sharing.MemberPolicy
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.

Return type:sharing.MemberPolicy

Who links can be shared with.

Return type:sharing.SharedLinkPolicy
viewer_info_policy

Who can enable/disable viewer info for this shared folder.

Return type:sharing.ViewerInfoPolicy
class dropbox.sharing.GetFileMetadataArg(file=None, actions=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(file=None, actions=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.FileAction]
file

The file to query.

Return type:str
class dropbox.sharing.GetFileMetadataBatchArg(files=None, actions=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(files=None, actions=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.FileAction]
files

The files to query.

Return type:list of [str]
class dropbox.sharing.GetFileMetadataBatchResult(file=None, result=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(file=None, result=None)

x.__init__(…) initializes x; see help(type(x)) for signature

file

This is the input file identifier corresponding to one of GetFileMetadataBatchArg.files.

Return type:str
result

The result for this particular file.

Return type:sharing.GetFileMetadataIndividualResult
class dropbox.sharing.GetFileMetadataError(tag, value=None)

Bases: dropbox.stone_base.Union

Error result for dropbox.dropbox.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 (sharing.SharingFileAccessError) –
Return type:sharing.GetFileMetadataError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.GetFileMetadataError
class dropbox.sharing.GetFileMetadataIndividualResult(tag, value=None)

Bases: dropbox.stone_base.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.GetFileMetadataIndividualResult.metadata (SharedFileMetadata) – The result for this file if it was successful.
:ivar SharingFileAccessError
sharing.GetFileMetadataIndividualResult.access_error: 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 (sharing.SharingFileAccessError) –
Return type:sharing.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:sharing.SharingFileAccessError
get_metadata()

The result for this file if it was successful.

Only call this if is_metadata() is true.

Return type:sharing.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 (sharing.SharedFileMetadata) –
Return type:sharing.GetFileMetadataIndividualResult
other = GetFileMetadataIndividualResult('other', None)
class dropbox.sharing.GetMetadataArgs(shared_folder_id=None, actions=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, actions=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.FolderAction]
shared_folder_id

The ID for the shared folder.

Return type:str
dropbox.sharing.GetSharedLinkFileArg

alias of dropbox.sharing.GetSharedLinkMetadataArg

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

Bases: dropbox.sharing.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.

Check if the union tag is shared_link_is_directory.

Return type:bool
class dropbox.sharing.GetSharedLinkMetadataArg(url=None, path=None, link_password=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(url=None, path=None, link_password=None)

x.__init__(…) initializes x; see help(type(x)) for signature

If the shared link has a password, this parameter can be used.

Return type:str
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.

Return type:str
url

URL of the shared link.

Return type:str
class dropbox.sharing.GetSharedLinksArg(path=None)

Bases: dropbox.stone_base.Struct

Variables:sharing.GetSharedLinksArg.path – See dropbox.dropbox.Dropbox.sharing_get_shared_links() description.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

path

See dropbox.dropbox.Dropbox.sharing_get_shared_links() description.

Return type:str
class dropbox.sharing.GetSharedLinksError(tag, value=None)

Bases: dropbox.stone_base.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:sharing.GetSharedLinksError
class dropbox.sharing.GetSharedLinksResult(links=None)

Bases: dropbox.stone_base.Struct

Variables:sharing.GetSharedLinksResult.links – Shared links applicable to the path argument.
__init__(links=None)

x.__init__(…) initializes x; see help(type(x)) for signature

Shared links applicable to the path argument.

Return type:list of [sharing.LinkMetadata]
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: dropbox.team_common.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:
__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)

x.__init__(…) initializes x; see help(type(x)) for signature

group_type

The type of group.

Return type:team_common.GroupType
is_member

If the current user is a member of the group.

Return type:bool
is_owner

If the current user is an owner of the group.

Return type:bool
same_team

If the group is owned by the current user’s team.

Return type:bool
class dropbox.sharing.GroupMembershipInfo(access_type=None, group=None, permissions=None, initials=None, is_inherited=None)

Bases: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

group

The information about the membership group.

Return type:sharing.GroupInfo
class dropbox.sharing.InsufficientPlan(message=None, upsell_url=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(message=None, upsell_url=None)

x.__init__(…) initializes x; see help(type(x)) for signature

message

A message to tell the user to upgrade in order to support expected action.

Return type:str
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.

Return type:str
class dropbox.sharing.InsufficientQuotaAmounts(space_needed=None, space_shortage=None, space_left=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(space_needed=None, space_shortage=None, space_left=None)

x.__init__(…) initializes x; see help(type(x)) for signature

space_left

The amount of space left in the user’s Dropbox, less than space_needed.

Return type:int
space_needed

The amount of space needed to add the item (the size of the item).

Return type:int
space_shortage

The amount of extra space needed to add the item.

Return type:int
class dropbox.sharing.InviteeInfo(tag, value=None)

Bases: dropbox.stone_base.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) – E-mail 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:sharing.InviteeInfo
get_email()

E-mail 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: dropbox.sharing.MembershipInfo

Information about an invited member of a shared content.

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

x.__init__(…) initializes x; see help(type(x)) for signature

invitee

Recipient of the invitation.

Return type:sharing.InviteeInfo
user

The user this invitation is tied to, if available.

Return type:sharing.UserInfo
class dropbox.sharing.JobError(tag, value=None)

Bases: dropbox.stone_base.Union

Error occurred while performing an asynchronous job from dropbox.dropbox.Dropbox.sharing_unshare_folder() or dropbox.dropbox.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:
:ivar RelinquishFolderMembershipError
sharing.JobError.relinquish_folder_membership_error: Error occurred while performing dropbox.dropbox.Dropbox.sharing_relinquish_folder_membership() action.
get_relinquish_folder_membership_error()

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

Only call this if is_relinquish_folder_membership_error() is true.

Return type:sharing.RelinquishFolderMembershipError
get_remove_folder_member_error()

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

Only call this if is_remove_folder_member_error() is true.

Return type:sharing.RemoveFolderMemberError
get_unshare_folder_error()

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

Only call this if is_unshare_folder_error() is true.

Return type:sharing.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 (sharing.RelinquishFolderMembershipError) –
Return type:sharing.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 (sharing.RemoveFolderMemberError) –
Return type:sharing.JobError
classmethod unshare_folder_error(val)

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

Parameters:val (sharing.UnshareFolderError) –
Return type:sharing.JobError
class dropbox.sharing.JobStatus(tag, value=None)

Bases: dropbox.async_.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:
complete = JobStatus('complete', None)
classmethod failed(val)

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

Parameters:val (sharing.JobError) –
Return type:sharing.JobStatus
get_failed()

The asynchronous job returned an error.

Only call this if is_failed() is true.

Return type:sharing.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.LinkAction(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.stone_base.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:
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_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)
public = LinkAudience('public', None)
team = LinkAudience('team', None)
class dropbox.sharing.LinkExpiry(tag, value=None)

Bases: dropbox.stone_base.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:
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:sharing.LinkExpiry
class dropbox.sharing.LinkMetadata(url=None, visibility=None, expires=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(url=None, visibility=None, expires=None)

x.__init__(…) initializes x; see help(type(x)) for signature

expires

Expiration time, if set. By default the link won’t expire.

Return type:datetime.datetime
url

URL of the shared link.

Return type:str
visibility

Who can access the link.

Return type:sharing.Visibility
class dropbox.sharing.LinkPassword(tag, value=None)

Bases: dropbox.stone_base.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:
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:sharing.LinkPassword
class dropbox.sharing.LinkPermission(action=None, allow=None, reason=None)

Bases: dropbox.stone_base.Struct

Permissions for actions that can be performed on a link.

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

x.__init__(…) initializes x; see help(type(x)) for signature

action
Return type:sharing.LinkAction
allow
Return type:bool
reason
Return type:sharing.PermissionDeniedReason
class dropbox.sharing.LinkPermissions(can_revoke=None, resolved_visibility=None, requested_visibility=None, revoke_failure_reason=None)

Bases: dropbox.stone_base.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).
  • 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.
  • 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.
__init__(can_revoke=None, resolved_visibility=None, requested_visibility=None, revoke_failure_reason=None)

x.__init__(…) initializes x; see help(type(x)) for signature

can_revoke

Whether the caller can revoke the shared link.

Return type:bool
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.

Return type:sharing.RequestedVisibility
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).

Return type:sharing.ResolvedVisibility
revoke_failure_reason

The failure reason for revoking the link. This field will only be present if the can_revoke is False.

Return type:sharing.SharedLinkAccessFailureReason
class dropbox.sharing.LinkSettings(access_level=None, audience=None, expiry=None, password=None)

Bases: dropbox.stone_base.Struct

Settings that apply to a link.

Variables:
__init__(access_level=None, audience=None, expiry=None, password=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_level

The access level on the link for this file. Currently, it only accepts ‘viewer’ and ‘viewer_no_comment’.

Return type:sharing.AccessLevel
audience

The type of audience on the link for this file.

Return type:sharing.LinkAudience
expiry

An expiry timestamp to set on a link.

Return type:sharing.LinkExpiry
password

The password for the link.

Return type:sharing.LinkPassword
class dropbox.sharing.ListFileMembersArg(file=None, actions=None, include_inherited=None, limit=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(file=None, actions=None, include_inherited=None, limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

actions

The actions for which to return permissions on a member.

Return type:list of [sharing.MemberAction]
file

The file for which you want to see members.

Return type:str
include_inherited

Whether to include members who only have access from a parent shared folder.

Return type:bool
limit

Number of members to return max per query. Defaults to 100 if no limit is specified.

Return type:int
class dropbox.sharing.ListFileMembersBatchArg(files=None, limit=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(files=None, limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

files

Files for which to return members.

Return type:list of [str]
limit

Number of members to return max per query. Defaults to 10 if no limit is specified.

Return type:int
class dropbox.sharing.ListFileMembersBatchResult(file=None, result=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(file=None, result=None)

x.__init__(…) initializes x; see help(type(x)) for signature

file

This is the input file identifier, whether an ID or a path.

Return type:str
result

The result for this particular file.

Return type:sharing.ListFileMembersIndividualResult
class dropbox.sharing.ListFileMembersContinueArg(cursor=None)

Bases: dropbox.stone_base.Struct

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

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

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

The cursor returned by your last call to dropbox.dropbox.Dropbox.sharing_list_file_members(), dropbox.dropbox.Dropbox.sharing_list_file_members_continue(), or dropbox.dropbox.Dropbox.sharing_list_file_members_batch().

Return type:str
class dropbox.sharing.ListFileMembersContinueError(tag, value=None)

Bases: dropbox.stone_base.Union

Error for dropbox.dropbox.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_cursorListFileMembersContinueArg.cursor is invalid.
classmethod access_error(val)

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

Parameters:val (sharing.SharingFileAccessError) –
Return type:sharing.ListFileMembersContinueError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.ListFileMembersContinueError
class dropbox.sharing.ListFileMembersCountResult(members=None, member_count=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(members=None, member_count=None)

x.__init__(…) initializes x; see help(type(x)) for signature

member_count

The number of members on this file. This does not include inherited members.

Return type:int
members

A list of members on this file.

Return type:sharing.SharedFileMembers
class dropbox.sharing.ListFileMembersError(tag, value=None)

Bases: dropbox.stone_base.Union

Error for dropbox.dropbox.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 (sharing.SharingFileAccessError) –
Return type:sharing.ListFileMembersError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.ListFileMembersError
class dropbox.sharing.ListFileMembersIndividualResult(tag, value=None)

Bases: dropbox.stone_base.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 ListFileMembersCountResult
sharing.ListFileMembersIndividualResult.result: The results of the query for this file if it was successful.
:ivar SharingFileAccessError
sharing.ListFileMembersIndividualResult.access_error: 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 (sharing.SharingFileAccessError) –
Return type:sharing.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:sharing.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:sharing.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 (sharing.ListFileMembersCountResult) –
Return type:sharing.ListFileMembersIndividualResult
class dropbox.sharing.ListFilesArg(limit=None, actions=None)

Bases: dropbox.stone_base.Struct

Arguments for dropbox.dropbox.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.FileAction]
limit

Number of files to return max per query. Defaults to 100 if no limit is specified.

Return type:int
class dropbox.sharing.ListFilesContinueArg(cursor=None)

Bases: dropbox.stone_base.Struct

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

Variables:sharing.ListFilesContinueArg.cursor – Cursor in ListFilesResult.cursor.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

Cursor in ListFilesResult.cursor.

Return type:str
class dropbox.sharing.ListFilesContinueError(tag, value=None)

Bases: dropbox.stone_base.Union

Error results for dropbox.dropbox.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:
get_user_error()

User account had a problem.

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.ListFilesContinueError
class dropbox.sharing.ListFilesResult(entries=None, cursor=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(entries=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

Cursor used to obtain additional shared files.

Return type:str
entries

Information about the files shared with current user.

Return type:list of [sharing.SharedFileMetadata]
class dropbox.sharing.ListFolderMembersArgs(shared_folder_id=None, actions=None, limit=None)

Bases: dropbox.sharing.ListFolderMembersCursorArg

Variables:sharing.ListFolderMembersArgs.shared_folder_id – The ID for the shared folder.
__init__(shared_folder_id=None, actions=None, limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.ListFolderMembersContinueArg(cursor=None)

Bases: dropbox.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

The cursor returned by your last call to dropbox.dropbox.Dropbox.sharing_list_folder_members() or dropbox.dropbox.Dropbox.sharing_list_folder_members_continue().

Return type:str
class dropbox.sharing.ListFolderMembersContinueError(tag, value=None)

Bases: dropbox.stone_base.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_cursorListFolderMembersContinueArg.cursor is invalid.
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.ListFolderMembersContinueError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.stone_base.Struct

Variables:
__init__(actions=None, limit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.MemberAction]
limit

The maximum number of results that include members, groups and invitees to return per request.

Return type:int
class dropbox.sharing.ListFoldersArgs(limit=None, actions=None)

Bases: dropbox.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.FolderAction]
limit

The maximum number of results to return per request.

Return type:int
class dropbox.sharing.ListFoldersContinueArg(cursor=None)

Bases: dropbox.stone_base.Struct

Variables:sharing.ListFoldersContinueArg.cursor – The cursor returned by the previous API call specified in the endpoint description.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

The cursor returned by the previous API call specified in the endpoint description.

Return type:str
class dropbox.sharing.ListFoldersContinueError(tag, value=None)

Bases: dropbox.stone_base.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_cursorListFoldersContinueArg.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: dropbox.stone_base.Struct

Result for dropbox.dropbox.Dropbox.sharing_list_folders() or dropbox.dropbox.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:
__init__(entries=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.Dropbox.sharing_list_folders_continue() or dropbox.dropbox.Dropbox.sharing_list_mountable_folders_continue()) to list additional folders.

Return type:str
entries

List of all shared folders the authenticated user has access to.

Return type:list of [sharing.SharedFolderMetadata]
class dropbox.sharing.ListSharedLinksArg(path=None, cursor=None, direct_only=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(path=None, cursor=None, direct_only=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

The cursor returned by your last call to dropbox.dropbox.Dropbox.sharing_list_shared_links().

Return type:str
direct_only

See dropbox.dropbox.Dropbox.sharing_list_shared_links() description.

Return type:bool
path

See dropbox.dropbox.Dropbox.sharing_list_shared_links() description.

Return type:str
class dropbox.sharing.ListSharedLinksError(tag, value=None)

Bases: dropbox.stone_base.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.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:sharing.ListSharedLinksError
reset = ListSharedLinksError('reset', None)
class dropbox.sharing.ListSharedLinksResult(links=None, has_more=None, cursor=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(links=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

Pass the cursor into dropbox.dropbox.Dropbox.sharing_list_shared_links() to obtain the additional links. Cursor is returned only if no path is given.

Return type:str
has_more

Is true if there are additional shared links that have not been returned yet. Pass the cursor into dropbox.dropbox.Dropbox.sharing_list_shared_links() to retrieve them.

Return type:bool

Shared links applicable to the path argument.

Return type:list of [sharing.SharedLinkMetadata]
class dropbox.sharing.MemberAccessLevelResult(access_level=None, warning=None, access_details=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(access_level=None, warning=None, access_details=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.ParentFolderAccessInfo]
access_level

The member still has this level of access to the content through a parent folder.

Return type:sharing.AccessLevel
warning

A localized string with additional information about why the user has this access level to the content.

Return type:str
class dropbox.sharing.MemberAction(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.stone_base.Struct

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

Variables:
__init__(action=None, allow=None, reason=None)

x.__init__(…) initializes x; see help(type(x)) for signature

action

The action that the user may wish to take on the member.

Return type:sharing.MemberAction
allow

True if the user is allowed to take the action.

Return type:bool
reason

The reason why the user is denied the permission. Not present if the action is allowed.

Return type:sharing.PermissionDeniedReason
class dropbox.sharing.MemberPolicy(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.stone_base.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:
classmethod dropbox_id(val)

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

Parameters:val (str) –
Return type:sharing.MemberSelector
classmethod email(val)

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

Parameters:val (str) –
Return type:sharing.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()

E-mail 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: dropbox.stone_base.Struct

The information about a member of the shared content.

Variables:
__init__(access_type=None, permissions=None, initials=None, is_inherited=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_type

The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.

Return type:sharing.AccessLevel
initials

Never set.

Return type:str
is_inherited

True if the member has access from a parent folder.

Return type:bool
permissions

The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.

Return type:list of [sharing.MemberPermission]
class dropbox.sharing.ModifySharedLinkSettingsArgs(url=None, settings=None, remove_expiration=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(url=None, settings=None, remove_expiration=None)

x.__init__(…) initializes x; see help(type(x)) for signature

remove_expiration

If set to true, removes the expiration of the shared link.

Return type:bool
settings

Set of settings for the shared link.

Return type:sharing.SharedLinkSettings
url

URL of the shared link to change its settings.

Return type:str
class dropbox.sharing.ModifySharedLinkSettingsError(tag, value=None)

Bases: dropbox.sharing.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.

:ivar SharedLinkSettingsError
sharing.ModifySharedLinkSettingsError.settings_error: There is an error with the given settings.
Variables:sharing.ModifySharedLinkSettingsError.email_not_verified – The caller’s email should be verified.
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:sharing.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 (sharing.SharedLinkSettingsError) –
Return type:sharing.ModifySharedLinkSettingsError
class dropbox.sharing.MountFolderArg(shared_folder_id=None)

Bases: dropbox.stone_base.Struct

Variables:sharing.MountFolderArg.shared_folder_id – The ID of the shared folder to mount.
__init__(shared_folder_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

shared_folder_id

The ID of the shared folder to mount.

Return type:str
class dropbox.sharing.MountFolderError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.MountFolderError
already_mounted = MountFolderError('already_mounted', None)
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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:sharing.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 (sharing.InsufficientQuotaAmounts) –
Return type:sharing.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: dropbox.stone_base.Struct

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

Variables:
__init__(folder_name=None, shared_folder_id=None, permissions=None, path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

folder_name

Display name for the folder.

Return type:str
path

The full path to the parent shared folder relative to the acting user’s root.

Return type:str
permissions

The user’s permissions for the parent shared folder.

Return type:list of [sharing.MemberPermission]
shared_folder_id

The identifier of the parent shared folder.

Return type:str
class dropbox.sharing.PathLinkMetadata(url=None, visibility=None, path=None, expires=None)

Bases: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

path

Path in user’s Dropbox.

Return type:str
class dropbox.sharing.PendingUploadMode(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.stone_base.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:
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:sharing.InsufficientPlan
classmethod insufficient_plan(val)

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

Parameters:val (sharing.InsufficientPlan) –
Return type:sharing.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: dropbox.stone_base.Struct

Variables:sharing.RelinquishFileMembershipArg.file – The path or id for the file.
__init__(file=None)

x.__init__(…) initializes x; see help(type(x)) for signature

file

The path or id for the file.

Return type:str
class dropbox.sharing.RelinquishFileMembershipError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharingFileAccessError) –
Return type:sharing.RelinquishFileMembershipError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, leave_a_copy=None)

x.__init__(…) initializes x; see help(type(x)) for signature

leave_a_copy

Keep a copy of the folder’s contents upon relinquishing membership.

Return type:bool
shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.RelinquishFolderMembershipError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.RelinquishFolderMembershipError
folder_owner = RelinquishFolderMembershipError('folder_owner', None)
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.stone_base.Struct

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

Variables:
__init__(file=None, member=None)

x.__init__(…) initializes x; see help(type(x)) for signature

file

File from which to remove members.

Return type:str
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.

Return type:sharing.MemberSelector
class dropbox.sharing.RemoveFileMemberError(tag, value=None)

Bases: dropbox.stone_base.Union

Errors for dropbox.dropbox.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.

:ivar MemberAccessLevelResult
sharing.RemoveFileMemberError.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.
classmethod access_error(val)

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

Parameters:val (sharing.SharingFileAccessError) –
Return type:sharing.RemoveFileMemberError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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:sharing.MemberAccessLevelResult
get_user_error()

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.MemberAccessLevelResult) –
Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.RemoveFileMemberError
class dropbox.sharing.RemoveFolderMemberArg(shared_folder_id=None, member=None, leave_a_copy=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, member=None, leave_a_copy=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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. Also, this must be set to false when kicking a group.

Return type:bool
member

The member to remove from the folder.

Return type:sharing.MemberSelector
shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.RemoveFolderMemberError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.RemoveFolderMemberError
folder_owner = RemoveFolderMemberError('folder_owner', None)
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharedFolderAccessError
get_member_error()

Only call this if is_member_error() is true.

Return type:sharing.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 (sharing.SharedFolderMemberError) –
Return type:sharing.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: dropbox.async_.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.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 (sharing.MemberAccessLevelResult) –
Return type:sharing.RemoveMemberJobStatus
classmethod failed(val)

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

Parameters:val (sharing.RemoveFolderMemberError) –
Return type:sharing.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:sharing.MemberAccessLevelResult
get_failed()

Only call this if is_failed() is true.

Return type:sharing.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.RequestedVisibility(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.sharing.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:
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
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: dropbox.stone_base.Struct

Variables:sharing.RevokeSharedLinkArg.url – URL of the shared link.
__init__(url=None)

x.__init__(…) initializes x; see help(type(x)) for signature

url

URL of the shared link.

Return type:str
class dropbox.sharing.RevokeSharedLinkError(tag, value=None)

Bases: dropbox.sharing.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.

Check if the union tag is shared_link_malformed.

Return type:bool
class dropbox.sharing.SetAccessInheritanceArg(shared_folder_id=None, access_inheritance=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, access_inheritance=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_inheritance

The access inheritance settings for the folder.

Return type:sharing.AccessInheritance
shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.SetAccessInheritanceError(tag, value=None)

Bases: dropbox.stone_base.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 SharedFolderAccessError
sharing.SetAccessInheritanceError.access_error: Unable to access shared folder.
Variables: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 (sharing.SharedFolderAccessError) –
Return type:sharing.SetAccessInheritanceError
get_access_error()

Unable to access shared folder.

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:list of [sharing.FolderAction]

Settings on the link for this folder.

Return type:sharing.LinkSettings
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: dropbox.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

access_inheritance

The access inheritance settings for the folder.

Return type:sharing.AccessInheritance
acl_update_policy

Who can add and remove members of this shared folder.

Return type:sharing.AclUpdatePolicy
force_async

Whether to force the share to happen asynchronously.

Return type:bool
member_policy

Who can be a member of this shared folder. Only applicable if the current user is on a team.

Return type:sharing.MemberPolicy
path

The path to the folder to share. If it does not exist, then a new one is created.

Return type:str

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.

Return type:sharing.SharedLinkPolicy
viewer_info_policy

Who can enable/disable viewer info for this shared folder.

Return type:sharing.ViewerInfoPolicy
class dropbox.sharing.ShareFolderError(tag, value=None)

Bases: dropbox.sharing.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: dropbox.stone_base.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:
classmethod bad_path(val)

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

Parameters:val (sharing.SharePathError) –
Return type:sharing.ShareFolderErrorBase
email_unverified = ShareFolderErrorBase('email_unverified', None)
get_bad_path()

ShareFolderArg.path is invalid.

Only call this if is_bad_path() is true.

Return type:sharing.SharePathError
is_bad_path()

Check if the union tag is bad_path.

Return type:bool

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: dropbox.async_.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.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 (sharing.SharedFolderMetadata) –
Return type:sharing.ShareFolderJobStatus
classmethod failed(val)

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

Parameters:val (sharing.ShareFolderError) –
Return type:sharing.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:sharing.SharedFolderMetadata
get_failed()

Only call this if is_failed() is true.

Return type:sharing.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: dropbox.async_.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 (sharing.SharedFolderMetadata) –
Return type:sharing.ShareFolderLaunch
get_complete()

Only call this if is_complete() is true.

Return type:sharing.SharedFolderMetadata
is_complete()

Check if the union tag is complete.

Return type:bool
class dropbox.sharing.SharePathError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod already_shared(val)

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

Parameters:val (sharing.SharedFolderMetadata) –
Return type:sharing.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:sharing.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_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_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_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)
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: dropbox.sharing.SharedContentLinkMetadataBase

Metadata of a shared link for a file or folder.

Variables:
__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)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:sharing.AudienceExceptions
url

The URL of the link.

Return type:str
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: dropbox.stone_base.Struct

Variables:
:ivar
sharing.SharedContentLinkMetadataBase.audience_restricting_shared_folder: The shared folder that prevents the link audience for this link from being more restrictive.
Variables:
__init__(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_level

The access level on the link for this file.

Return type:sharing.AccessLevel
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.

Return type:list of [sharing.LinkAudience]
audience_restricting_shared_folder

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

Return type:sharing.AudienceRestrictingSharedFolder
current_audience

The current audience of the link.

Return type:sharing.LinkAudience
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.

Return type:datetime.datetime

A list of permissions for actions you can perform on the link.

Return type:list of [sharing.LinkPermission]
password_protected

Whether the link is protected by a password.

Return type:bool
class dropbox.sharing.SharedFileMembers(users=None, groups=None, invitees=None, cursor=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(users=None, groups=None, invitees=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

Present if there are additional shared file members that have not been returned yet. Pass the cursor into dropbox.dropbox.Dropbox.sharing_list_file_members_continue() to list additional members.

Return type:str
groups

The list of group members of the shared file.

Return type:list of [sharing.GroupMembershipInfo]
invitees

The list of invited members of a file, but have not logged in and claimed this.

Return type:list of [sharing.InviteeMembershipInfo]
users

The list of user members of the shared file.

Return type:list of [sharing.UserFileMembershipInfo]
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: dropbox.stone_base.Struct

Properties of the shared file.

Variables:
__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)

x.__init__(…) initializes x; see help(type(x)) for signature

access_type

The current user’s access level for this shared file.

Return type:sharing.AccessLevel

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.

Return type:sharing.ExpectedSharedContentLinkMetadata
id

The ID of the file.

Return type:str

The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.

Return type:sharing.SharedContentLinkMetadata
name

The name of this file.

Return type:str
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.

Return type:list of [str]
owner_team

The team that owns the file. This field is not present if the file is not owned by a team.

Return type:users.Team
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.

Return type:str
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.

Return type:str
path_lower

The lower-case full path of this file. Absent for unmounted files.

Return type:str
permissions

The sharing permissions that requesting user has on this file. This corresponds to the entries given in GetFileMetadataBatchArg.actions or GetFileMetadataArg.actions.

Return type:list of [sharing.FilePermission]
policy

Policies governing this shared file.

Return type:sharing.FolderPolicy
preview_url

URL for displaying a web preview of the shared file.

Return type:str
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.

Return type:datetime.datetime
class dropbox.sharing.SharedFolderAccessError(tag, value=None)

Bases: dropbox.stone_base.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:
email_unverified = SharedFolderAccessError('email_unverified', None)
invalid_id = SharedFolderAccessError('invalid_id', 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_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: dropbox.stone_base.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:
:ivar MemberAccessLevelResult
sharing.SharedFolderMemberError.no_explicit_access: 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:sharing.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 (sharing.MemberAccessLevelResult) –
Return type:sharing.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: dropbox.stone_base.Struct

Shared folder user and group membership.

Variables:
__init__(users=None, groups=None, invitees=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor

Present if there are additional shared folder members that have not been returned yet. Pass the cursor into dropbox.dropbox.Dropbox.sharing_list_folder_members_continue() to list additional members.

Return type:str
groups

The list of group members of the shared folder.

Return type:list of [sharing.GroupMembershipInfo]
invitees

The list of invitees to the shared folder.

Return type:list of [sharing.InviteeMembershipInfo]
users

The list of user members of the shared folder.

Return type:list of [sharing.UserMembershipInfo]
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_lower=None, link_metadata=None, permissions=None, access_inheritance=None)

Bases: dropbox.sharing.SharedFolderMetadataBase

The metadata which includes basic information about the shared folder.

Variables:
__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_lower=None, link_metadata=None, permissions=None, access_inheritance=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_inheritance

Whether the folder inherits its members from its parent.

Return type:sharing.AccessInheritance

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.

Return type:sharing.SharedContentLinkMetadata
name

The name of the this shared folder.

Return type:str
permissions

Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.

Return type:list of [sharing.FolderPermission]
policy

Policies governing this shared folder.

Return type:sharing.FolderPolicy
preview_url

URL for displaying a web preview of the shared folder.

Return type:str
shared_folder_id

The ID of the shared folder.

Return type:str
time_invited

Timestamp indicating when the current user was invited to this shared folder.

Return type:datetime.datetime
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_lower=None)

Bases: dropbox.stone_base.Struct

Properties of the shared folder.

Variables:
__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_lower=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_type

The current user’s access level for this shared folder.

Return type:sharing.AccessLevel
is_inside_team_folder

Whether this folder is inside of a team folder.

Return type:bool
is_team_folder

Whether this folder is a team folder.

Return type:bool
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.

Return type:list of [str]
owner_team

The team that owns the folder. This field is not present if the folder is not owned by a team.

Return type:users.Team
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.

Return type:str
path_lower

The lower-cased full path of this shared folder. Absent for unmounted folders.

Return type:str
class dropbox.sharing.SharedLinkAccessFailureReason(tag, value=None)

Bases: dropbox.stone_base.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:
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.SharedLinkError(tag, value=None)

Bases: dropbox.stone_base.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:
is_other()

Check if the union tag is other.

Return type:bool

Check if the union tag is shared_link_access_denied.

Return type:bool

Check if the union tag is shared_link_not_found.

Return type:bool

Check if the union tag is unsupported_link_type.

Return type:bool
other = SharedLinkError('other', 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: dropbox.stone_base.Struct

The metadata of a shared link.

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

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:users.Team
expires

Expiration time, if set. By default the link won’t expire.

Return type:datetime.datetime
id

A unique identifier for the linked file.

Return type:str

The link’s access permissions.

Return type:sharing.LinkPermissions
name

The linked file name (including extension). This never contains a slash.

Return type:str
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.

Return type:str
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.

Return type:sharing.TeamMemberInfo
url

URL of the shared link.

Return type:str
class dropbox.sharing.SharedLinkPolicy(tag, value=None)

Bases: dropbox.stone_base.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:
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(requested_visibility=None, link_password=None, expires=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(requested_visibility=None, link_password=None, expires=None)

x.__init__(…) initializes x; see help(type(x)) for signature

expires

Expiration time of the shared link. By default the link won’t expire.

Return type:datetime.datetime

If requested_visibility is RequestedVisibility.password this is needed to specify the password to access the link.

Return type:str
requested_visibility

The requested access for this shared link.

Return type:sharing.RequestedVisibility
class dropbox.sharing.SharedLinkSettingsError(tag, value=None)

Bases: dropbox.stone_base.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: dropbox.stone_base.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:
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: dropbox.stone_base.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 – The current user must verify the account e-mail address before performing this action.
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: dropbox.stone_base.Struct

Information about a team member.

Variables:
__init__(team_info=None, display_name=None, member_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

display_name

The display name of the user.

Return type:str
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.

Return type:str
team_info

Information about the member’s team.

Return type:users.Team
class dropbox.sharing.TransferFolderArg(shared_folder_id=None, to_dropbox_id=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, to_dropbox_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

shared_folder_id

The ID for the shared folder.

Return type:str
to_dropbox_id

A account or team member ID to transfer ownership to.

Return type:str
class dropbox.sharing.TransferFolderError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.TransferFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.stone_base.Struct

Variables:sharing.UnmountFolderArg.shared_folder_id – The ID for the shared folder.
__init__(shared_folder_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.UnmountFolderError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.UnmountFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.stone_base.Struct

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

Variables:sharing.UnshareFileArg.file – The file to unshare.
__init__(file=None)

x.__init__(…) initializes x; see help(type(x)) for signature

file

The file to unshare.

Return type:str
class dropbox.sharing.UnshareFileError(tag, value=None)

Bases: dropbox.stone_base.Union

Error result for dropbox.dropbox.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 (sharing.SharingFileAccessError) –
Return type:sharing.UnshareFileError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:sharing.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 (sharing.SharingUserError) –
Return type:sharing.UnshareFileError
class dropbox.sharing.UnshareFolderArg(shared_folder_id=None, leave_a_copy=None)

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, leave_a_copy=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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.

Return type:bool
shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.UnshareFolderError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.UnshareFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.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: dropbox.sharing.ChangeFileMemberAccessArgs

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

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.stone_base.Struct

Variables:
__init__(shared_folder_id=None, member=None, access_level=None)

x.__init__(…) initializes x; see help(type(x)) for signature

access_level

The new access level for member. AccessLevel.owner is disallowed.

Return type:sharing.AccessLevel
member

The member of the shared folder to update. Only the MemberSelector.dropbox_id may be set at this time.

Return type:sharing.MemberSelector
shared_folder_id

The ID for the shared folder.

Return type:str
class dropbox.sharing.UpdateFolderMemberError(tag, value=None)

Bases: dropbox.stone_base.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 AddFolderMemberError
sharing.UpdateFolderMemberError.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.
Variables:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.UpdateFolderMemberError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharedFolderAccessError
get_member_error()

Only call this if is_member_error() is true.

Return type:sharing.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:sharing.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 (sharing.SharedFolderMemberError) –
Return type:sharing.UpdateFolderMemberError
classmethod no_explicit_access(val)

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

Parameters:val (sharing.AddFolderMemberError) –
Return type:sharing.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: dropbox.stone_base.Struct

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

Variables:
__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)

x.__init__(…) initializes x; see help(type(x)) for signature

acl_update_policy

Who can add and remove members of this shared folder.

Return type:sharing.AclUpdatePolicy
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.

Return type:list of [sharing.FolderAction]

Settings on the link for this folder.

Return type:sharing.LinkSettings
member_policy

Who can be a member of this shared folder. Only applicable if the current user is on a team.

Return type:sharing.MemberPolicy
shared_folder_id

The ID for the shared folder.

Return type:str

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.

Return type:sharing.SharedLinkPolicy
viewer_info_policy

Who can enable/disable viewer info for this shared folder.

Return type:sharing.ViewerInfoPolicy
class dropbox.sharing.UpdateFolderPolicyError(tag, value=None)

Bases: dropbox.stone_base.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:
classmethod access_error(val)

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

Parameters:val (sharing.SharedFolderAccessError) –
Return type:sharing.UpdateFolderPolicyError
get_access_error()

Only call this if is_access_error() is true.

Return type:sharing.SharedFolderAccessError
is_access_error()

Check if the union tag is access_error.

Return type:bool

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: dropbox.sharing.UserMembershipInfo

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

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

x.__init__(…) initializes x; see help(type(x)) for signature

platform_type

The platform on which the user has last seen the content, or unknown.

Return type:seen_state.PlatformType
time_last_seen

The UTC timestamp of when the user has last seen the content, if they have.

Return type:datetime.datetime
class dropbox.sharing.UserInfo(account_id=None, email=None, display_name=None, same_team=None, team_member_id=None)

Bases: dropbox.stone_base.Struct

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

Variables:
__init__(account_id=None, email=None, display_name=None, same_team=None, team_member_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

account_id

The account ID of the user.

Return type:str
display_name

The display name of the user.

Return type:str
email

Email address of user.

Return type:str
same_team

If the user is in the same team as current user.

Return type:bool
team_member_id

The team member ID of the shared folder member. Only present if same_team is true.

Return type:str
class dropbox.sharing.UserMembershipInfo(access_type=None, user=None, permissions=None, initials=None, is_inherited=None)

Bases: dropbox.sharing.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)

x.__init__(…) initializes x; see help(type(x)) for signature

user

The account information for the membership user.

Return type:sharing.UserInfo
class dropbox.sharing.ViewerInfoPolicy(tag, value=None)

Bases: dropbox.stone_base.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:
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: dropbox.stone_base.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:
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)