Class ShareBaseLibrary
Library is essentially a "super folder" in ShareBase, that contains folders.
Inheritance
Inherited Members
Namespace: Hyland.ShareBaseSdk.Models
Assembly: Hyland.ShareBaseSdk.dll
Syntax
public sealed class ShareBaseLibrary : IShareBaseLibrary, IEquatable<ShareBaseLibrary>
Constructors
ShareBaseLibrary(Int64, String, Dictionary<String, String>)
Constructs a ShareBaseLibrary.
Declaration
[JsonConstructor]
public ShareBaseLibrary(long libraryId, string libraryName, Dictionary<string, string> links)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | libraryId | A unique identifier representing the library. |
System.String | libraryName | The name of the library. |
System.Collections.Generic.Dictionary<System.String, System.String> | links | Links relevant to the library. |
Properties
FoldersUri
A link used to get the folders of the library.
Declaration
public Uri FoldersUri { get; }
Property Value
Type | Description |
---|---|
System.Uri |
LibraryId
A unique identifier representing the library.
Declaration
public long LibraryId { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
LibraryName
The name of the library.
Declaration
public string LibraryName { get; }
Property Value
Type | Description |
---|---|
System.String |
Links
Links relevant to the library.
Declaration
public Dictionary<string, string> Links { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.String> |
SelfUri
A reference to the library itself in the API.
Declaration
public Uri SelfUri { get; }
Property Value
Type | Description |
---|---|
System.Uri |
Methods
Equals(ShareBaseLibrary)
Determines whether a document is equal to this document instance.
Declaration
public bool Equals(ShareBaseLibrary other)
Parameters
Type | Name | Description |
---|---|---|
ShareBaseLibrary | 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 library instance.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj | An object that may be equal to this library. |
Returns
Type | Description |
---|---|
System.Boolean | Whether the objects are equal. |
Overrides
GetHashCode()
Gets a hash code for this library.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The hash code. |
Overrides
Operators
Equality(ShareBaseLibrary, ShareBaseLibrary)
Determines if two libraries are equal.
Declaration
public static bool operator ==(ShareBaseLibrary left, ShareBaseLibrary right)
Parameters
Type | Name | Description |
---|---|---|
ShareBaseLibrary | left | One library. |
ShareBaseLibrary | right | Another library. |
Returns
Type | Description |
---|---|
System.Boolean | Whether the two libraries are equal. |
Inequality(ShareBaseLibrary, ShareBaseLibrary)
Determines if two libraries are not equal.
Declaration
public static bool operator !=(ShareBaseLibrary left, ShareBaseLibrary right)
Parameters
Type | Name | Description |
---|---|---|
ShareBaseLibrary | left | One library. |
ShareBaseLibrary | right | Another library. |
Returns
Type | Description |
---|---|
System.Boolean | Whether the two libraries are not equal. |