Class BaseFolder

The Document definition for a Folder. Defines the DataSchema and common behaviors for a Folder which are shared between both client and server.

mixes: FolderData
memberof: documents
param data: Initial data from which to construct the Folder
param context: Construction context options

Hierarchy

Document
- BaseFolder

Index

Constructors

constructor

Methods

Properties

Constructors

constructor

new BaseFolder(): BaseFolder

Inherited from Document.constructor
Returns BaseFolder

Methods

_validateModel

_validateModel(data: any): void

inheritdoc
Parameters
- data: any
Returns void

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; type: StringField; description: StringField; folder: ForeignDocumentField; sorting: StringField; sort: IntegerSortField; color: ColorField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; type: StringField; description: StringField; folder: ForeignDocumentField; sorting: StringField; sort: IntegerSortField; color: ColorField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- name: StringField
- type: StringField
- description: StringField
- folder: ForeignDocumentField
- sorting: StringField
- sort: IntegerSortField
- color: ColorField
- flags: ObjectField
- _stats: DocumentStatsField

Static migrateData

migrateData(data: any): any

inheritdoc
Parameters
- data: any
Returns any

Static shimData

shimData(data: any, options: any): any

inheritdoc
Parameters
- data: any
- options: any
Returns any

Properties

Static metadata

metadata: any = ...

Default metadata which applies to each instance of this Document type.

Static SORTING_MODES

SORTING_MODES: string[] = ...

Allow folder sorting modes