Class LibraryItem

Represents an item in the library.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Extended capability 'LibraryRead'

ContentSize Created Description HasBeenAccessed Id ItemType LastAccess LastModified ParentId Path Properties Signature Title

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Extended capability 'LibraryRead'

ContentSize

  • get ContentSize(): number

  • Gets the content size in bytes of this item.

    Returns number

    Since

    2.0

Created

  • get Created(): DateTime

  • Gets a DateTime describing when this item was created in the library.

    Returns DateTime

    Since

    2.0

Description

  • get Description(): string

  • Gets the description of this item.

    Returns string

    Since

    2.0

HasBeenAccessed

  • get HasBeenAccessed(): boolean

  • Returns true if the contents of this item has been accessed since it was created.

    Returns boolean

    Since

    2.0

Id

  • get Id(): Guid

  • Gets the id of this item. This value shall be used in search and other operations to refer to this item.

    Returns Guid

    Since

    2.0

ItemType

LastAccess

  • get LastAccess(): DateTime

  • Gets a DateTime describing when the contents of this item was last accessed in the library. If this item has never been accessed, DateTime.MinValue is returned.

    Returns DateTime

    Since

    2.0

LastModified

  • get LastModified(): DateTime

  • Gets a DateTime describing when the last modification of this item was made in the library.

    Returns DateTime

    Since

    2.0

ParentId

  • get ParentId(): Guid

  • Gets the id of the parent item of this this item. The parent item is typically a folder in the library.

    Returns Guid

    Since

    2.0

Path

  • get Path(): string

  • Gets the path of this item, or null if the path was not retrieved from the library when this item was created.

    Returns string

    Since

    2.0

Properties

Signature

Title

  • get Title(): string

  • Gets the title of this item.

    Returns string

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Extended capability 'LibraryRead'