Class SharedLinkSettings

The shared link settings object

Inheritance

System.Object

SharedLinkSettings

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dropbox.Api.Sharing

Assembly: Dropbox.Api.dll

Syntax

public class SharedLinkSettings

Constructors

SharedLinkSettings(Nullable<Boolean>, String, Nullable<DateTime>, LinkAudience, RequestedLinkAccessLevel, RequestedVisibility, Nullable<Boolean>)

Initializes a new instance of the SharedLinkSettings class.

Declaration

public SharedLinkSettings(bool? requirePassword = null, string linkPassword = null, DateTime? expires = null, LinkAudience audience = null, RequestedLinkAccessLevel access = null, RequestedVisibility requestedVisibility = null, bool? allowDownload = null)

Parameters

Type	Name	Description
System.Nullable<System.Boolean>	requirePassword	Boolean flag to enable or disable password protection.
System.String	linkPassword	If requirePassword is true, this is needed to specify the password to access the link.
System.Nullable<System.DateTime>	expires	Expiration time of the shared link. By default the link won't expire.
LinkAudience	audience	The new audience who can benefit from the access level specified by the link's access level specified in the link_access_level field of LinkPermissions. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the effective_audience field of `LinkPermissions.
RequestedLinkAccessLevel	access	Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.
RequestedVisibility	requestedVisibility	Use audience instead. The requested access for this shared link.
System.Nullable<System.Boolean>	allowDownload	Boolean flag to allow or not download capabilities for shared links.

Properties

Access

Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.

Declaration

public RequestedLinkAccessLevel Access { get; protected set; }

Property Value

Type	Description
RequestedLinkAccessLevel

AllowDownload

Boolean flag to allow or not download capabilities for shared links.

Declaration

public bool? AllowDownload { get; protected set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Audience

The new audience who can benefit from the access level specified by the link's access level specified in the link_access_level field of LinkPermissions. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the effective_audience field of `LinkPermissions.

Declaration

public LinkAudience Audience { get; protected set; }

Property Value

Type	Description
LinkAudience

Expires

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

Declaration

public DateTime? Expires { get; protected set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

LinkPassword

If RequirePassword is true, this is needed to specify the password to access the link.

Declaration

public string LinkPassword { get; protected set; }

Property Value

Type	Description
System.String

RequestedVisibility

Use Audience instead. The requested access for this shared link.

Declaration

public RequestedVisibility RequestedVisibility { get; protected set; }

Property Value

Type	Description
RequestedVisibility

RequirePassword

Boolean flag to enable or disable password protection.

Declaration

public bool? RequirePassword { get; protected set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

See Also

ModifySharedLinkSettingsArgs