Options
All
  • Public
  • Public/Protected
  • All
Menu

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

mixes

NoteData

memberof

documents

param data

Initial data from which to construct the Note

param context

Construction context options

property

{documents.BaseJournalEntry} entry The JournalEntry document that this Note references

Hierarchy

Index

Constructors

Methods

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

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

DEFAULT_ICON: string = "icons/svg/book.svg"

The default icon used for newly created Note documents.