• 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 FolderShare

A folder share within ShareBase. Folder shares are external shares to see ShareBaseFolder instances.

Inheritance
System.Object
FolderShare
Implements
System.IEquatable<FolderShare>
Inherited Members
System.Object.Equals(System.Object, System.Object)
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 FolderShare : IEquatable<FolderShare>

Constructors

FolderShare(Int64, Int64, String, FolderShareLinks)

Constructs a FolderShare.

Declaration
[JsonConstructor]
public FolderShare(long shareId, long folderId, string referenceString, FolderShareLinks links)
Parameters
Type Name Description
System.Int64 shareId

A unique identifier representing the share.

System.Int64 folderId

The identifier for the shared folder.

System.String referenceString

The reference string for the share.

FolderShareLinks links

Links relevant to the folder share.

Properties

FolderId

The identifier for the shared folder.

Declaration
public long FolderId { get; }
Property Value
Type Description
System.Int64

Links

Links relevant to the folder share.

Declaration
public FolderShareLinks Links { get; }
Property Value
Type Description
FolderShareLinks

ReferenceString

The reference string for the share.

Declaration
public string ReferenceString { get; }
Property Value
Type Description
System.String

ShareId

A unique identifier representing the share.

Declaration
public long ShareId { get; }
Property Value
Type Description
System.Int64

Methods

Equals(FolderShare)

Determines whether a folder share is equal to this folder share instance.

Declaration
public bool Equals(FolderShare other)
Parameters
Type Name Description
FolderShare other

A folder share that may be equal to this folder share.

Returns
Type Description
System.Boolean

Whether the folder shares are equal.

Equals(Object)

Determines whether an object is equal to this folder share instance.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

An object that may be equal to this folder share.

Returns
Type Description
System.Boolean

Whether the objects are equal.

Overrides
System.Object.Equals(System.Object)

GetHashCode()

Gets a hash code for this folder share.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

The hash code.

Overrides
System.Object.GetHashCode()

Operators

Equality(FolderShare, FolderShare)

Determines if two folder shares are equal.

Declaration
public static bool operator ==(FolderShare left, FolderShare right)
Parameters
Type Name Description
FolderShare left

One folder share.

FolderShare right

Another folder share.

Returns
Type Description
System.Boolean

Whether the two folder shares are equal.

Inequality(FolderShare, FolderShare)

Determines if two folder shares are not equal.

Declaration
public static bool operator !=(FolderShare left, FolderShare right)
Parameters
Type Name Description
FolderShare left

One folder share.

FolderShare right

Another folder share.

Returns
Type Description
System.Boolean

Whether the two folder shares are not equal.

Implements

System.IEquatable<T>
Back to top Generated by DocFX