Identifies an item in the library. Provides access to the subset of the metadata associated with the item that can be used to find the item in the library.

2.0

Hierarchy (view full)

Methods

  • 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

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

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

  • 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

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

  • get Description(): string
  • Gets the description of this item.

    Returns string

    2.0

  • 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

    2.0

  • 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

    2.0

  • get Path(): string
  • Gets the path of this item, or null if the path was not retrieved from the library when this item signature was created.

    Returns string

    2.0

  • get Title(): string
  • Gets the title of this item.

    Returns string

    2.0