MacroData

data. MacroData

The data schema for a Macro document.

Constructor

new MacroData(data, documentopt)

See:
  • BaseMacro
Properties:
Name Type Attributes Default Description
_id string

The _id which uniquely identifies this Macro document

name string

The name of this Macro

type string

A Macro subtype from CONST.MACRO_TYPES

author string

The _id of a User document which created this Macro *

img string <optional>

An image file path which provides the thumbnail artwork for this Macro

scope string <optional>
global

The scope of this Macro application from CONST.MACRO_SCOPES

command string

The string content of the macro command

folder string | null

The _id of a Folder which contains this Macro

sort number <optional>

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

permission object <optional>

An object which configures user permissions to this Macro

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 BaseMacro <optional>

The document to which this data object belongs

Extends

  • DocumentData