rmapi-js
    Preparing search index...

    Interface CollectionEntry

    a folder, referred to in the api as a collection

    interface CollectionEntry {
        hash: string;
        id: string;
        lastModified: string;
        parent?: string;
        pinned: boolean;
        tags?: Tag[];
        type: "CollectionType";
        visibleName: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    hash id lastModified parent? pinned tags? type visibleName

    Properties

    hash: string

    the current hash of the state of this entry

    id: string

    the document id, a uuid4

    lastModified: string

    the last modified timestamp

    parent?: string

    the parent of this entry

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

    pinned: boolean

    true if the entry is starred in most ui elements

    tags?: Tag[]

    any tags the entry might have

    type: "CollectionType"

    the key for this as a collection

    visibleName: string

    the visible display name of this entry

    Settings

    Member Visibility

    On This Page

    Properties