Interface DocumentType

a file, referred to in the api as a document

interface DocumentType {
    fileType: "epub" | "pdf" | "notebook";
    hash: string;
    id: string;
    lastModified: string;
    lastOpened: string;
    parent?: string;
    pinned: boolean;
    tags?: Tag[];
    type: "DocumentType";
    visibleName: string;
}

Hierarchy (view full)

Properties

fileType hash id lastModified lastOpened parent? pinned tags? type visibleName

Properties

fileType

fileType: "epub" | "pdf" | "notebook"

the type of the file

hash

hash: string

the current hash of the state of this entry

id

id: string

the document id, a uuid4

lastModified

lastModified: string

the last modified timestamp

lastOpened

lastOpened: string

the timestamp of the last time this entry was opened

Optionalparent

parent?: string

the parent of this entry

There are two special parents, "" (empty string) for the root directory, and "trash" for the trash

pinned

pinned: boolean

true if the entry is starred in most ui elements

Optionaltags

tags?: Tag[]

any tags the entry might have

type

type: "DocumentType"

the key to identify this as a document

visibleName

visibleName: string

the visible display name of this entry

Settings

Member Visibility

On This Page

Properties