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: stone.backends.python_rsrc.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(u'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(u'no_inherit', None)
other = AccessInheritance(u'other', None)
class dropbox.sharing.AccessLevel(tag, value=None)

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

Bases: stone.backends.python_rsrc.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(u'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(u'other', None)
owner = AclUpdatePolicy(u'owner', None)
class dropbox.sharing.AddFileMemberArgs(file=None, members=None, custom_message=None, quiet=None, access_level=None, add_message_as_comment=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.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
add_message_as_comment
custom_message
file
members
quiet
class dropbox.sharing.AddFileMemberError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

Variables:
classmethod access_error(val)

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

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

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:SharingUserError
invalid_comment = AddFileMemberError(u'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(u'other', None)
rate_limit = AddFileMemberError(u'rate_limit', None)
classmethod user_error(val)

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

Parameters:val (SharingUserError) –
Return type:AddFileMemberError
class dropbox.sharing.AddFolderMemberArg(shared_folder_id=None, members=None, quiet=None, custom_message=None)

Bases: stone.backends.python_rsrc.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
members
quiet
shared_folder_id
class dropbox.sharing.AddFolderMemberError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:AddFolderMemberError
classmethod bad_member(val)

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

Parameters:val (AddMemberSelectorError) –
Return type:AddFolderMemberError
banned_member = AddFolderMemberError(u'banned_member', None)
cant_share_outside_team = AddFolderMemberError(u'cant_share_outside_team', None)
email_unverified = AddFolderMemberError(u'email_unverified', None)
get_access_error()

Unable to access shared folder.

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
get_bad_member()

AddFolderMemberArg.members contains a bad invitation recipient.

Only call this if is_bad_member() is true.

Return type:AddMemberSelectorError
get_too_many_members()

The value is the member limit that was reached.

Only call this if is_too_many_members() is true.

Return type:int
get_too_many_pending_invites()

The value is the pending invite limit that was reached.

Only call this if is_too_many_pending_invites() is true.

Return type:int
insufficient_plan = AddFolderMemberError(u'insufficient_plan', None)
invalid_shared_folder = AddFolderMemberError(u'invalid_shared_folder', None)
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_bad_member()

Check if the union tag is bad_member.

Return type:bool
is_banned_member()

Check if the union tag is banned_member.

Return type:bool
is_cant_share_outside_team()

Check if the union tag is cant_share_outside_team.

Return type:bool
is_email_unverified()

Check if the union tag is email_unverified.

Return type:bool
is_insufficient_plan()

Check if the union tag is insufficient_plan.

Return type:bool
is_invalid_shared_folder()

Check if the union tag is invalid_shared_folder.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_rate_limit()

Check if the union tag is rate_limit.

Return type:bool
is_team_folder()

Check if the union tag is team_folder.

Return type:bool
is_too_many_invitees()

Check if the union tag is too_many_invitees.

Return type:bool
is_too_many_members()

Check if the union tag is too_many_members.

Return type:bool
is_too_many_pending_invites()

Check if the union tag is too_many_pending_invites.

Return type:bool
no_permission = AddFolderMemberError(u'no_permission', None)
other = AddFolderMemberError(u'other', None)
rate_limit = AddFolderMemberError(u'rate_limit', None)
team_folder = AddFolderMemberError(u'team_folder', None)
too_many_invitees = AddFolderMemberError(u'too_many_invitees', None)
classmethod too_many_members(val)

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

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

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

Parameters:val (int) –
Return type:AddFolderMemberError
class dropbox.sharing.AddMember(member=None, access_level=None)

Bases: stone.backends.python_rsrc.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
member
class dropbox.sharing.AddMemberSelectorError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'automatic_group', None)
get_invalid_dropbox_id()

The value is the ID that could not be identified.

Only call this if is_invalid_dropbox_id() is true.

Return type:str
get_invalid_email()

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

Only call this if is_invalid_email() is true.

Return type:str
get_unverified_dropbox_id()

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

Only call this if is_unverified_dropbox_id() is true.

Return type:str
group_deleted = AddMemberSelectorError(u'group_deleted', None)
group_not_on_team = AddMemberSelectorError(u'group_not_on_team', None)
classmethod invalid_dropbox_id(val)

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

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

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

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

Check if the union tag is automatic_group.

Return type:bool
is_group_deleted()

Check if the union tag is group_deleted.

Return type:bool
is_group_not_on_team()

Check if the union tag is group_not_on_team.

Return type:bool
is_invalid_dropbox_id()

Check if the union tag is invalid_dropbox_id.

Return type:bool
is_invalid_email()

Check if the union tag is invalid_email.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_unverified_dropbox_id()

Check if the union tag is unverified_dropbox_id.

Return type:bool
other = AddMemberSelectorError(u'other', None)
classmethod unverified_dropbox_id(val)

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

Parameters:val (str) –
Return type:AddMemberSelectorError
class dropbox.sharing.AlphaResolvedVisibility(tag, value=None)

Bases: dropbox.sharing.ResolvedVisibility

check documentation for ResolvedVisibility.

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

class dropbox.sharing.AudienceExceptionContentInfo(name=None)

Bases: stone.backends.python_rsrc.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
class dropbox.sharing.AudienceExceptions(count=None, exceptions=None)

Bases: stone.backends.python_rsrc.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
exceptions
class dropbox.sharing.AudienceRestrictingSharedFolder(shared_folder_id=None, name=None, audience=None)

Bases: stone.backends.python_rsrc.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
name
shared_folder_id
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: stone.backends.python_rsrc.stone_base.Struct

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

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

path
pending_upload
short_url
class dropbox.sharing.CreateSharedLinkError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'other', None)
classmethod path(val)

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

Parameters:val (files.LookupError) –
Return type:CreateSharedLinkError
class dropbox.sharing.CreateSharedLinkWithSettingsArg(path=None, settings=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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.CreateSharedLinkWithSettingsError.email_not_verified

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

:ivar Optional[SharedLinkAlreadyExistsMetadata]
sharing.CreateSharedLinkWithSettingsError.shared_link_already_exists: The shared link already exists. You can call :route:`list_shared_links` to get the existing link, or use the provided metadata if it is returned.
:ivar SharedLinkSettingsError
CreateSharedLinkWithSettingsError.settings_error: There is an error with the given settings.
Variables:sharing.CreateSharedLinkWithSettingsError.access_denied – The user is not allowed to create a shared link to the specified file. For example, this can occur if the file is restricted or if the user’s links are banned.
access_denied = CreateSharedLinkWithSettingsError(u'access_denied', None)
email_not_verified = CreateSharedLinkWithSettingsError(u'email_not_verified', None)
get_path()

Only call this if is_path() is true.

Return type:files.LookupError
get_settings_error()

There is an error with the given settings.

Only call this if is_settings_error() is true.

Return type:SharedLinkSettingsError

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

Only call this if is_shared_link_already_exists() is true.

Return type:SharedLinkAlreadyExistsMetadata
is_access_denied()

Check if the union tag is access_denied.

Return type:bool
is_email_not_verified()

Check if the union tag is email_not_verified.

Return type:bool
is_path()

Check if the union tag is path.

Return type:bool
is_settings_error()

Check if the union tag is settings_error.

Return type:bool

Check if the union tag is shared_link_already_exists.

Return type:bool
classmethod path(val)

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

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

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

Parameters:val (SharedLinkSettingsError) –
Return type:CreateSharedLinkWithSettingsError

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

Parameters:val (SharedLinkAlreadyExistsMetadata) –
Return type:CreateSharedLinkWithSettingsError
class dropbox.sharing.ExpectedSharedContentLinkMetadata(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

Bases: 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: stone.backends.python_rsrc.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(u'disable_viewer_info', None)
edit_contents = FileAction(u'edit_contents', None)
enable_viewer_info = FileAction(u'enable_viewer_info', None)
invite_editor = FileAction(u'invite_editor', None)
invite_viewer = FileAction(u'invite_viewer', None)
invite_viewer_no_comment = FileAction(u'invite_viewer_no_comment', None)

Check if the union tag is create_edit_link.

Return type:bool

Check if the union tag is create_link.

Return type:bool

Check if the union tag is create_view_link.

Return type:bool
is_disable_viewer_info()

Check if the union tag is disable_viewer_info.

Return type:bool
is_edit_contents()

Check if the union tag is edit_contents.

Return type:bool
is_enable_viewer_info()

Check if the union tag is enable_viewer_info.

Return type:bool
is_invite_editor()

Check if the union tag is invite_editor.

Return type:bool
is_invite_viewer()

Check if the union tag is invite_viewer.

Return type:bool
is_invite_viewer_no_comment()

Check if the union tag is invite_viewer_no_comment.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_relinquish_membership()

Check if the union tag is relinquish_membership.

Return type:bool

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

Bases: stone.backends.python_rsrc.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:FileErrorResult
get_file_not_found_error()

File specified by id was not found.

Only call this if is_file_not_found_error() is true.

Return type:str
get_invalid_file_action_error()

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

Only call this if is_invalid_file_action_error() is true.

Return type:str
get_permission_denied_error()

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

Only call this if is_permission_denied_error() is true.

Return type:str
classmethod invalid_file_action_error(val)

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

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

Check if the union tag is file_not_found_error.

Return type:bool
is_invalid_file_action_error()

Check if the union tag is invalid_file_action_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_permission_denied_error()

Check if the union tag is permission_denied_error.

Return type:bool
other = FileErrorResult(u'other', None)
classmethod permission_denied_error(val)

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

Parameters:val (str) –
Return type:FileErrorResult
class dropbox.sharing.FileLinkMetadata(url=None, name=None, link_permissions=None, client_modified=None, server_modified=None, rev=None, size=None, id=None, expires=None, path_lower=None, team_member_info=None, content_owner_team_info=None)

Bases: 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
rev
server_modified
size
class dropbox.sharing.FileMemberActionError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharingFileAccessError) –
Return type:FileMemberActionError
get_access_error()

Specified file was invalid or user does not have access.

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_no_explicit_access()

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

Only call this if is_no_explicit_access() is true.

Return type:MemberAccessLevelResult
invalid_member = FileMemberActionError(u'invalid_member', None)
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_invalid_member()

Check if the union tag is invalid_member.

Return type:bool
is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
classmethod no_explicit_access(val)

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

Parameters:val (MemberAccessLevelResult) –
Return type:FileMemberActionError
no_permission = FileMemberActionError(u'no_permission', None)
other = FileMemberActionError(u'other', None)
class dropbox.sharing.FileMemberActionIndividualResult(tag, value=None)

Bases: stone.backends.python_rsrc.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[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.
Variables:FileMemberActionIndividualResult.member_error (FileMemberActionError) – User was not able to perform this action.
get_member_error()

User was not able to perform this action.

Only call this if is_member_error() is true.

Return type:FileMemberActionError
get_success()

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:AccessLevel
is_member_error()

Check if the union tag is member_error.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
classmethod member_error(val)

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.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_member_error()

User was not able to remove this member.

Only call this if is_member_error() is true.

Return type:FileMemberActionError
get_success()

Member was successfully removed from this file.

Only call this if is_success() is true.

Return type:MemberAccessLevelResult
is_member_error()

Check if the union tag is member_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_success()

Check if the union tag is success.

Return type:bool
classmethod member_error(val)

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

Parameters:val (FileMemberActionError) –
Return type:FileMemberRemoveActionResult
other = FileMemberRemoveActionResult(u'other', None)
classmethod success(val)

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

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

Bases: stone.backends.python_rsrc.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
allow
reason
class dropbox.sharing.FolderAction(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'change_options', None)
disable_viewer_info = FolderAction(u'disable_viewer_info', None)
edit_contents = FolderAction(u'edit_contents', None)
enable_viewer_info = FolderAction(u'enable_viewer_info', None)
invite_editor = FolderAction(u'invite_editor', None)
invite_viewer = FolderAction(u'invite_viewer', None)
invite_viewer_no_comment = FolderAction(u'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(u'leave_a_copy', None)
other = FolderAction(u'other', None)
relinquish_membership = FolderAction(u'relinquish_membership', None)
set_access_inheritance = FolderAction(u'set_access_inheritance', None)
unmount = FolderAction(u'unmount', None)
unshare = FolderAction(u'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: stone.backends.python_rsrc.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
allow
reason
class dropbox.sharing.FolderPolicy(acl_update_policy=None, shared_link_policy=None, member_policy=None, resolved_member_policy=None, viewer_info_policy=None)

Bases: stone.backends.python_rsrc.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
member_policy
resolved_member_policy
viewer_info_policy
class dropbox.sharing.GetFileMetadataArg(file=None, actions=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

classmethod access_error(val)

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

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

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:SharingUserError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_user_error()

Check if the union tag is user_error.

Return type:bool
other = GetFileMetadataError(u'other', None)
classmethod user_error(val)

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

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

Bases: stone.backends.python_rsrc.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 (SharingFileAccessError) –
Return type:GetFileMetadataIndividualResult
get_access_error()

The result for this file if it was an error.

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_metadata()

The result for this file if it was successful.

Only call this if is_metadata() is true.

Return type:SharedFileMetadata
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_metadata()

Check if the union tag is metadata.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
classmethod metadata(val)

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

Parameters:val (SharedFileMetadata) –
Return type:GetFileMetadataIndividualResult
other = GetFileMetadataIndividualResult(u'other', None)
class dropbox.sharing.GetMetadataArgs(shared_folder_id=None, actions=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

actions
shared_folder_id
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: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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(u'other', None)
classmethod path(val)

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

Parameters:val (Optional[str]) –
Return type:GetSharedLinksError
class dropbox.sharing.GetSharedLinksResult(links=None)

Bases: stone.backends.python_rsrc.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

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
is_member
is_owner
same_team
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
class dropbox.sharing.InsufficientPlan(message=None, upsell_url=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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
space_needed
space_shortage
class dropbox.sharing.InviteeInfo(tag, value=None)

Bases: stone.backends.python_rsrc.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) – Email address of invited user.
classmethod email(val)

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

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

Email address of invited user.

Only call this if is_email() is true.

Return type:str
is_email()

Check if the union tag is email.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = InviteeInfo(u'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
user
class dropbox.sharing.JobError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

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

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

Only call this if is_relinquish_folder_membership_error() is true.

Return type:RelinquishFolderMembershipError
get_remove_folder_member_error()

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

Only call this if is_remove_folder_member_error() is true.

Return type:RemoveFolderMemberError
get_unshare_folder_error()

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

Only call this if is_unshare_folder_error() is true.

Return type:UnshareFolderError
is_other()

Check if the union tag is other.

Return type:bool
is_relinquish_folder_membership_error()

Check if the union tag is relinquish_folder_membership_error.

Return type:bool
is_remove_folder_member_error()

Check if the union tag is remove_folder_member_error.

Return type:bool
is_unshare_folder_error()

Check if the union tag is unshare_folder_error.

Return type:bool
other = JobError(u'other', None)
classmethod relinquish_folder_membership_error(val)

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

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

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

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

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

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

Bases: 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(u'complete', None)
classmethod failed(val)

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

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

The asynchronous job returned an error.

Only call this if is_failed() is true.

Return type:JobError
is_complete()

Check if the union tag is complete.

Return type:bool
is_failed()

Check if the union tag is failed.

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

Bases: stone.backends.python_rsrc.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:
editor = LinkAccessLevel(u'editor', None)
is_editor()

Check if the union tag is editor.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_viewer()

Check if the union tag is viewer.

Return type:bool
other = LinkAccessLevel(u'other', None)
viewer = LinkAccessLevel(u'viewer', None)
class dropbox.sharing.LinkAction(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'change_access_level', None)
change_audience = LinkAction(u'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(u'other', None)
remove_expiry = LinkAction(u'remove_expiry', None)
remove_password = LinkAction(u'remove_password', None)
set_expiry = LinkAction(u'set_expiry', None)
set_password = LinkAction(u'set_password', None)
class dropbox.sharing.LinkAudience(tag, value=None)

Bases: stone.backends.python_rsrc.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_password()

Check if the union tag is password.

Return type:bool
is_public()

Check if the union tag is public.

Return type:bool
is_team()

Check if the union tag is team.

Return type:bool
members = LinkAudience(u'members', None)
no_one = LinkAudience(u'no_one', None)
other = LinkAudience(u'other', None)
password = LinkAudience(u'password', None)
public = LinkAudience(u'public', None)
team = LinkAudience(u'team', None)
class dropbox.sharing.LinkAudienceDisallowedReason(tag, value=None)

Bases: dropbox.sharing.VisibilityPolicyDisallowedReason

check documentation for VisibilityPolicyDisallowedReason.

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(audience=None, allowed=None, disallowed_reason=None)

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

allowed
audience
disallowed_reason
class dropbox.sharing.LinkExpiry(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'other', None)
remove_expiry = LinkExpiry(u'remove_expiry', None)
classmethod set_expiry(val)

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

Parameters:val (datetime.datetime) –
Return type:LinkExpiry
class dropbox.sharing.LinkMetadata(url=None, visibility=None, expires=None)

Bases: stone.backends.python_rsrc.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
url
visibility
class dropbox.sharing.LinkPassword(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'other', None)
remove_password = LinkPassword(u'remove_password', None)
classmethod set_password(val)

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

Parameters:val (str) –
Return type:LinkPassword
class dropbox.sharing.LinkPermission(action=None, allow=None, reason=None)

Bases: stone.backends.python_rsrc.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
allow
reason
class dropbox.sharing.LinkPermissions(can_revoke=None, visibility_policies=None, can_set_expiry=None, can_remove_expiry=None, allow_download=None, can_allow_download=None, can_disallow_download=None, allow_comments=None, team_restricts_comments=None, resolved_visibility=None, requested_visibility=None, revoke_failure_reason=None, effective_audience=None, link_access_level=None, audience_options=None, can_set_password=None, can_remove_password=None, require_password=None, can_use_extended_sharing_controls=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

allow_comments
allow_download
audience_options
can_allow_download
can_disallow_download
can_remove_expiry
can_remove_password
can_revoke
can_set_expiry
can_set_password
can_use_extended_sharing_controls
effective_audience
requested_visibility
require_password
resolved_visibility
revoke_failure_reason
team_restricts_comments
visibility_policies
class dropbox.sharing.LinkSettings(access_level=None, audience=None, expiry=None, password=None)

Bases: stone.backends.python_rsrc.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
audience
expiry
password
class dropbox.sharing.ListFileMembersArg(file=None, actions=None, include_inherited=None, limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.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
file
include_inherited
limit
class dropbox.sharing.ListFileMembersBatchArg(files=None, limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

file
result
class dropbox.sharing.ListFileMembersContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

Variables:sharing.ListFileMembersContinueError.invalid_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 (SharingFileAccessError) –
Return type:ListFileMembersContinueError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:SharingUserError
invalid_cursor = ListFileMembersContinueError(u'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(u'other', None)
classmethod user_error(val)

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

Parameters:val (SharingUserError) –
Return type:ListFileMembersContinueError
class dropbox.sharing.ListFileMembersCountResult(members=None, member_count=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

classmethod access_error(val)

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

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

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:SharingUserError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_user_error()

Check if the union tag is user_error.

Return type:bool
other = ListFileMembersError(u'other', None)
classmethod user_error(val)

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

Parameters:val (SharingUserError) –
Return type:ListFileMembersError
class dropbox.sharing.ListFileMembersIndividualResult(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharingFileAccessError) –
Return type:ListFileMembersIndividualResult
get_access_error()

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

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_result()

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

Only call this if is_result() is true.

Return type:ListFileMembersCountResult
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_result()

Check if the union tag is result.

Return type:bool
other = ListFileMembersIndividualResult(u'other', None)
classmethod result(val)

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

Parameters:val (ListFileMembersCountResult) –
Return type:ListFileMembersIndividualResult
class dropbox.sharing.ListFilesArg(limit=None, actions=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

actions
limit
class dropbox.sharing.ListFilesContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.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
class dropbox.sharing.ListFilesContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

Variables:
get_user_error()

User account had a problem.

Only call this if is_user_error() is true.

Return type:SharingUserError
invalid_cursor = ListFilesContinueError(u'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(u'other', None)
classmethod user_error(val)

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

Parameters:val (SharingUserError) –
Return type:ListFilesContinueError
class dropbox.sharing.ListFilesResult(entries=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

cursor
entries
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
class dropbox.sharing.ListFolderMembersContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:ListFolderMembersContinueError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
invalid_cursor = ListFolderMembersContinueError(u'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(u'other', None)
class dropbox.sharing.ListFolderMembersCursorArg(actions=None, limit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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
limit
class dropbox.sharing.ListFoldersContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.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
class dropbox.sharing.ListFoldersContinueError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'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(u'other', None)
class dropbox.sharing.ListFoldersResult(entries=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

cursor
direct_only
path
class dropbox.sharing.ListSharedLinksError(tag, value=None)

Bases: stone.backends.python_rsrc.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_client.Dropbox.sharing_list_shared_links() to obtain a new cursor.
get_path()

Only call this if is_path() is true.

Return type:files.LookupError
is_other()

Check if the union tag is other.

Return type:bool
is_path()

Check if the union tag is path.

Return type:bool
is_reset()

Check if the union tag is reset.

Return type:bool
other = ListSharedLinksError(u'other', None)
classmethod path(val)

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

Parameters:val (files.LookupError) –
Return type:ListSharedLinksError
reset = ListSharedLinksError(u'reset', None)
class dropbox.sharing.ListSharedLinksResult(links=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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
access_level
warning
class dropbox.sharing.MemberAction(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'leave_a_copy', None)
make_editor = MemberAction(u'make_editor', None)
make_owner = MemberAction(u'make_owner', None)
make_viewer = MemberAction(u'make_viewer', None)
make_viewer_no_comment = MemberAction(u'make_viewer_no_comment', None)
other = MemberAction(u'other', None)
remove = MemberAction(u'remove', None)
class dropbox.sharing.MemberPermission(action=None, allow=None, reason=None)

Bases: stone.backends.python_rsrc.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
allow
reason
class dropbox.sharing.MemberPolicy(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'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(u'other', None)
team = MemberPolicy(u'team', None)
class dropbox.sharing.MemberSelector(tag, value=None)

Bases: stone.backends.python_rsrc.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:MemberSelector
classmethod email(val)

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

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

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

Only call this if is_dropbox_id() is true.

Return type:str
get_email()

Email address of member.

Only call this if is_email() is true.

Return type:str
is_dropbox_id()

Check if the union tag is dropbox_id.

Return type:bool
is_email()

Check if the union tag is email.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = MemberSelector(u'other', None)
class dropbox.sharing.MembershipInfo(access_type=None, permissions=None, initials=None, is_inherited=None)

Bases: stone.backends.python_rsrc.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
initials
is_inherited
permissions
class dropbox.sharing.ModifySharedLinkSettingsArgs(url=None, settings=None, remove_expiration=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

remove_expiration
settings
url
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.

Variables:
email_not_verified = ModifySharedLinkSettingsError(u'email_not_verified', None)
get_settings_error()

There is an error with the given settings.

Only call this if is_settings_error() is true.

Return type:SharedLinkSettingsError
is_email_not_verified()

Check if the union tag is email_not_verified.

Return type:bool
is_settings_error()

Check if the union tag is settings_error.

Return type:bool
classmethod settings_error(val)

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

Parameters:val (SharedLinkSettingsError) –
Return type:ModifySharedLinkSettingsError
class dropbox.sharing.MountFolderArg(shared_folder_id=None)

Bases: stone.backends.python_rsrc.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
class dropbox.sharing.MountFolderError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:MountFolderError
already_mounted = MountFolderError(u'already_mounted', None)
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
get_insufficient_quota()

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

Only call this if is_insufficient_quota() is true.

Return type:InsufficientQuotaAmounts
inside_shared_folder = MountFolderError(u'inside_shared_folder', None)
classmethod insufficient_quota(val)

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

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

Check if the union tag is access_error.

Return type:bool
is_already_mounted()

Check if the union tag is already_mounted.

Return type:bool
is_inside_shared_folder()

Check if the union tag is inside_shared_folder.

Return type:bool
is_insufficient_quota()

Check if the union tag is insufficient_quota.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_not_mountable()

Check if the union tag is not_mountable.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
no_permission = MountFolderError(u'no_permission', None)
not_mountable = MountFolderError(u'not_mountable', None)
other = MountFolderError(u'other', None)
class dropbox.sharing.ParentFolderAccessInfo(folder_name=None, shared_folder_id=None, permissions=None, path=None)

Bases: stone.backends.python_rsrc.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
path
permissions
shared_folder_id
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
class dropbox.sharing.PendingUploadMode(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'file', None)
folder = PendingUploadMode(u'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: stone.backends.python_rsrc.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(u'folder_is_inside_shared_folder', None)
folder_is_limited_team_folder = PermissionDeniedReason(u'folder_is_limited_team_folder', None)
get_insufficient_plan()

Only call this if is_insufficient_plan() is true.

Return type:InsufficientPlan
classmethod insufficient_plan(val)

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

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

Check if the union tag is folder_is_inside_shared_folder.

Return type:bool
is_folder_is_limited_team_folder()

Check if the union tag is folder_is_limited_team_folder.

Return type:bool
is_insufficient_plan()

Check if the union tag is insufficient_plan.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_owner_not_on_team()

Check if the union tag is owner_not_on_team.

Return type:bool
is_permission_denied()

Check if the union tag is permission_denied.

Return type:bool
is_restricted_by_parent_folder()

Check if the union tag is restricted_by_parent_folder.

Return type:bool
is_restricted_by_team()

Check if the union tag is restricted_by_team.

Return type:bool
is_target_is_indirect_member()

Check if the union tag is target_is_indirect_member.

Return type:bool
is_target_is_owner()

Check if the union tag is target_is_owner.

Return type:bool
is_target_is_self()

Check if the union tag is target_is_self.

Return type:bool
is_target_not_active()

Check if the union tag is target_not_active.

Return type:bool
is_user_account_type()

Check if the union tag is user_account_type.

Return type:bool
is_user_not_allowed_by_owner()

Check if the union tag is user_not_allowed_by_owner.

Return type:bool
is_user_not_on_team()

Check if the union tag is user_not_on_team.

Return type:bool
is_user_not_same_team_as_owner()

Check if the union tag is user_not_same_team_as_owner.

Return type:bool
other = PermissionDeniedReason(u'other', None)
owner_not_on_team = PermissionDeniedReason(u'owner_not_on_team', None)
permission_denied = PermissionDeniedReason(u'permission_denied', None)
restricted_by_parent_folder = PermissionDeniedReason(u'restricted_by_parent_folder', None)
restricted_by_team = PermissionDeniedReason(u'restricted_by_team', None)
target_is_indirect_member = PermissionDeniedReason(u'target_is_indirect_member', None)
target_is_owner = PermissionDeniedReason(u'target_is_owner', None)
target_is_self = PermissionDeniedReason(u'target_is_self', None)
target_not_active = PermissionDeniedReason(u'target_not_active', None)
user_account_type = PermissionDeniedReason(u'user_account_type', None)
user_not_allowed_by_owner = PermissionDeniedReason(u'user_not_allowed_by_owner', None)
user_not_on_team = PermissionDeniedReason(u'user_not_on_team', None)
user_not_same_team_as_owner = PermissionDeniedReason(u'user_not_same_team_as_owner', None)
class dropbox.sharing.RelinquishFileMembershipArg(file=None)

Bases: stone.backends.python_rsrc.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
class dropbox.sharing.RelinquishFileMembershipError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharingFileAccessError) –
Return type:RelinquishFileMembershipError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
group_access = RelinquishFileMembershipError(u'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(u'no_permission', None)
other = RelinquishFileMembershipError(u'other', None)
class dropbox.sharing.RelinquishFolderMembershipArg(shared_folder_id=None, leave_a_copy=None)

Bases: stone.backends.python_rsrc.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
shared_folder_id
class dropbox.sharing.RelinquishFolderMembershipError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:RelinquishFolderMembershipError
folder_owner = RelinquishFolderMembershipError(u'folder_owner', None)
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
group_access = RelinquishFolderMembershipError(u'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(u'mounted', None)
no_explicit_access = RelinquishFolderMembershipError(u'no_explicit_access', None)
no_permission = RelinquishFolderMembershipError(u'no_permission', None)
other = RelinquishFolderMembershipError(u'other', None)
team_folder = RelinquishFolderMembershipError(u'team_folder', None)
class dropbox.sharing.RemoveFileMemberArg(file=None, member=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

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

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

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

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_no_explicit_access()

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

Only call this if is_no_explicit_access() is true.

Return type:MemberAccessLevelResult
get_user_error()

Only call this if is_user_error() is true.

Return type:SharingUserError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_user_error()

Check if the union tag is user_error.

Return type:bool
classmethod no_explicit_access(val)

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

Parameters:val (MemberAccessLevelResult) –
Return type:RemoveFileMemberError
other = RemoveFileMemberError(u'other', None)
classmethod user_error(val)

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

Parameters:val (SharingUserError) –
Return type:RemoveFileMemberError
class dropbox.sharing.RemoveFolderMemberArg(shared_folder_id=None, member=None, leave_a_copy=None)

Bases: stone.backends.python_rsrc.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
member
shared_folder_id
class dropbox.sharing.RemoveFolderMemberError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:RemoveFolderMemberError
folder_owner = RemoveFolderMemberError(u'folder_owner', None)
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
get_member_error()

Only call this if is_member_error() is true.

Return type:SharedFolderMemberError
group_access = RemoveFolderMemberError(u'group_access', None)
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_folder_owner()

Check if the union tag is folder_owner.

Return type:bool
is_group_access()

Check if the union tag is group_access.

Return type:bool
is_member_error()

Check if the union tag is member_error.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_team_folder()

Check if the union tag is team_folder.

Return type:bool
is_too_many_files()

Check if the union tag is too_many_files.

Return type:bool
classmethod member_error(val)

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

Parameters:val (SharedFolderMemberError) –
Return type:RemoveFolderMemberError
no_permission = RemoveFolderMemberError(u'no_permission', None)
other = RemoveFolderMemberError(u'other', None)
team_folder = RemoveFolderMemberError(u'team_folder', None)
too_many_files = RemoveFolderMemberError(u'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:RemoveMemberJobStatus.complete (MemberAccessLevelResult) – Removing the folder member has finished. The value is information about whether the member has another form of access.
classmethod complete(val)

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

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

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

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

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

Only call this if is_complete() is true.

Return type:MemberAccessLevelResult
get_failed()

Only call this if is_failed() is true.

Return type:RemoveFolderMemberError
is_complete()

Check if the union tag is complete.

Return type:bool
is_failed()

Check if the union tag is failed.

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

Bases: stone.backends.python_rsrc.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:
editor = RequestedLinkAccessLevel(u'editor', None)
is_editor()

Check if the union tag is editor.

Return type:bool
is_max()

Check if the union tag is max.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_viewer()

Check if the union tag is viewer.

Return type:bool
max = RequestedLinkAccessLevel(u'max', None)
other = RequestedLinkAccessLevel(u'other', None)
viewer = RequestedLinkAccessLevel(u'viewer', None)
class dropbox.sharing.RequestedVisibility(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'password', None)
public = RequestedVisibility(u'public', None)
team_only = RequestedVisibility(u'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_no_one()

Check if the union tag is no_one.

Return type:bool
is_only_you()

Check if the union tag is only_you.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_shared_folder_only()

Check if the union tag is shared_folder_only.

Return type:bool
is_team_and_password()

Check if the union tag is team_and_password.

Return type:bool
no_one = ResolvedVisibility(u'no_one', None)
only_you = ResolvedVisibility(u'only_you', None)
other = ResolvedVisibility(u'other', None)
shared_folder_only = ResolvedVisibility(u'shared_folder_only', None)
team_and_password = ResolvedVisibility(u'team_and_password', None)
class dropbox.sharing.RevokeSharedLinkArg(url=None)

Bases: stone.backends.python_rsrc.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
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: stone.backends.python_rsrc.stone_base.Struct

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

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

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

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:SetAccessInheritanceError
get_access_error()

Unable to access shared folder.

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
no_permission = SetAccessInheritanceError(u'no_permission', None)
other = SetAccessInheritanceError(u'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
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: stone.backends.python_rsrc.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
acl_update_policy
force_async
member_policy
path
viewer_info_policy
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(u'no_permission', None)
class dropbox.sharing.ShareFolderErrorBase(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharePathError) –
Return type:ShareFolderErrorBase
email_unverified = ShareFolderErrorBase(u'email_unverified', None)
get_bad_path()

ShareFolderArg.path is invalid.

Only call this if is_bad_path() is true.

Return type:SharePathError
is_bad_path()

Check if the union tag is bad_path.

Return type:bool

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(u'other', None)
team_policy_disallows_member_policy = ShareFolderErrorBase(u'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:ShareFolderJobStatus.complete (SharedFolderMetadata) – The share job has finished. The value is the metadata for the folder.
classmethod complete(val)

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

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

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

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

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

Only call this if is_complete() is true.

Return type:SharedFolderMetadata
get_failed()

Only call this if is_failed() is true.

Return type:ShareFolderError
is_complete()

Check if the union tag is complete.

Return type:bool
is_failed()

Check if the union tag is failed.

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

Bases: 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 (SharedFolderMetadata) –
Return type:ShareFolderLaunch
get_complete()

Only call this if is_complete() is true.

Return type:SharedFolderMetadata
is_complete()

Check if the union tag is complete.

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

Bases: stone.backends.python_rsrc.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 (SharedFolderMetadata) –
Return type:SharePathError
contains_app_folder = SharePathError(u'contains_app_folder', None)
contains_shared_folder = SharePathError(u'contains_shared_folder', None)
contains_team_folder = SharePathError(u'contains_team_folder', None)
get_already_shared()

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

Only call this if is_already_shared() is true.

Return type:SharedFolderMetadata
inside_app_folder = SharePathError(u'inside_app_folder', None)
inside_osx_package = SharePathError(u'inside_osx_package', None)
inside_public_folder = SharePathError(u'inside_public_folder', None)
inside_shared_folder = SharePathError(u'inside_shared_folder', None)
invalid_path = SharePathError(u'invalid_path', None)
is_already_shared()

Check if the union tag is already_shared.

Return type:bool
is_app_folder = SharePathError(u'is_app_folder', None)
is_contains_app_folder()

Check if the union tag is contains_app_folder.

Return type:bool
is_contains_shared_folder()

Check if the union tag is contains_shared_folder.

Return type:bool
is_contains_team_folder()

Check if the union tag is contains_team_folder.

Return type:bool
is_family = SharePathError(u'is_family', None)
is_file = SharePathError(u'is_file', None)
is_inside_app_folder()

Check if the union tag is inside_app_folder.

Return type:bool
is_inside_osx_package()

Check if the union tag is inside_osx_package.

Return type:bool
is_inside_public_folder()

Check if the union tag is inside_public_folder.

Return type:bool
is_inside_shared_folder()

Check if the union tag is inside_shared_folder.

Return type:bool
is_invalid_path()

Check if the union tag is invalid_path.

Return type:bool
is_is_app_folder()

Check if the union tag is is_app_folder.

Return type:bool
is_is_family()

Check if the union tag is is_family.

Return type:bool
is_is_file()

Check if the union tag is is_file.

Return type:bool
is_is_osx_package()

Check if the union tag is is_osx_package.

Return type:bool
is_is_public_folder()

Check if the union tag is is_public_folder.

Return type:bool
is_is_vault()

Check if the union tag is is_vault.

Return type:bool
is_osx_package = SharePathError(u'is_osx_package', None)
is_other()

Check if the union tag is other.

Return type:bool
is_public_folder = SharePathError(u'is_public_folder', None)
is_vault = SharePathError(u'is_vault', None)
other = SharePathError(u'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
url
class dropbox.sharing.SharedContentLinkMetadataBase(audience_options=None, current_audience=None, link_permissions=None, password_protected=None, access_level=None, audience_restricting_shared_folder=None, expiry=None)

Bases: stone.backends.python_rsrc.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
audience_options
audience_restricting_shared_folder
current_audience
expiry
password_protected
class dropbox.sharing.SharedFileMembers(users=None, groups=None, invitees=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.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
id
name
owner_display_names
owner_team
parent_shared_folder_id
path_display
path_lower
permissions
policy
preview_url
time_invited
class dropbox.sharing.SharedFolderAccessError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'email_unverified', None)
invalid_id = SharedFolderAccessError(u'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(u'not_a_member', None)
other = SharedFolderAccessError(u'other', None)
unmounted = SharedFolderAccessError(u'unmounted', None)
class dropbox.sharing.SharedFolderMemberError(tag, value=None)

Bases: stone.backends.python_rsrc.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_no_explicit_access()

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

Only call this if is_no_explicit_access() is true.

Return type:MemberAccessLevelResult
invalid_dropbox_id = SharedFolderMemberError(u'invalid_dropbox_id', None)
is_invalid_dropbox_id()

Check if the union tag is invalid_dropbox_id.

Return type:bool
is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:bool
is_not_a_member()

Check if the union tag is not_a_member.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
classmethod no_explicit_access(val)

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

Parameters:val (MemberAccessLevelResult) –
Return type:SharedFolderMemberError
not_a_member = SharedFolderMemberError(u'not_a_member', None)
other = SharedFolderMemberError(u'other', None)
class dropbox.sharing.SharedFolderMembers(users=None, groups=None, invitees=None, cursor=None)

Bases: stone.backends.python_rsrc.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
groups
invitees
users
class dropbox.sharing.SharedFolderMetadata(access_type=None, is_inside_team_folder=None, is_team_folder=None, name=None, policy=None, preview_url=None, shared_folder_id=None, time_invited=None, owner_display_names=None, owner_team=None, parent_shared_folder_id=None, path_lower=None, parent_folder_name=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, parent_folder_name=None, link_metadata=None, permissions=None, access_inheritance=None)

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

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

Bases: stone.backends.python_rsrc.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, parent_folder_name=None)

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

access_type
is_inside_team_folder
is_team_folder
owner_display_names
owner_team
parent_folder_name
parent_shared_folder_id
path_lower
class dropbox.sharing.SharedLinkAccessFailureReason(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'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(u'login_required', None)
other = SharedLinkAccessFailureReason(u'other', None)
owner_only = SharedLinkAccessFailureReason(u'owner_only', None)
password_required = SharedLinkAccessFailureReason(u'password_required', None)
team_only = SharedLinkAccessFailureReason(u'team_only', None)
class dropbox.sharing.SharedLinkAlreadyExistsMetadata(tag, value=None)

Bases: stone.backends.python_rsrc.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:SharedLinkAlreadyExistsMetadata.metadata (SharedLinkMetadata) – Metadata of the shared link that already exists.
get_metadata()

Metadata of the shared link that already exists.

Only call this if is_metadata() is true.

Return type:SharedLinkMetadata
is_metadata()

Check if the union tag is metadata.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
classmethod metadata(val)

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

Parameters:val (SharedLinkMetadata) –
Return type:SharedLinkAlreadyExistsMetadata
other = SharedLinkAlreadyExistsMetadata(u'other', None)
class dropbox.sharing.SharedLinkError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'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: stone.backends.python_rsrc.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
expires
id
name
path_lower
team_member_info
url
class dropbox.sharing.SharedLinkPolicy(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'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(u'members', None)
other = SharedLinkPolicy(u'other', None)
team = SharedLinkPolicy(u'team', None)
class dropbox.sharing.SharedLinkSettings(require_password=None, link_password=None, expires=None, audience=None, access=None, requested_visibility=None, allow_download=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

access
allow_download
audience
expires
requested_visibility
require_password
class dropbox.sharing.SharedLinkSettingsError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'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(u'not_authorized', None)
class dropbox.sharing.SharingFileAccessError(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'inside_osx_package', None)
inside_public_folder = SharingFileAccessError(u'inside_public_folder', None)
invalid_file = SharingFileAccessError(u'invalid_file', None)
is_folder = SharingFileAccessError(u'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(u'no_permission', None)
other = SharingFileAccessError(u'other', None)
class dropbox.sharing.SharingUserError(tag, value=None)

Bases: stone.backends.python_rsrc.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

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

email_unverified = SharingUserError(u'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(u'other', None)
class dropbox.sharing.TeamMemberInfo(team_info=None, display_name=None, member_id=None)

Bases: stone.backends.python_rsrc.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
member_id
team_info
class dropbox.sharing.TransferFolderArg(shared_folder_id=None, to_dropbox_id=None)

Bases: stone.backends.python_rsrc.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
to_dropbox_id
class dropbox.sharing.TransferFolderError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:TransferFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
invalid_dropbox_id = TransferFolderError(u'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(u'new_owner_email_unverified', None)
new_owner_not_a_member = TransferFolderError(u'new_owner_not_a_member', None)
new_owner_unmounted = TransferFolderError(u'new_owner_unmounted', None)
no_permission = TransferFolderError(u'no_permission', None)
other = TransferFolderError(u'other', None)
team_folder = TransferFolderError(u'team_folder', None)
class dropbox.sharing.UnmountFolderArg(shared_folder_id=None)

Bases: stone.backends.python_rsrc.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
class dropbox.sharing.UnmountFolderError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:UnmountFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_not_unmountable()

Check if the union tag is not_unmountable.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
no_permission = UnmountFolderError(u'no_permission', None)
not_unmountable = UnmountFolderError(u'not_unmountable', None)
other = UnmountFolderError(u'other', None)
class dropbox.sharing.UnshareFileArg(file=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Arguments for dropbox.dropbox_client.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
class dropbox.sharing.UnshareFileError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

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

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

classmethod access_error(val)

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

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

Only call this if is_access_error() is true.

Return type:SharingFileAccessError
get_user_error()

Only call this if is_user_error() is true.

Return type:SharingUserError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_user_error()

Check if the union tag is user_error.

Return type:bool
other = UnshareFileError(u'other', None)
classmethod user_error(val)

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

Parameters:val (SharingUserError) –
Return type:UnshareFileError
class dropbox.sharing.UnshareFolderArg(shared_folder_id=None, leave_a_copy=None)

Bases: stone.backends.python_rsrc.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
shared_folder_id
class dropbox.sharing.UnshareFolderError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:UnshareFolderError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_team_folder()

Check if the union tag is team_folder.

Return type:bool
is_too_many_files()

Check if the union tag is too_many_files.

Return type:bool
no_permission = UnshareFolderError(u'no_permission', None)
other = UnshareFolderError(u'other', None)
team_folder = UnshareFolderError(u'team_folder', None)
too_many_files = UnshareFolderError(u'too_many_files', None)
class dropbox.sharing.UpdateFileMemberArgs(file=None, member=None, access_level=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

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

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

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

Bases: stone.backends.python_rsrc.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
member
shared_folder_id
class dropbox.sharing.UpdateFolderMemberError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:UpdateFolderMemberError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
get_member_error()

Only call this if is_member_error() is true.

Return type:SharedFolderMemberError
get_no_explicit_access()

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

Only call this if is_no_explicit_access() is true.

Return type:AddFolderMemberError
insufficient_plan = UpdateFolderMemberError(u'insufficient_plan', None)
is_access_error()

Check if the union tag is access_error.

Return type:bool
is_insufficient_plan()

Check if the union tag is insufficient_plan.

Return type:bool
is_member_error()

Check if the union tag is member_error.

Return type:bool
is_no_explicit_access()

Check if the union tag is no_explicit_access.

Return type:bool
is_no_permission()

Check if the union tag is no_permission.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
classmethod member_error(val)

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

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

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

Parameters:val (AddFolderMemberError) –
Return type:UpdateFolderMemberError
no_permission = UpdateFolderMemberError(u'no_permission', None)
other = UpdateFolderMemberError(u'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: stone.backends.python_rsrc.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
actions
member_policy
shared_folder_id
viewer_info_policy
class dropbox.sharing.UpdateFolderPolicyError(tag, value=None)

Bases: stone.backends.python_rsrc.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 (SharedFolderAccessError) –
Return type:UpdateFolderPolicyError
get_access_error()

Only call this if is_access_error() is true.

Return type:SharedFolderAccessError
is_access_error()

Check if the union tag is access_error.

Return type:bool

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(u'no_permission', None)
not_on_team = UpdateFolderPolicyError(u'not_on_team', None)
other = UpdateFolderPolicyError(u'other', None)
team_folder = UpdateFolderPolicyError(u'team_folder', None)
team_policy_disallows_member_policy = UpdateFolderPolicyError(u'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
time_last_seen
class dropbox.sharing.UserInfo(account_id=None, email=None, display_name=None, same_team=None, team_member_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

Variables:
__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
display_name
email
same_team
team_member_id
class dropbox.sharing.UserMembershipInfo(access_type=None, user=None, permissions=None, initials=None, is_inherited=None)

Bases: 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
class dropbox.sharing.ViewerInfoPolicy(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'disabled', None)
enabled = ViewerInfoPolicy(u'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(u'other', None)
class dropbox.sharing.Visibility(tag, value=None)

Bases: stone.backends.python_rsrc.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(u'other', None)
password = Visibility(u'password', None)
public = Visibility(u'public', None)
shared_folder_only = Visibility(u'shared_folder_only', None)
team_and_password = Visibility(u'team_and_password', None)
team_only = Visibility(u'team_only', None)
class dropbox.sharing.VisibilityPolicy(policy=None, resolved_policy=None, allowed=None, disallowed_reason=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(policy=None, resolved_policy=None, allowed=None, disallowed_reason=None)

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

allowed
disallowed_reason
policy
resolved_policy
class dropbox.sharing.VisibilityPolicyDisallowedReason(tag, value=None)

Bases: stone.backends.python_rsrc.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:
delete_and_recreate = VisibilityPolicyDisallowedReason(u'delete_and_recreate', None)
is_delete_and_recreate()

Check if the union tag is delete_and_recreate.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_permission_denied()

Check if the union tag is permission_denied.

Return type:bool
is_restricted_by_shared_folder()

Check if the union tag is restricted_by_shared_folder.

Return type:bool
is_restricted_by_team()

Check if the union tag is restricted_by_team.

Return type:bool
is_user_account_type()

Check if the union tag is user_account_type.

Return type:bool
is_user_not_on_team()

Check if the union tag is user_not_on_team.

Return type:bool
other = VisibilityPolicyDisallowedReason(u'other', None)
permission_denied = VisibilityPolicyDisallowedReason(u'permission_denied', None)
restricted_by_shared_folder = VisibilityPolicyDisallowedReason(u'restricted_by_shared_folder', None)
restricted_by_team = VisibilityPolicyDisallowedReason(u'restricted_by_team', None)
user_account_type = VisibilityPolicyDisallowedReason(u'user_account_type', None)
user_not_on_team = VisibilityPolicyDisallowedReason(u'user_not_on_team', None)