Created by Docfx
  • Home
  • API Documentation
  • API Documentation
Show / Hide Table of Contents

Namespace Dropbox.Api.Sharing

Classes

AccessInheritance

Information about the inheritance policy of a shared folder.

AccessInheritance.Inherit

The shared folder inherits its members from the parent folder.

AccessInheritance.NoInherit

The shared folder does not inherit its members from the parent folder.

AccessInheritance.Other

The other object

AccessLevel

Defines the access levels for collaborators.

AccessLevel.Editor

The collaborator can both view and edit the shared folder.

AccessLevel.Other

The other object

AccessLevel.Owner

The collaborator is the owner of the shared folder. Owners can view and edit the shared folder as well as set the folder's policies using UpdateFolderPolicyAsync(UpdateFolderPolicyArg).

AccessLevel.Traverse

The collaborator can only view the shared folder that they have access to.

AccessLevel.Viewer

The collaborator can only view the shared folder.

AccessLevel.ViewerNoComment

The collaborator can only view the shared folder and does not have any access to comments.

AclUpdatePolicy

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

AclUpdatePolicy.Editors

Any editor can update the ACL. This may be further restricted to editors on the same team.

AclUpdatePolicy.Other

The other object

AclUpdatePolicy.Owner

Only the owner can update the ACL.

AddFileMemberArgs

Arguments for AddFileMemberAsync(AddFileMemberArgs).

AddFileMemberError

Errors for AddFileMemberAsync(AddFileMemberArgs).

AddFileMemberError.AccessError

The access error object

AddFileMemberError.InvalidComment

The custom message did not pass comment permissions checks.

AddFileMemberError.Other

The other object

AddFileMemberError.RateLimit

The user has reached the rate limit for invitations.

AddFileMemberError.UserError

The user error object

AddFolderMemberArg

The add folder member arg object

AddFolderMemberError

The add folder member error object

AddFolderMemberError.AccessError

Unable to access shared folder.

AddFolderMemberError.BadMember

Members contains a bad invitation recipient.

AddFolderMemberError.BannedMember

The current user has been banned.

AddFolderMemberError.CantShareOutsideTeam

Your team policy does not allow sharing outside of the team.

AddFolderMemberError.EmailUnverified

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.

AddFolderMemberError.InsufficientPlan

The current user's account doesn't support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan.

AddFolderMemberError.InvalidSharedFolder

Invalid shared folder error will be returned as an access_error.

AddFolderMemberError.NoPermission

The current user does not have permission to perform this action.

AddFolderMemberError.Other

The other object

AddFolderMemberError.RateLimit

The current user has hit the limit of invites they can send per day. Try again in 24 hours.

AddFolderMemberError.TeamFolder

This action cannot be performed on a team shared folder.

AddFolderMemberError.TooManyInvitees

The current user is trying to share with too many people at once.

AddFolderMemberError.TooManyMembers

The value is the member limit that was reached.

AddFolderMemberError.TooManyPendingInvites

The value is the pending invite limit that was reached.

AddMember

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

AddMemberSelectorError

The add member selector error object

AddMemberSelectorError.AutomaticGroup

Automatically created groups can only be added to team folders.

AddMemberSelectorError.GroupDeleted

At least one of the specified groups in Members is deleted.

AddMemberSelectorError.GroupNotOnTeam

Sharing to a group that is not on the current user's team.

AddMemberSelectorError.InvalidDropboxId

The value is the ID that could not be identified.

AddMemberSelectorError.InvalidEmail

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

AddMemberSelectorError.Other

The other object

AddMemberSelectorError.UnverifiedDropboxId

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.

AlphaResolvedVisibility

check documentation for ResolvedVisibility.

AlphaResolvedVisibility.NoOne

The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder.

AlphaResolvedVisibility.OnlyYou

Only the current user can view this link.

AlphaResolvedVisibility.Other

The other object

AlphaResolvedVisibility.Password

A link-specific password is required to access the link. Login is not required.

AlphaResolvedVisibility.Public

Anyone who has received the link can access it. No login required.

AlphaResolvedVisibility.SharedFolderOnly

Only members of the shared folder containing the linked file can access the link. Login is required.

AlphaResolvedVisibility.TeamAndPassword

Only members of the same team who have the link-specific password can access the link. Login is required.

AlphaResolvedVisibility.TeamOnly

Only members of the same team can access the link. Login is required.

AudienceExceptionContentInfo

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

AudienceExceptions

The total count and truncated list of information of content inside this folder that has a different audience than the link on this folder. This is only returned for folders.

AudienceRestrictingSharedFolder

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

CollectionLinkMetadata

Metadata for a collection-based shared link.

CreateSharedLinkArg

The create shared link arg object

CreateSharedLinkError

The create shared link error object

CreateSharedLinkError.Other

The other object

CreateSharedLinkError.Path

The path object

CreateSharedLinkWithSettingsArg

The create shared link with settings arg object

CreateSharedLinkWithSettingsError

The create shared link with settings error object

CreateSharedLinkWithSettingsError.AccessDenied

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.

CreateSharedLinkWithSettingsError.EmailNotVerified

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.

CreateSharedLinkWithSettingsError.Path

The path object

CreateSharedLinkWithSettingsError.SettingsError

There is an error with the given settings.

CreateSharedLinkWithSettingsError.SharedLinkAlreadyExists

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

ExpectedSharedContentLinkMetadata

The expected metadata of a shared link for a file or folder when a link is first created for the content. Absent if the link already exists.

FileAction

Sharing actions that may be taken on files.

FileAction.CreateEditLink

Create a shared link to a file that allows users to edit the content.

FileAction.CreateLink

Use create_view_link and create_edit_link instead.

FileAction.CreateViewLink

Create a shared link to a file that only allows users to view the content.

FileAction.DisableViewerInfo

Disable viewer information on the file.

FileAction.EditContents

Change or edit contents of the file.

FileAction.EnableViewerInfo

Enable viewer information on the file.

FileAction.InviteEditor

Add a member with edit permissions.

FileAction.InviteViewer

Add a member with view permissions.

FileAction.InviteViewerNoComment

Add a member with view permissions but no comment permissions.

FileAction.Other

The other object

FileAction.RelinquishMembership

Relinquish one's own membership to the file.

FileAction.ShareLink

Use create_view_link and create_edit_link instead.

FileAction.Unshare

Stop sharing this file.

FileErrorResult

The file error result object

FileErrorResult.FileNotFoundError

File specified by id was not found.

FileErrorResult.InvalidFileActionError

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

FileErrorResult.Other

The other object

FileErrorResult.PermissionDeniedError

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

FileLinkMetadata

The metadata of a file shared link.

FileMemberActionError

The file member action error object

FileMemberActionError.AccessError

Specified file was invalid or user does not have access.

FileMemberActionError.InvalidMember

Specified member was not found.

FileMemberActionError.NoExplicitAccess

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.

FileMemberActionError.NoPermission

User does not have permission to perform this action on this member.

FileMemberActionError.Other

The other object

FileMemberActionIndividualResult

The file member action individual result object

FileMemberActionIndividualResult.MemberError

User was not able to perform this action.

FileMemberActionIndividualResult.Success

Member was successfully removed from this file. If AccessLevel is given, the member still has access via a parent shared folder.

FileMemberActionResult

Per-member result for AddFileMemberAsync(AddFileMemberArgs).

FileMemberRemoveActionResult

The file member remove action result object

FileMemberRemoveActionResult.MemberError

User was not able to remove this member.

FileMemberRemoveActionResult.Other

The other object

FileMemberRemoveActionResult.Success

Member was successfully removed from this file.

FilePermission

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

FolderAction

Actions that may be taken on shared folders.

FolderAction.ChangeOptions

Change folder options, such as who can be invited to join the folder.

FolderAction.CreateLink

Create a shared link for folder.

FolderAction.DisableViewerInfo

Disable viewer information for this folder.

FolderAction.EditContents

Change or edit contents of the folder.

FolderAction.EnableViewerInfo

Enable viewer information on the folder.

FolderAction.InviteEditor

Invite a user or group to join the folder with read and write permission.

FolderAction.InviteViewer

Invite a user or group to join the folder with read permission.

FolderAction.InviteViewerNoComment

Invite a user or group to join the folder with read permission but no comment permissions.

FolderAction.LeaveACopy

Keep a copy of the contents upon leaving or being kicked from the folder.

FolderAction.Other

The other object

FolderAction.RelinquishMembership

Relinquish one's own membership in the folder.

FolderAction.SetAccessInheritance

Set whether the folder inherits permissions from its parent.

FolderAction.ShareLink

Use create_link instead.

FolderAction.Unmount

Unmount the folder.

FolderAction.Unshare

Stop sharing this folder.

FolderLinkMetadata

The metadata of a folder shared link.

FolderPermission

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

FolderPolicy

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

GetFileMetadataArg

Arguments of GetFileMetadataAsync(GetFileMetadataArg).

GetFileMetadataBatchArg

Arguments of GetFileMetadataBatchAsync(GetFileMetadataBatchArg).

GetFileMetadataBatchResult

Per file results of GetFileMetadataBatchAsync(GetFileMetadataBatchArg).

GetFileMetadataError

Error result for GetFileMetadataAsync(GetFileMetadataArg).

GetFileMetadataError.AccessError

The access error object

GetFileMetadataError.Other

The other object

GetFileMetadataError.UserError

The user error object

GetFileMetadataIndividualResult

The get file metadata individual result object

GetFileMetadataIndividualResult.AccessError

The result for this file if it was an error.

GetFileMetadataIndividualResult.Metadata

The result for this file if it was successful.

GetFileMetadataIndividualResult.Other

The other object

GetMetadataArgs

The get metadata args object

GetSharedLinkFileError

The get shared link file error object

GetSharedLinkFileError.Other

The other object

GetSharedLinkFileError.SharedLinkAccessDenied

The caller is not allowed to access this shared link.

GetSharedLinkFileError.SharedLinkIsDirectory

Directories cannot be retrieved by this endpoint.

GetSharedLinkFileError.SharedLinkNotFound

The shared link wasn't found.

GetSharedLinkFileError.UnsupportedLinkType

This type of link is not supported; use ExportAsync(ExportArg) instead.

GetSharedLinkMetadataArg

The get shared link metadata arg object

GetSharedLinksArg

The get shared links arg object

GetSharedLinksError

The get shared links error object

GetSharedLinksError.Other

The other object

GetSharedLinksError.Path

The path object

GetSharedLinksResult

The get shared links result object

GroupInfo

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

GroupMembershipInfo

The information about a group member of the shared content.

InsufficientPlan

The insufficient plan object

InsufficientQuotaAmounts

The insufficient quota amounts object

InviteeInfo

Information about the recipient of a shared content invitation.

InviteeInfo.Email

Email address of invited user.

InviteeInfo.Other

The other object

InviteeMembershipInfo

Information about an invited member of a shared content.

JobError

Error occurred while performing an asynchronous job from UnshareFolderAsync(UnshareFolderArg) or RemoveFolderMemberAsync(RemoveFolderMemberArg).

JobError.Other

The other object

JobError.RelinquishFolderMembershipError

Error occurred while performing RelinquishFolderMembershipAsync(RelinquishFolderMembershipArg) action.

JobError.RemoveFolderMemberError

Error occurred while performing RemoveFolderMemberAsync(RemoveFolderMemberArg) action.

JobError.UnshareFolderError

Error occurred while performing UnshareFolderAsync(UnshareFolderArg) action.

JobStatus

The job status object

JobStatus.Complete

The asynchronous job has finished.

JobStatus.Failed

The asynchronous job returned an error.

JobStatus.InProgress

The asynchronous job is still in progress.

LinkAccessLevel

The link access level object

LinkAccessLevel.Editor

Users who use the link can edit, view and comment on the content.

LinkAccessLevel.Other

The other object

LinkAccessLevel.Viewer

Users who use the link can view and comment on the content.

LinkAction

Actions that can be performed on a link.

LinkAction.ChangeAccessLevel

Change the access level of the link.

LinkAction.ChangeAudience

Change the audience of the link.

LinkAction.Other

The other object

LinkAction.RemoveExpiry

Remove the expiry date of the link.

LinkAction.RemovePassword

Remove the password of the link.

LinkAction.SetExpiry

Create or modify the expiry date of the link.

LinkAction.SetPassword

Create or modify the password of the link.

LinkAudience

The link audience object

LinkAudience.Members

Link is accessible only by members of the content.

LinkAudience.NoOne

The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights.

LinkAudience.Other

The other object

LinkAudience.Password

Use require_password instead. A link-specific password is required to access the link. Login is not required.

LinkAudience.Public

Link is accessible by anyone.

LinkAudience.Team

Link is accessible only by team members.

LinkAudienceDisallowedReason

check documentation for VisibilityPolicyDisallowedReason.

LinkAudienceDisallowedReason.DeleteAndRecreate

The user needs to delete and recreate the link to change the visibility policy.

LinkAudienceDisallowedReason.Other

The other object

LinkAudienceDisallowedReason.PermissionDenied

The user does not have permission.

LinkAudienceDisallowedReason.RestrictedBySharedFolder

The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder.

LinkAudienceDisallowedReason.RestrictedByTeam

The team policy prevents links being shared outside the team.

LinkAudienceDisallowedReason.UserAccountType

The user is a basic user or is on a limited team.

LinkAudienceDisallowedReason.UserNotOnTeam

The user needs to be on a team to set this policy.

LinkAudienceOption

The link audience option object

LinkExpiry

The link expiry object

LinkExpiry.Other

The other object

LinkExpiry.RemoveExpiry

Remove the currently set expiry for the link.

LinkExpiry.SetExpiry

Set a new expiry or change an existing expiry.

LinkMetadata

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

LinkPassword

The link password object

LinkPassword.Other

The other object

LinkPassword.RemovePassword

Remove the currently set password for the link.

LinkPassword.SetPassword

Set a new password or change an existing password.

LinkPermission

Permissions for actions that can be performed on a link.

LinkPermissions

The link permissions object

LinkSettings

Settings that apply to a link.

ListFileMembersArg

Arguments for ListFileMembersAsync(ListFileMembersArg).

ListFileMembersBatchArg

Arguments for ListFileMembersBatchAsync(ListFileMembersBatchArg).

ListFileMembersBatchResult

Per-file result for ListFileMembersBatchAsync(ListFileMembersBatchArg).

ListFileMembersContinueArg

Arguments for ListFileMembersContinueAsync(ListFileMembersContinueArg).

ListFileMembersContinueError

Error for ListFileMembersContinueAsync(ListFileMembersContinueArg).

ListFileMembersContinueError.AccessError

The access error object

ListFileMembersContinueError.InvalidCursor

Cursor is invalid.

ListFileMembersContinueError.Other

The other object

ListFileMembersContinueError.UserError

The user error object

ListFileMembersCountResult

The list file members count result object

ListFileMembersError

Error for ListFileMembersAsync(ListFileMembersArg).

ListFileMembersError.AccessError

The access error object

ListFileMembersError.Other

The other object

ListFileMembersError.UserError

The user error object

ListFileMembersIndividualResult

The list file members individual result object

ListFileMembersIndividualResult.AccessError

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

ListFileMembersIndividualResult.Other

The other object

ListFileMembersIndividualResult.Result

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

ListFilesArg

Arguments for ListReceivedFilesAsync(ListFilesArg).

ListFilesContinueArg

Arguments for ListReceivedFilesContinueAsync(ListFilesContinueArg).

ListFilesContinueError

Error results for ListReceivedFilesContinueAsync(ListFilesContinueArg).

ListFilesContinueError.InvalidCursor

Cursor is invalid.

ListFilesContinueError.Other

The other object

ListFilesContinueError.UserError

User account had a problem.

ListFilesResult

Success results for ListReceivedFilesAsync(ListFilesArg).

ListFolderMembersArgs

The list folder members args object

ListFolderMembersContinueArg

The list folder members continue arg object

ListFolderMembersContinueError

The list folder members continue error object

ListFolderMembersContinueError.AccessError

The access error object

ListFolderMembersContinueError.InvalidCursor

Cursor is invalid.

ListFolderMembersContinueError.Other

The other object

ListFolderMembersCursorArg

The list folder members cursor arg object

ListFoldersArgs

The list folders args object

ListFoldersContinueArg

The list folders continue arg object

ListFoldersContinueError

The list folders continue error object

ListFoldersContinueError.InvalidCursor

Cursor is invalid.

ListFoldersContinueError.Other

The other object

ListFoldersResult

Result for ListFoldersAsync(ListFoldersArgs) or ListMountableFoldersAsync(ListFoldersArgs), depending on which endpoint was requested.

Unmounted shared folders can be identified by the absence of .

ListSharedLinksArg

The list shared links arg object

ListSharedLinksError

The list shared links error object

ListSharedLinksError.Other

The other object

ListSharedLinksError.Path

The path object

ListSharedLinksError.Reset

Indicates that the cursor has been invalidated. Call ListSharedLinksAsync(ListSharedLinksArg) to obtain a new cursor.

ListSharedLinksResult

The list shared links result object

MemberAccessLevelResult

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

MemberAction

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

MemberAction.LeaveACopy

Allow the member to keep a copy of the folder when removing.

MemberAction.MakeEditor

Make the member an editor of the folder.

MemberAction.MakeOwner

Make the member an owner of the folder.

MemberAction.MakeViewer

Make the member a viewer of the folder.

MemberAction.MakeViewerNoComment

Make the member a viewer of the folder without commenting permissions.

MemberAction.Other

The other object

MemberAction.Remove

Remove the member from the folder.

MemberPermission

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

MemberPolicy

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

MemberPolicy.Anyone

Anyone can become a member.

MemberPolicy.Other

The other object

MemberPolicy.Team

Only a teammate can become a member.

MemberSelector

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

MemberSelector.DropboxId

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

MemberSelector.Email

Email address of member.

MemberSelector.Other

The other object

MembershipInfo

The information about a member of the shared content.

ModifySharedLinkSettingsArgs

The modify shared link settings args object

ModifySharedLinkSettingsError

The modify shared link settings error object

ModifySharedLinkSettingsError.EmailNotVerified

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.

ModifySharedLinkSettingsError.Other

The other object

ModifySharedLinkSettingsError.SettingsError

There is an error with the given settings.

ModifySharedLinkSettingsError.SharedLinkAccessDenied

The caller is not allowed to access this shared link.

ModifySharedLinkSettingsError.SharedLinkNotFound

The shared link wasn't found.

ModifySharedLinkSettingsError.UnsupportedLinkType

This type of link is not supported; use ExportAsync(ExportArg) instead.

MountFolderArg

The mount folder arg object

MountFolderError

The mount folder error object

MountFolderError.AccessError

The access error object

MountFolderError.AlreadyMounted

The shared folder is already mounted.

MountFolderError.InsideSharedFolder

Mounting would cause a shared folder to be inside another, which is disallowed.

MountFolderError.InsufficientQuota

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

MountFolderError.NoPermission

The current user does not have permission to perform this action.

MountFolderError.NotMountable

The shared folder is not mountable. One example where this can occur is when the shared folder belongs within a team folder in the user's Dropbox.

MountFolderError.Other

The other object

ParentFolderAccessInfo

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

PathLinkMetadata

Metadata for a path-based shared link.

PendingUploadMode

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

PendingUploadMode.File

Assume pending uploads are files.

PendingUploadMode.Folder

Assume pending uploads are folders.

PermissionDeniedReason

Possible reasons the user is denied a permission.

PermissionDeniedReason.FolderIsInsideSharedFolder

Folder is inside of another shared folder.

PermissionDeniedReason.FolderIsLimitedTeamFolder

Folder is team folder for a limited team.

PermissionDeniedReason.InsufficientPlan

The insufficient plan object

PermissionDeniedReason.Other

The other object

PermissionDeniedReason.OwnerNotOnTeam

The content owner needs to be on a Dropbox team to perform this action.

PermissionDeniedReason.PermissionDenied

The user does not have permission to perform this action on the link.

PermissionDeniedReason.RestrictedByParentFolder

Policy cannot be changed due to restrictions from parent folder.

PermissionDeniedReason.RestrictedByTeam

The user's team policy prevents performing this action on the link.

PermissionDeniedReason.TargetIsIndirectMember

Target is indirectly a member of the folder, for example by being part of a group.

PermissionDeniedReason.TargetIsOwner

Target is the owner of the folder.

PermissionDeniedReason.TargetIsSelf

Target is the user itself.

PermissionDeniedReason.TargetNotActive

Target is not an active member of the team.

PermissionDeniedReason.UserAccountType

The user's account type does not support this action.

PermissionDeniedReason.UserNotAllowedByOwner

User is prohibited by the owner from taking the action.

PermissionDeniedReason.UserNotOnTeam

The user needs to be on a Dropbox team to perform this action.

PermissionDeniedReason.UserNotSameTeamAsOwner

User is not on the same team as the folder owner.

RelinquishFileMembershipArg

The relinquish file membership arg object

RelinquishFileMembershipError

The relinquish file membership error object

RelinquishFileMembershipError.AccessError

The access error object

RelinquishFileMembershipError.GroupAccess

The current user has access to the shared file via a group. You can't relinquish membership to a file shared via groups.

RelinquishFileMembershipError.NoPermission

The current user does not have permission to perform this action.

RelinquishFileMembershipError.Other

The other object

RelinquishFolderMembershipArg

The relinquish folder membership arg object

RelinquishFolderMembershipError

The relinquish folder membership error object

RelinquishFolderMembershipError.AccessError

The access error object

RelinquishFolderMembershipError.FolderOwner

The current user is the owner of the shared folder. Owners cannot relinquish membership to their own folders. Try unsharing or transferring ownership first.

RelinquishFolderMembershipError.GroupAccess

The current user has access to the shared folder via a group. You can't relinquish membership to folders shared via groups.

RelinquishFolderMembershipError.Mounted

The shared folder is currently mounted. Unmount the shared folder before relinquishing membership.

RelinquishFolderMembershipError.NoExplicitAccess

The current user only has inherited access to the shared folder. You can't relinquish inherited membership to folders.

RelinquishFolderMembershipError.NoPermission

The current user does not have permission to perform this action.

RelinquishFolderMembershipError.Other

The other object

RelinquishFolderMembershipError.TeamFolder

This action cannot be performed on a team shared folder.

RemoveFileMemberArg

Arguments for RemoveFileMember2Async(RemoveFileMemberArg).

RemoveFileMemberError

Errors for RemoveFileMember2Async(RemoveFileMemberArg).

RemoveFileMemberError.AccessError

The access error object

RemoveFileMemberError.NoExplicitAccess

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.

RemoveFileMemberError.Other

The other object

RemoveFileMemberError.UserError

The user error object

RemoveFolderMemberArg

The remove folder member arg object

RemoveFolderMemberError

The remove folder member error object

RemoveFolderMemberError.AccessError

The access error object

RemoveFolderMemberError.FolderOwner

The target user is the owner of the shared folder. You can't remove this user until ownership has been transferred to another member.

RemoveFolderMemberError.GroupAccess

The target user has access to the shared folder via a group.

RemoveFolderMemberError.MemberError

The member error object

RemoveFolderMemberError.NoPermission

The current user does not have permission to perform this action.

RemoveFolderMemberError.Other

The other object

RemoveFolderMemberError.TeamFolder

This action cannot be performed on a team shared folder.

RemoveFolderMemberError.TooManyFiles

This shared folder has too many files for leaving a copy. You can still remove this user without leaving a copy.

RemoveMemberJobStatus

The remove member job status object

RemoveMemberJobStatus.Complete

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

RemoveMemberJobStatus.Failed

The failed object

RemoveMemberJobStatus.InProgress

The asynchronous job is still in progress.

RequestedLinkAccessLevel

The requested link access level object

RequestedLinkAccessLevel.Editor

Users who use the link can edit, view and comment on the content. Note not all file types support edit links yet.

RequestedLinkAccessLevel.Max

Request for the maximum access level you can set the link to.

RequestedLinkAccessLevel.Other

The other object

RequestedLinkAccessLevel.Viewer

Users who use the link can view and comment on the content.

RequestedVisibility

The access permission that can be requested by the caller for the shared link. Note that the final resolved visibility of the shared link takes into account other aspects, such as team and shared folder settings. Check the ResolvedVisibility for more info on the possible resolved visibility values of shared links.

RequestedVisibility.Password

A link-specific password is required to access the link. Login is not required.

RequestedVisibility.Public

Anyone who has received the link can access it. No login required.

RequestedVisibility.TeamOnly

Only members of the same team can access the link. Login is required.

ResolvedVisibility

The actual access permissions values of shared links after taking into account user preferences and the team and shared folder settings. Check the RequestedVisibility for more info on the possible visibility values that can be set by the shared link's owner.

ResolvedVisibility.NoOne

The link merely points the user to the content, and does not grant any additional rights. Existing members of the content who use this link can only access the content with their pre-existing access rights. Either on the file directly, or inherited from a parent folder.

ResolvedVisibility.OnlyYou

Only the current user can view this link.

ResolvedVisibility.Other

The other object

ResolvedVisibility.Password

A link-specific password is required to access the link. Login is not required.

ResolvedVisibility.Public

Anyone who has received the link can access it. No login required.

ResolvedVisibility.SharedFolderOnly

Only members of the shared folder containing the linked file can access the link. Login is required.

ResolvedVisibility.TeamAndPassword

Only members of the same team who have the link-specific password can access the link. Login is required.

ResolvedVisibility.TeamOnly

Only members of the same team can access the link. Login is required.

RevokeSharedLinkArg

The revoke shared link arg object

RevokeSharedLinkError

The revoke shared link error object

RevokeSharedLinkError.Other

The other object

RevokeSharedLinkError.SharedLinkAccessDenied

The caller is not allowed to access this shared link.

RevokeSharedLinkError.SharedLinkMalformed

Shared link is malformed.

RevokeSharedLinkError.SharedLinkNotFound

The shared link wasn't found.

RevokeSharedLinkError.UnsupportedLinkType

This type of link is not supported; use ExportAsync(ExportArg) instead.

SetAccessInheritanceArg

The set access inheritance arg object

SetAccessInheritanceError

The set access inheritance error object

SetAccessInheritanceError.AccessError

Unable to access shared folder.

SetAccessInheritanceError.NoPermission

The current user does not have permission to perform this action.

SetAccessInheritanceError.Other

The other object

SharedContentLinkMetadata

Metadata of a shared link for a file or folder.

SharedContentLinkMetadataBase

The shared content link metadata base object

SharedFileMembers

Shared file user, group, and invitee membership.

Used for the results of ListFileMembersAsync(ListFileMembersArg) and ListFileMembersContinueAsync(ListFileMembersContinueArg), and used as part of the results for ListFileMembersBatchAsync(ListFileMembersBatchArg).

SharedFileMetadata

Properties of the shared file.

SharedFolderAccessError

There is an error accessing the shared folder.

SharedFolderAccessError.EmailUnverified

Never set.

SharedFolderAccessError.InvalidId

This shared folder ID is invalid.

SharedFolderAccessError.NotAMember

The user is not a member of the shared folder thus cannot access it.

SharedFolderAccessError.Other

The other object

SharedFolderAccessError.Unmounted

The shared folder is unmounted.

SharedFolderMemberError

The shared folder member error object

SharedFolderMemberError.InvalidDropboxId

The target dropbox_id is invalid.

SharedFolderMemberError.NoExplicitAccess

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

SharedFolderMemberError.NotAMember

The target dropbox_id is not a member of the shared folder.

SharedFolderMemberError.Other

The other object

SharedFolderMembers

Shared folder user and group membership.

SharedFolderMetadata

The metadata which includes basic information about the shared folder.

SharedFolderMetadataBase

Properties of the shared folder.

SharedLinkAccessFailureReason

The shared link access failure reason object

SharedLinkAccessFailureReason.EmailVerifyRequired

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.

SharedLinkAccessFailureReason.LoginRequired

User is not logged in.

SharedLinkAccessFailureReason.Other

The other object

SharedLinkAccessFailureReason.OwnerOnly

Access is allowed for the shared link's owner only.

SharedLinkAccessFailureReason.PasswordRequired

The link is password protected.

SharedLinkAccessFailureReason.TeamOnly

Access is allowed for team members only.

SharedLinkAlreadyExistsMetadata

The shared link already exists metadata object

SharedLinkAlreadyExistsMetadata.Metadata

Metadata of the shared link that already exists.

SharedLinkAlreadyExistsMetadata.Other

The other object

SharedLinkError

The shared link error object

SharedLinkError.Other

The other object

SharedLinkError.SharedLinkAccessDenied

The caller is not allowed to access this shared link.

SharedLinkError.SharedLinkNotFound

The shared link wasn't found.

SharedLinkError.UnsupportedLinkType

This type of link is not supported; use ExportAsync(ExportArg) instead.

SharedLinkMetadata

The metadata of a shared link.

SharedLinkPolicy

Who can view shared links in this folder.

SharedLinkPolicy.Anyone

Links can be shared with anyone.

SharedLinkPolicy.Members

Links can only be shared among members of the shared folder.

SharedLinkPolicy.Other

The other object

SharedLinkPolicy.Team

Links can be shared with anyone on the same team as the owner.

SharedLinkSettings

The shared link settings object

SharedLinkSettingsError

The shared link settings error object

SharedLinkSettingsError.InvalidSettings

The given settings are invalid (for example, all attributes of the SharedLinkSettings are empty, the requested visibility is RequestedVisibility.Password but the LinkPassword is missing, Expires is set to the past, etc.).

SharedLinkSettingsError.NotAuthorized

User is not allowed to modify the settings of this link. Note that basic users can only set RequestedVisibility.Public as the RequestedVisibility and cannot set Expires.

ShareFolderArg

The share folder arg object

ShareFolderArgBase

The share folder arg base object

ShareFolderError

The share folder error object

ShareFolderError.BadPath

is invalid.

ShareFolderError.DisallowedSharedLinkPolicy

The current user's account is not allowed to select the specified .

ShareFolderError.EmailUnverified

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.

ShareFolderError.NoPermission

The current user does not have permission to perform this action.

ShareFolderError.Other

The other object

ShareFolderError.TeamPolicyDisallowsMemberPolicy

Team policy is more restrictive than .

ShareFolderErrorBase

The share folder error base object

ShareFolderErrorBase.BadPath

is invalid.

ShareFolderErrorBase.DisallowedSharedLinkPolicy

The current user's account is not allowed to select the specified .

ShareFolderErrorBase.EmailUnverified

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

ShareFolderErrorBase.Other

The other object

ShareFolderErrorBase.TeamPolicyDisallowsMemberPolicy

Team policy is more restrictive than .

ShareFolderJobStatus

The share folder job status object

ShareFolderJobStatus.Complete

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

ShareFolderJobStatus.Failed

The failed object

ShareFolderJobStatus.InProgress

The asynchronous job is still in progress.

ShareFolderLaunch

The share folder launch object

ShareFolderLaunch.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

ShareFolderLaunch.Complete

The complete object

SharePathError

The share path error object

SharePathError.AlreadyShared

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

SharePathError.ContainsAppFolder

We do not support shared folders that contain app folders.

SharePathError.ContainsSharedFolder

We do not support shared folders that contain shared folders.

SharePathError.ContainsTeamFolder

We do not support shared folders that contain team folders.

SharePathError.InsideAppFolder

We do not support sharing a folder inside an app folder.

SharePathError.InsideOsxPackage

We do not support sharing a folder inside a Mac OS X package.

SharePathError.InsidePublicFolder

A folder inside a public folder can't be shared this way. Use a public link instead.

SharePathError.InsideSharedFolder

We do not support sharing a folder inside a shared folder.

SharePathError.InvalidPath

Path is not valid.

SharePathError.IsAppFolder

We do not support sharing an app folder.

SharePathError.IsFamily

We do not support sharing the Family folder.

SharePathError.IsFile

A file is at the specified path.

SharePathError.IsOsxPackage

We do not support sharing a Mac OS X package.

SharePathError.IsPublicFolder

A public folder can't be shared this way. Use a public link instead.

SharePathError.IsVault

We do not support sharing the Vault folder.

SharePathError.IsVaultLocked

We do not support sharing a folder inside a locked Vault.

SharePathError.Other

The other object

SharingFileAccessError

User could not access this file.

SharingFileAccessError.InsideOsxPackage

A Mac OS X package can't be shared this way. Use a shared link instead.

SharingFileAccessError.InsidePublicFolder

A file inside a public folder can't be shared this way. Use a public link instead.

SharingFileAccessError.InvalidFile

File specified was not found.

SharingFileAccessError.IsFolder

A folder can't be shared this way. Use folder sharing or a shared link instead.

SharingFileAccessError.NoPermission

Current user does not have sufficient privileges to perform the desired action.

SharingFileAccessError.Other

The other object

SharingUserError

User account had a problem preventing this action.

SharingUserError.EmailUnverified

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.

SharingUserError.Other

The other object

TeamMemberInfo

Information about a team member.

TransferFolderArg

The transfer folder arg object

TransferFolderError

The transfer folder error object

TransferFolderError.AccessError

The access error object

TransferFolderError.InvalidDropboxId

ToDropboxId is invalid.

TransferFolderError.NewOwnerEmailUnverified

The new designated owner's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.

TransferFolderError.NewOwnerNotAMember

The new designated owner is not currently a member of the shared folder.

TransferFolderError.NewOwnerUnmounted

The new designated owner has not added the folder to their Dropbox.

TransferFolderError.NoPermission

The current user does not have permission to perform this action.

TransferFolderError.Other

The other object

TransferFolderError.TeamFolder

This action cannot be performed on a team shared folder.

UnmountFolderArg

The unmount folder arg object

UnmountFolderError

The unmount folder error object

UnmountFolderError.AccessError

The access error object

UnmountFolderError.NoPermission

The current user does not have permission to perform this action.

UnmountFolderError.NotUnmountable

The shared folder can't be unmounted. One example where this can occur is when the shared folder's parent folder is also a shared folder that resides in the current user's Dropbox.

UnmountFolderError.Other

The other object

UnshareFileArg

Arguments for UnshareFileAsync(UnshareFileArg).

UnshareFileError

Error result for UnshareFileAsync(UnshareFileArg).

UnshareFileError.AccessError

The access error object

UnshareFileError.Other

The other object

UnshareFileError.UserError

The user error object

UnshareFolderArg

The unshare folder arg object

UnshareFolderError

The unshare folder error object

UnshareFolderError.AccessError

The access error object

UnshareFolderError.NoPermission

The current user does not have permission to perform this action.

UnshareFolderError.Other

The other object

UnshareFolderError.TeamFolder

This action cannot be performed on a team shared folder.

UnshareFolderError.TooManyFiles

This shared folder has too many files to be unshared.

UpdateFileMemberArgs

Arguments for UpdateFileMemberAsync(UpdateFileMemberArgs).

UpdateFolderMemberArg

The update folder member arg object

UpdateFolderMemberError

The update folder member error object

UpdateFolderMemberError.AccessError

The access error object

UpdateFolderMemberError.InsufficientPlan

The current user's account doesn't support this action. An example of this is when downgrading a member from editor to viewer. This action can only be performed by users that have upgraded to a Pro or Business plan.

UpdateFolderMemberError.MemberError

The member error object

UpdateFolderMemberError.NoExplicitAccess

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

UpdateFolderMemberError.NoPermission

The current user does not have permission to perform this action.

UpdateFolderMemberError.Other

The other object

UpdateFolderPolicyArg

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

UpdateFolderPolicyError

The update folder policy error object

UpdateFolderPolicyError.AccessError

The access error object

UpdateFolderPolicyError.DisallowedSharedLinkPolicy

The current account is not allowed to select the specified .

UpdateFolderPolicyError.NoPermission

The current user does not have permission to perform this action.

UpdateFolderPolicyError.NotOnTeam

MemberPolicy was set even though user is not on a team.

UpdateFolderPolicyError.Other

The other object

UpdateFolderPolicyError.TeamFolder

This action cannot be performed on a team shared folder.

UpdateFolderPolicyError.TeamPolicyDisallowsMemberPolicy

Team policy is more restrictive than .

UserFileMembershipInfo

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

UserInfo

Basic information about a user. Use GetAccountAsync(GetAccountArg) and GetAccountBatchAsync(GetAccountBatchArg) to obtain more detailed information.

UserMembershipInfo

The information about a user member of the shared content.

ViewerInfoPolicy

The viewer info policy object

ViewerInfoPolicy.Disabled

Viewer information is disabled on this file.

ViewerInfoPolicy.Enabled

Viewer information is available on this file.

ViewerInfoPolicy.Other

The other object

Visibility

Who can access a shared link. The most open visibility is Visibility.Public. The default depends on many aspects, such as team and user preferences and shared folder settings.

Visibility.Other

The other object

Visibility.Password

A link-specific password is required to access the link. Login is not required.

Visibility.Public

Anyone who has received the link can access it. No login required.

Visibility.SharedFolderOnly

Only members of the shared folder containing the linked file can access the link. Login is required.

Visibility.TeamAndPassword

Only members of the same team who have the link-specific password can access the link.

Visibility.TeamOnly

Only members of the same team can access the link. Login is required.

VisibilityPolicy

The visibility policy object

VisibilityPolicyDisallowedReason

The visibility policy disallowed reason object

VisibilityPolicyDisallowedReason.DeleteAndRecreate

The user needs to delete and recreate the link to change the visibility policy.

VisibilityPolicyDisallowedReason.Other

The other object

VisibilityPolicyDisallowedReason.PermissionDenied

The user does not have permission.

VisibilityPolicyDisallowedReason.RestrictedBySharedFolder

The parent shared folder restricts sharing of links outside the shared folder. To change the visibility policy, remove the restriction from the parent shared folder.

VisibilityPolicyDisallowedReason.RestrictedByTeam

The team policy prevents links being shared outside the team.

VisibilityPolicyDisallowedReason.UserAccountType

The user is a basic user or is on a limited team.

VisibilityPolicyDisallowedReason.UserNotOnTeam

The user needs to be on a team to set this policy.

In This Article
  • Classes
Back to top Generated by DocFX