Class ShareBaseDocument

A document within ShareBase.

Inheritance

System.Object

ShareBaseDocument

Implements

IShareBaseDocument

System.IEquatable<ShareBaseDocument>

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 ShareBaseDocument : IShareBaseDocument, IEquatable<ShareBaseDocument>

Constructors

ShareBaseDocument(Int64, String, Int64, DateTime, Dictionary<String, String>)

Constructs a ShareBaseDocument.

Declaration

[JsonConstructor]
public ShareBaseDocument(long documentId, string documentName, long folderId, DateTime dateModified, Dictionary<string, string> links)

Parameters

Type	Name	Description
System.Int64	documentId	A unique identifier representing the document.
System.String	documentName	The name of the document.
System.Int64	folderId	The identifier for the folder where the document is located.
System.DateTime	dateModified	The date that the document was last modified.
System.Collections.Generic.Dictionary<System.String, System.String>	links	Links relevant to the document.

Properties

ContentUri

A link used to get the content of the document.

Declaration

public Uri ContentUri { get; }

Property Value

Type	Description
System.Uri

DateModified

The date that the document was last modified.

Declaration

public DateTime DateModified { get; }

Property Value

Type	Description
System.DateTime

DocumentId

A unique identifier representing the document.

Declaration

public long DocumentId { get; }

Property Value

Type	Description
System.Int64

DocumentName

The name of the document.

Declaration

public string DocumentName { get; }

Property Value

Type	Description
System.String

FolderId

The identifier for the folder where the document is located.

Declaration

public long FolderId { get; }

Property Value

Type	Description
System.Int64

Links

Links relevant to the document.

Declaration

public Dictionary<string, string> Links { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>

Self

A reference to the document itself in the API.

Declaration

public Uri Self { get; }

Property Value

Type	Description
System.Uri

Methods

Equals(ShareBaseDocument)

Determines whether a document is equal to this document instance.

Declaration

public bool Equals(ShareBaseDocument other)

Parameters

Type	Name	Description
ShareBaseDocument	other	A document that may be equal to this document.

Returns

Type	Description
System.Boolean	Whether the documents are equal.

Equals(Object)

Determines whether an object is equal to this document instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object that may be equal to this document.

Returns

Type	Description
System.Boolean	Whether the objects are equal.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Gets a hash code for this document.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The hash code.

Overrides

System.Object.GetHashCode()

Operators

Equality(ShareBaseDocument, ShareBaseDocument)

Determines if two documents are equal.

Declaration

public static bool operator ==(ShareBaseDocument left, ShareBaseDocument right)

Parameters

Type	Name	Description
ShareBaseDocument	left	One document.
ShareBaseDocument	right	Another document.

Returns

Type	Description
System.Boolean	Whether the two documents are equal.

Inequality(ShareBaseDocument, ShareBaseDocument)

Determines if two documents are not equal.

Declaration

public static bool operator !=(ShareBaseDocument left, ShareBaseDocument right)

Parameters

Type	Name	Description
ShareBaseDocument	left	One document.
ShareBaseDocument	right	Another document.

Returns

Type	Description
System.Boolean	Whether the two documents are not equal.

Implements

IShareBaseDocument

System.IEquatable<T>