Options
All
  • Public
  • Public/Protected
  • All
Menu

The data schema for an ActiveEffect document.

mixes

ActiveEffectData

memberof

documents

param data

Initial data from which to construct the ActiveEffect

param context

Construction context options

Hierarchy

Index

Constructors

Methods

  • canUserModify(user: any, action: any, data?: {}): any
  • Test whether a given User has permission to perform some action on this Document

    Parameters

    • user: any

      The User attempting modification

    • action: any

      The attempted action

    • data: {} = {}

      Returns any

      Does the User have permission?

    • testUserPermission(user: any, permission: any, __namedParameters?: { exact: boolean }): any
    • 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(data: any, options: any, user: any): Promise<void>
    • 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>

      A return value of false indicates the creation operation should be cancelled.

    • _initialize(options: any): void
    • Initialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.

      Parameters

      • options: any

      Returns void

    • migrateData(data: any): any
    • inheritdoc

      Parameters

      • data: any

      Returns any

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

      Parameters

      • data: any
      • options: any

      Returns any

    Properties

    metadata: any = ...

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