Class ShareOptions

Arguments used to create a link share.

Inheritance

System.Object

ShareOptions

SharedDocumentOptions

SharedFolderOptions

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: Hyland.ShareBaseSdk.Models

Assembly: Hyland.ShareBaseSdk.dll

Syntax

public class ShareOptions

Properties

AccessCodeRequired

Enforces Access Code Security which causes an email with verification code to be sent to the recipient's email prior to allowing access to the share.

Declaration

public bool AccessCodeRequired { get; set; }

Property Value

Type	Description
System.Boolean

CustomEmailText

Additional message that's included with the email ShareBase sends to recipients when the share is created.

Declaration

public string CustomEmailText { get; set; }

Property Value

Type	Description
System.String

ExpirationValue

If ExpireStyle is “days”, “hours”, or “minutes”, this should contain the number of days/hours/minutes before the link is to expire; otherwise, this field is optional and ignored. If ExpireStyle is not specified, expiration defaults to “Never”.

Declaration

public long? ExpirationValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

ExpiresOn

If ExpireStyle is “date”, this should contain the date that the link is to expire on; otherwise, this field is optional and ignored. Note: if specified, the time portion of the date is ignored.

Declaration

public DateTime? ExpiresOn { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

ExpireStyle

ExpireStyle is an enumeration value that determines how a link share expires:

• Never – The link share never expires, the default link share expiration.

• Date – The link share expires on a particular date, specified by ExpiresOn.

• Days – The link share expires after ExpirationValue days.

• Hours – The link share expires after ExpirationValue hours.

• Minutes – The link share expires after ExpirationValue minutes.

Declaration

public ExpireStyle? ExpireStyle { get; set; }

Property Value

Type	Description
System.Nullable<ExpireStyle>

Password

Password is optional. If specified and non-empty, the link will be created to require a password. If a password is specified, it will be tested against the password policy configured for the system.

Declaration

public string Password { get; set; }

Property Value

Type	Description
System.String

Recipients

Email addresses of recipients who will have access to the share. Required when AccessCodeRequired is enabled.

Declaration

public string[] Recipients { get; set; }

Property Value

Type	Description
System.String[]