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

A document share within ShareBase. Document shares are external shares to ShareBaseDocument instances.

Inheritance
System.Object
DocumentShare
Implements
System.IEquatable<DocumentShare>
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 DocumentShare : IEquatable<DocumentShare>

Constructors

DocumentShare(Int64, Int64, DocumentShareLinks)

Constructs a DocumentShare.

Declaration
[JsonConstructor]
public DocumentShare(long shareId, long documentId, DocumentShareLinks links)
Parameters
Type Name Description
System.Int64 shareId

A unique identifier representing the share.

System.Int64 documentId

The identifier for the shared document.

DocumentShareLinks links

Links relevant to the document share.

Properties

DocumentId

The identifier for the shared document.

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

Links

Links relevant to the document share.

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

ShareId

A unique identifier representing the share.

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

Methods

Equals(DocumentShare)

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

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

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

Returns
Type Description
System.Boolean

Whether the document shares are equal.

Equals(Object)

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

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

An object that may be equal to this document share.

Returns
Type Description
System.Boolean

Whether the objects are equal.

Overrides
System.Object.Equals(System.Object)

GetHashCode()

Gets a hash code for this document share.

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

The hash code.

Overrides
System.Object.GetHashCode()

Operators

Equality(DocumentShare, DocumentShare)

Determines if two document shares are equal.

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

One document share.

DocumentShare right

Another document share.

Returns
Type Description
System.Boolean

Whether the two document shares are equal.

Inequality(DocumentShare, DocumentShare)

Determines if two document shares are not equal.

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

One document share.

DocumentShare right

Another document share.

Returns
Type Description
System.Boolean

Whether the two document shares are not equal.

Implements

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