Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseItem

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

mixes

ItemData

memberof

documents

param data

Initial data from which to construct the Item

param context

Construction context options

Hierarchy

Index

Constructors

Methods

Properties

Accessors

Constructors

constructor

Methods

canUserModify

  • 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

    • 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?

    Static defineSchema

    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/item-bag.svg"

    The default icon used for newly created Item documents

    Accessors

    Static TYPES

    • get TYPES(): string[]

    • The allowed set of Item types which may exist.

      Returns string[]