Class LinkPermissions
The link permissions object
Inheritance
Inherited Members
Namespace: Dropbox.Api.Sharing
Assembly: Dropbox.Api.dll
Syntax
public class LinkPermissions
Constructors
| Improve this Doc View SourceLinkPermissions(Boolean, IEnumerable<VisibilityPolicy>, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, ResolvedVisibility, RequestedVisibility, SharedLinkAccessFailureReason, LinkAudience, LinkAccessLevel, IEnumerable<LinkAudienceOption>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Initializes a new instance of the LinkPermissions class.
Declaration
public LinkPermissions(bool canRevoke, IEnumerable<VisibilityPolicy> visibilityPolicies, bool canSetExpiry, bool canRemoveExpiry, bool allowDownload, bool canAllowDownload, bool canDisallowDownload, bool allowComments, bool teamRestrictsComments, ResolvedVisibility resolvedVisibility = null, RequestedVisibility requestedVisibility = null, SharedLinkAccessFailureReason revokeFailureReason = null, LinkAudience effectiveAudience = null, LinkAccessLevel linkAccessLevel = null, IEnumerable<LinkAudienceOption> audienceOptions = null, bool? canSetPassword = null, bool? canRemovePassword = null, bool? requirePassword = null, bool? canUseExtendedSharingControls = null)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | canRevoke | Whether the caller can revoke the shared link. |
System.Collections.Generic.IEnumerable<VisibilityPolicy> | visibilityPolicies | A list of policies that the user might be able to set for the visibility. |
System.Boolean | canSetExpiry | Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry. |
System.Boolean | canRemoveExpiry | Whether the user can remove the expiry of the link. |
System.Boolean | allowDownload | Whether the link can be downloaded or not. |
System.Boolean | canAllowDownload | Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link. |
System.Boolean | canDisallowDownload | Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link. |
System.Boolean | allowComments | Whether comments are enabled for the linked file. This takes the team commenting policy into account. |
System.Boolean | teamRestrictsComments | Whether the team has disabled commenting globally. |
ResolvedVisibility | resolvedVisibility | The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead. |
RequestedVisibility | requestedVisibility | The shared link's requested visibility. This can
be overridden by the team and shared folder policies. The final visibility, after
considering these policies, can be found in |
SharedLinkAccessFailureReason | revokeFailureReason | The failure reason for revoking the link. This
field will only be present if the |
LinkAudience | effectiveAudience | The type of audience who can benefit from the
access level specified by the |
LinkAccessLevel | linkAccessLevel | The access level that the link will grant to its
users. A link can grant additional rights to a user beyond their current access
level. For example, if a user was invited as a viewer to a file, and then opens a
link with |
System.Collections.Generic.IEnumerable<LinkAudienceOption> | audienceOptions | A list of link audience options the user might be able to set as the new audience. |
System.Nullable<System.Boolean> | canSetPassword | Whether the user can set a password for the link. |
System.Nullable<System.Boolean> | canRemovePassword | Whether the user can remove the password of the link. |
System.Nullable<System.Boolean> | requirePassword | Whether the user is required to provide a password to view the link. |
System.Nullable<System.Boolean> | canUseExtendedSharingControls | Whether the user can use extended sharing controls, based on their account type. |
Properties
| Improve this Doc View SourceAllowComments
Whether comments are enabled for the linked file. This takes the team commenting policy into account.
Declaration
public bool AllowComments { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowDownload
Whether the link can be downloaded or not.
Declaration
public bool AllowDownload { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AudienceOptions
A list of link audience options the user might be able to set as the new audience.
Declaration
public IList<LinkAudienceOption> AudienceOptions { get; protected set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<LinkAudienceOption> |
CanAllowDownload
Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link.
Declaration
public bool CanAllowDownload { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CanDisallowDownload
Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link.
Declaration
public bool CanDisallowDownload { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CanRemoveExpiry
Whether the user can remove the expiry of the link.
Declaration
public bool CanRemoveExpiry { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CanRemovePassword
Whether the user can remove the password of the link.
Declaration
public bool? CanRemovePassword { get; protected set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
CanRevoke
Whether the caller can revoke the shared link.
Declaration
public bool CanRevoke { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CanSetExpiry
Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry.
Declaration
public bool CanSetExpiry { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CanSetPassword
Whether the user can set a password for the link.
Declaration
public bool? CanSetPassword { get; protected set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
CanUseExtendedSharingControls
Whether the user can use extended sharing controls, based on their account type.
Declaration
public bool? CanUseExtendedSharingControls { get; protected set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
EffectiveAudience
The type of audience who can benefit from the access level specified by the
link_access_level
field.
Declaration
public LinkAudience EffectiveAudience { get; protected set; }
Property Value
Type | Description |
---|---|
LinkAudience |
LinkAccessLevel
The access level that the link will grant to its users. A link can grant
additional rights to a user beyond their current access level. For example, if a
user was invited as a viewer to a file, and then opens a link with
link_access_level
set to editor
, then they will gain editor privileges. The
link_access_level
is a property of the link, and does not depend on who is
calling this API. In particular, link_access_level
does not take into account the
API caller's current permissions to the content.
Declaration
public LinkAccessLevel LinkAccessLevel { get; protected set; }
Property Value
Type | Description |
---|---|
LinkAccessLevel |
RequestedVisibility
The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in ResolvedVisibility. This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience.
Declaration
public RequestedVisibility RequestedVisibility { get; protected set; }
Property Value
Type | Description |
---|---|
RequestedVisibility |
RequirePassword
Whether the user is required to provide a password to view the link.
Declaration
public bool? RequirePassword { get; protected set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
ResolvedVisibility
The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead.
Declaration
public ResolvedVisibility ResolvedVisibility { get; protected set; }
Property Value
Type | Description |
---|---|
ResolvedVisibility |
RevokeFailureReason
The failure reason for revoking the link. This field will only be present if
the CanRevoke is false
.
Declaration
public SharedLinkAccessFailureReason RevokeFailureReason { get; protected set; }
Property Value
Type | Description |
---|---|
SharedLinkAccessFailureReason |
TeamRestrictsComments
Whether the team has disabled commenting globally.
Declaration
public bool TeamRestrictsComments { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
VisibilityPolicies
A list of policies that the user might be able to set for the visibility.
Declaration
public IList<VisibilityPolicy> VisibilityPolicies { get; protected set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<VisibilityPolicy> |