Class ShareBaseFolder

A folder within ShareBase.

Inheritance

System.Object

ShareBaseFolder

Implements

IShareBaseFolder

System.IEquatable<ShareBaseFolder>

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 ShareBaseFolder : IShareBaseFolder, IEquatable<ShareBaseFolder>

Constructors

ShareBaseFolder()

Constructs a ShareBaseFolder.

Declaration

public ShareBaseFolder()

ShareBaseFolder(Int64, String, Int64, Dictionary<String, String>, IEmbedded)

Constructs a ShareBaseFolder.

Declaration

[JsonConstructor]
public ShareBaseFolder(long folderId, string folderName, long libraryId, Dictionary<string, string> links, IEmbedded embedded)

Parameters

Type	Name	Description
System.Int64	folderId	A unique identifier representing the folder.
System.String	folderName	The name of the folder.
System.Int64	libraryId	The identifier for the library where the folder is located.
System.Collections.Generic.Dictionary<System.String, System.String>	links	Links relevant to the folder.
IEmbedded	embedded	Folders and documents within the folder.

Properties

DocumentsUri

A link to the documents within the folder.

Declaration

public Uri DocumentsUri { get; }

Property Value

Type	Description
System.Uri

Embedded

Folders and documents within the folder.

Declaration

public IEmbedded Embedded { get; }

Property Value

Type	Description
IEmbedded

FolderId

A unique identifier representing the folder.

Declaration

public long FolderId { get; }

Property Value

Type	Description
System.Int64

FolderName

The name of the folder.

Declaration

public string FolderName { get; }

Property Value

Type	Description
System.String

FoldersUri

A link to the folders within the folder.

Declaration

public Uri FoldersUri { get; }

Property Value

Type	Description
System.Uri

LibraryId

The identifier for the library where the folder is located.

Declaration

public long LibraryId { get; }

Property Value

Type	Description
System.Int64

Links

Links relevant to the folder.

Declaration

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

Property Value

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

SelfUri

A reference to the folder itself in the API.

Declaration

public Uri SelfUri { get; }

Property Value

Type	Description
System.Uri

SharesUri

A link to create shares.

Declaration

public Uri SharesUri { get; }

Property Value

Type	Description
System.Uri

Methods

Equals(ShareBaseFolder)

Determines whether a folder is equal to this folder instance.

Declaration

public bool Equals(ShareBaseFolder other)

Parameters

Type	Name	Description
ShareBaseFolder	other	A folder that may be equal to this folder.

Returns

Type	Description
System.Boolean	Whether the folders are equal.

Equals(Object)

Determines whether an object is equal to this folder instance.

Declaration

public override bool Equals(object obj)

Parameters

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

Returns

Type	Description
System.Boolean	Whether the objects are equal.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Gets a hash code for this folder.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The hash code.

Overrides

System.Object.GetHashCode()

Operators

Equality(ShareBaseFolder, ShareBaseFolder)

Determines if two folders are equal.

Declaration

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

Parameters

Type	Name	Description
ShareBaseFolder	left	One folder.
ShareBaseFolder	right	Another folder.

Returns

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

Inequality(ShareBaseFolder, ShareBaseFolder)

Determines if two folders are not equal.

Declaration

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

Parameters

Type	Name	Description
ShareBaseFolder	left	One folder.
ShareBaseFolder	right	Another folder.

Returns

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

Implements

IShareBaseFolder

System.IEquatable<T>