• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Hyland.ShareBaseSdk
    • IShareBaseClient
    • ShareBaseClient
    • ShareBaseServerLocation
  • Hyland.ShareBaseSdk.Exceptions
    • ForbiddenAccessException
    • NotFoundException
    • ShareBaseException
    • ShareBaseInvalidPasswordException
  • Hyland.ShareBaseSdk.Models
    • DocumentShare
    • DocumentShareLinks
    • Embedded
    • ExpireStyle
    • FolderShare
    • FolderShareLinks
    • ICreateFolderCommand
    • IEmbedded
    • IShareBaseDocument
    • IShareBaseFolder
    • IShareBaseLibrary
    • IShareBaseTempFile
    • IShareBaseTempFileLinks
    • ITagSearchResponse
    • ShareBaseDocument
    • ShareBaseFolder
    • ShareBaseLibrary
    • ShareBaseTagType
    • ShareBaseTagTypeInput
    • ShareBaseTagTypeValue
    • SharedDocumentOptions
    • SharedFolderOptions
    • ShareOptions
    • ShareType
    • TagTypeAssociation
    • TagTypeConstraints
    • TagTypeDataType

Class SharedFolderOptions

Arguments used to create a folder link share.

Inheritance
System.Object
ShareOptions
SharedFolderOptions
Inherited Members
ShareOptions.ExpireStyle
ShareOptions.ExpirationValue
ShareOptions.ExpiresOn
ShareOptions.Password
ShareOptions.AccessCodeRequired
ShareOptions.Recipients
ShareOptions.CustomEmailText
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 sealed class SharedFolderOptions : ShareOptions

Properties

AllowDownload

If it is “true”, AllowView is implied, plus the link will allow the recipient to download documents in their native format. This is equivalent to “Edit” rights with “Allow Download” checked in the existing “Share By Link” functionality in ShareBase.

At least one of AllowView/AllowDownload/AllowUpload must be specified.

Declaration
public bool AllowDownload { get; set; }
Property Value
Type Description
System.Boolean

AllowUpload

If it is “true” the link will allow the recipient to upload documents to the folder. This is equivalent to “Edit” rights in the existing “Share By Link” functionality in ShareBase.

At least one of AllowView/AllowDownload/AllowUpload must be specified.

Declaration
public bool AllowUpload { get; set; }
Property Value
Type Description
System.Boolean

AllowView

If it is “true”, the link will allow the recipient to view the contents of the folder and to view documents in the ShareBase viewer. This is equivalent to “View” rights in the existing “Share By Link” functionality in ShareBase.

At least one of AllowView/AllowDownload/AllowUpload must be specified.

Declaration
public bool AllowView { get; set; }
Property Value
Type Description
System.Boolean

ShareType

A value, used to set the type of folder share. Currently, Content and Template are supported. Note, when using Template, both AllowView and AllowUpload should be enabled so that the end user can see the curated interface that guides them and also upload the desired content.

Declaration
public ShareType ShareType { get; set; }
Property Value
Type Description
ShareType
Back to top Generated by DocFX