Class BaseJournalEntry

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

mixes: JournalEntryData
memberof: documents
param data: Initial data from which to construct the JournalEntry
param context: Construction context options

Hierarchy

Document
- BaseJournalEntry

Index

Constructors

constructor

Methods

Properties

metadata

Constructors

constructor

new BaseJournalEntry(): BaseJournalEntry

Inherited from Document.constructor
Returns BaseJournalEntry

Methods

_initializeSource

_initializeSource(source: any, options?: {}): any

inheritdoc
Parameters
- source: any
- options: {} = {}
Returns any

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; pages: EmbeddedCollectionField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; pages: EmbeddedCollectionField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- name: StringField
- pages: EmbeddedCollectionField
- folder: ForeignDocumentField
- sort: IntegerSortField
- ownership: DocumentOwnershipField
- 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

Static migrateContentToPages

migrateContentToPages(source: any): any[]

Migrate old content and img field to individual pages.

deprecated
since v10

Parameters
- source: any
  
  Old source data which will be mutated in-place
Returns any[]
Page data that should be added to the document

Properties

Static metadata

metadata: any = ...

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