rmapi-js
    Preparing search index...

    Interface Metadata

    item level metadata

    Stored with the extension "metadata".

    interface Metadata {
        createdTime?: string;
        deleted?: boolean;
        lastModified: string;
        lastOpened?: string;
        lastOpenedPage?: number;
        metadatamodified?: boolean;
        modified?: boolean;
        new?: boolean;
        parent: string;
        pinned: boolean;
        source?: string;
        synced?: boolean;
        type: "DocumentType" | "CollectionType" | "TemplateType";
        version?: number;
        visibleName: string;
    }
    Index

    Properties

    createdTime? deleted? lastModified lastOpened? lastOpenedPage? metadatamodified? modified? new? parent pinned source? synced? type version? visibleName

    Properties

    createdTime?: string

    creation time, a string of the epoch timestamp

    deleted?: boolean

    [speculative] true if the item has been actually deleted

    lastModified: string

    the last modify time, the string of the epoch timestamp

    lastOpened?: string

    the last opened epoch timestamp, isn't defined for CollectionType

    lastOpenedPage?: number

    the last page opened, isn't defined for CollectionType, starts at 0

    metadatamodified?: boolean

    [speculative] true if the metadata has been modified

    modified?: boolean

    [speculative] true if the item has been modified

    new?: boolean

    whether this is this a newly-installed template

    parent: string

    the id of the parent collection

    This is the empty string for root (no parent), "trash" if it's in the trash, or the id of the parent.

    pinned: boolean

    true of the item is starred

    source?: string

    the provider from which this item was obtained/installed

    Example: a template from "com.remarkable.methods".

    synced?: boolean

    [unknown]

    type: "DocumentType" | "CollectionType" | "TemplateType"

    the type of item this corresponds to

    DocumentType is a document, an epub, pdf, or notebook, CollectionType is a folder.

    version?: number

    [speculative] metadata version, always 0

    visibleName: string

    the visible name of the item, what it's called on the reMarkable

    Settings

    Member Visibility

    On This Page

    Properties