Constructor
new FolderData(data, documentopt)
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
_id |
string | The _id which uniquely identifies this Folder document |
||
name |
string | The name of this Folder |
||
type |
string | The document type which this Folder contains, from CONST.FOLDER_DOCUMENT_TYPES |
||
description |
string |
<optional> |
An HTML description of the contents of this folder |
|
parent |
string | null |
<optional> |
The _id of a parent Folder which contains this Folder |
|
sorting |
string |
<optional> |
a
|
The sorting mode used to organize documents within this Folder, in ["a", "m"] |
sort |
number |
<optional> |
The numeric sort value which orders this Folder relative to its siblings |
|
color |
string | null |
<optional> |
A color string used for the background color of this Folder |
|
flags |
object |
<optional> |
{}
|
An object of optional key/value flags |
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
data |
object | Initial data used to construct the data object |
|
document |
BaseFolder |
<optional> |
The document to which this data object belongs |
Extends
- DocumentData