Interface IDocument

Represents a document in a Laserfiche repository.

interface IDocument {
    checkedOutBy?: string;
    creationTime?: Date;
    creator?: string;
    currentVersion?: number;
    electronicDocumentSize?: number;
    entryType?: EntryType;
    extension?: string;
    fields?: Field[];
    folderPath?: string;
    fullPath?: string;
    id?: number;
    isCheckedOut?: boolean;
    isCheckedOutByAnotherUser?: boolean;
    isContainer?: boolean;
    isElectronicDocument?: boolean;
    isLeaf?: boolean;
    isLocked?: boolean;
    isLockedByAnotherUser?: boolean;
    isRecord?: boolean;
    isUnderVersionControl?: boolean;
    lastModifiedTime?: Date;
    lockedBy?: string;
    mimeType?: string;
    name?: string;
    pageCount?: number;
    parentId?: number;
    rowNumber?: number;
    templateFieldNames?: string[];
    templateId?: number;
    templateName?: string;
    volumeName?: string;
}

Hierarchy (View Summary)

Implemented by

Properties

checkedOutBy? creationTime? creator? currentVersion? electronicDocumentSize? entryType? extension? fields? folderPath? fullPath? id? isCheckedOut? isCheckedOutByAnotherUser? isContainer? isElectronicDocument? isLeaf? isLocked? isLockedByAnotherUser? isRecord? isUnderVersionControl? lastModifiedTime? lockedBy? mimeType? name? pageCount? parentId? rowNumber? templateFieldNames? templateId? templateName? volumeName?

Properties

OptionalcheckedOutBy

checkedOutBy?: string

The account name of the user who checked out the document. Null if the document is not checked out.

OptionalcreationTime

creationTime?: Date

The creation time of the entry.

Optionalcreator

creator?: string

The name of the user that created this entry.

OptionalcurrentVersion

currentVersion?: number

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

OptionalelectronicDocumentSize

electronicDocumentSize?: number

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

OptionalentryType

entryType?: EntryType

The type of the entry.

Optionalextension

extension?: string

The extension for the document.

Optionalfields

fields?: Field[]

The fields assigned to this entry.

OptionalfolderPath

folderPath?: string

The path in the Laserfiche repository to the parent folder.

OptionalfullPath

fullPath?: string

The full path in the Laserfiche repository to the entry.

Optionalid

id?: number

The ID of the entry.

OptionalisCheckedOut

isCheckedOut?: boolean

A boolean indicating if the represented document is checked out.

OptionalisCheckedOutByAnotherUser

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. Only populated on single-entry GET, not in listing results.

OptionalisContainer

isContainer?: boolean

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

OptionalisElectronicDocument

isElectronicDocument?: boolean

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

OptionalisLeaf

isLeaf?: boolean

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

OptionalisLocked

isLocked?: boolean

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

OptionalisLockedByAnotherUser

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. Only populated on single-entry GET, not in listing results.

OptionalisRecord

isRecord?: boolean

A boolean indicating if the represented document is a record.

OptionalisUnderVersionControl

isUnderVersionControl?: boolean

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

OptionallastModifiedTime

lastModifiedTime?: Date

The last modification time of the entry.

OptionallockedBy

lockedBy?: string

The account name of the persistent lock holder. Null if the document is not locked.

OptionalmimeType

mimeType?: string

The MIME type of the electronic document.

Optionalname

name?: string

The name of the entry.

OptionalpageCount

pageCount?: number

The page count of the represented document.

OptionalparentId

parentId?: number

The ID of the parent entry.

OptionalrowNumber

rowNumber?: number

Row number assigned to this entry in the listing.

OptionaltemplateFieldNames

templateFieldNames?: string[]

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

OptionaltemplateId

templateId?: number

The id of the template assigned to this entry.

OptionaltemplateName

templateName?: string

The name of the template assigned to this entry.

OptionalvolumeName

volumeName?: string

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

Settings

Member Visibility

On This Page

Properties