Class BaseMacro

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

mixes: MacroData
memberof: documents
param data: Initial data from which to construct the Macro
param context: Construction context options

Hierarchy

Document
- BaseMacro

Index

Constructors

constructor

Methods

Properties

Constructors

constructor

new BaseMacro(): BaseMacro

Inherited from Document.constructor
Returns BaseMacro

Methods

testUserPermission

testUserPermission(user: any, permission: any, __namedParameters?: { exact: boolean }): any

Inherited from Document.testUserPermission

Test whether a certain User has a requested permission level (or greater) over the Document

Parameters
- user: any
  
  The User being tested
- permission: any
  
  The permission level from DOCUMENT_OWNERSHIP_LEVELS to test
- __namedParameters: { exact: boolean } = {}
  
  Additional options involved in the permission test
  - exact: boolean
Returns any
Does the user have this permission level over the Document?

_preCreate

_preCreate(data: any, options: any, user: any): Promise<void>

Inherited from Document._preCreate

Perform preliminary operations before a Document of this type is created. Pre-creation operations only occur for the client which requested the operation. Modifications to the pending document before it is persisted should be performed with this.updateSource().

Parameters
- data: any
  
  The initial data object provided to the document creation request
- options: any
  
  Additional options which modify the creation request
- user: any
  
  The User requesting the document creation
Returns Promise<void>

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; type: StringField; author: ForeignDocumentField; img: FilePathField; scope: StringField; command: StringField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; type: StringField; author: ForeignDocumentField; img: FilePathField; scope: StringField; command: StringField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- name: StringField
- type: StringField
- author: ForeignDocumentField
- img: FilePathField
- scope: StringField
- command: StringField
- 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

Properties

Static metadata

metadata: any = ...

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

Static DEFAULT_ICON

DEFAULT_ICON: string = "icons/svg/dice-target.svg"

The default icon used for newly created Macro documents.