Represents a document in a Laserfiche repository.

Hierarchy (View Summary)

Implements

Constructors

Properties

_discriminator: string
checkedOutBy?: string

Display name (account name, e.g. "DOMAIN\user") of the user who checked out the document. Null if the document is not checked out. Account renames change this value over time — do not use for stable identity comparisons. To test whether the current authenticated user holds the checkout, use IsCheckedOutByAnotherUser; it compares stable principal identifiers internally.

creationTime?: Date

The creation time of the entry.

creator?: string

The name of the user that created this entry.

currentVersion?: number

The version number of the document. 0 if the document is not under version control.

electronicDocumentSize?: number

The size of the electronic document attached to the represented document, if there is one, in bytes.

The type of the entry.

extension?: string

The extension for the document.

The fields assigned to this entry.

folderPath?: string

The path in the Laserfiche repository to the parent folder.

fullPath?: string

The full path in the Laserfiche repository to the entry.

id?: number

The ID of the entry.

isCheckedOut?: boolean

A boolean indicating if the represented document is checked out.

isCheckedOutByAnotherUser?: boolean

A boolean indicating if the document is checked out by a user other than the authenticated user. False if the document is not checked out or is checked out by the authenticated user. Computed from a stable principal identifier comparison, not from CheckedOutBy. Only populated on single-entry GET, not in listing results.

isContainer?: boolean

A boolean indicating if this entry is a container object; it can have other entries as children.

isElectronicDocument?: boolean

A boolean indicating if there is an electronic document attached to the represented document.

isLeaf?: boolean

A boolean indicating if this entry is a leaf object; it cannot have other entries as children.

isLocked?: boolean

A boolean indicating if the represented document has a persistent lock.

isLockedByAnotherUser?: boolean

A boolean indicating if the document is locked by a user other than the authenticated user. False if the document is not locked or is locked by the authenticated user. Computed from a stable principal identifier comparison, not from LockedBy. Only populated on single-entry GET, not in listing results.

isRecord?: boolean

A boolean indicating if the represented document is a record.

isUnderVersionControl?: boolean

A boolean indicating if the represented document is under version control.

lastModifiedTime?: Date

The last modification time of the entry.

lockedBy?: string

Display name (account name, e.g. "DOMAIN\user") of the persistent lock holder. Null if the document is not locked. Account renames change this value over time — do not use for stable identity comparisons. To test whether the current authenticated user holds the lock, use IsLockedByAnotherUser; it compares stable principal identifiers internally.

mimeType?: string

The MIME type of the electronic document.

name?: string

The name of the entry.

pageCount?: number

The page count of the represented document.

parentId?: number

The ID of the parent entry.

rowNumber?: number

Row number assigned to this entry in the listing.

templateFieldNames?: string[]

The names of the fields assigned to the template assigned to this entry.

templateId?: number

The id of the template assigned to this entry.

templateName?: string

The name of the template assigned to this entry.

totalDocumentSize?: number

The total size in bytes of the document's stored components — electronic document plus image/text/locations/thumbnail page data and attachments — as opposed to ElectronicDocumentSize, which is just the source file. Present only when requested via the includeTotalSize query parameter; otherwise null. Opt-in because it aggregates across all of the document's pages.

volumeName?: string

The name of the volume that this entry is associated with.

Methods

  • Parameters

    • Optional_data: any

    Returns void

  • Parameters

    • Optionaldata: any

    Returns any