Interface FolderData

interface FolderData {
    _id: null | string;
    _stats: DocumentStats;
    color?: null | string;
    description: string;
    flags: DocumentFlags;
    folder?: null | string;
    name: string;
    sort?: number;
    sorting?: string;
    type: string;
}

Properties

_id _stats color? description flags folder? name sort? sorting? type

Properties

_id

_id: null | string

The _id which uniquely identifies this Folder document

_stats

_stats: DocumentStats

An object of creation and access information

Optionalcolor

color?: null | string

A color string used for the background color of this Folder

description

description: string

An HTML description of the contents of this folder

flags

flags: DocumentFlags

An object of optional key/value flags

Optionalfolder

folder?: null | string

The _id of a parent Folder which contains this Folder

name

name: string

The name of this Folder

Optionalsort

sort?: number

The numeric sort value which orders this Folder relative to its siblings

Optionalsorting

sorting?: string

The sorting mode used to organize documents within this Folder, in ["a", "m"]

type

type: string

The document type which this Folder contains, from CONST.FOLDER_DOCUMENT_TYPES

Settings

Member Visibility

On This Page

Properties