Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CompendiumFolderCollection

A Collection of Compendium Folders

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

pack

pack: CompendiumPack

apps

apps: Application[]

An Array of application references which will be automatically updated when the collection content changes

invalidDocumentIds

invalidDocumentIds: Set<string> = ...

Record the set of document ids where the Document was not initialized because of invalid source data

Static documentName

documentName: string

The base Document type which is contained within this DocumentCollection

Accessors

documentName

  • get documentName(): string
  • inheritdoc

    Returns string

documentClass

  • get documentClass(): Function

  • A reference to the Document class definition which is contained within this DocumentCollection.

    Returns Function

name

  • get name(): string

  • The Collection class name

    Returns string

Methods

render

  • render(force: any, options: any): void

createDocument

  • createDocument(data: any, context?: any): Document

  • Instantiate a Document for inclusion in the Collection.

    Parameters

    • data: any

      The Document data.

    • context: any = {}

    Returns Document

getInvalid

  • getInvalid(id: string, [options]?: { strict: boolean }): Document

  • Obtain a temporary Document instance for a document id which currently has invalid source data.

    throws

    If strict is true and the requested ID is not in the set of invalid IDs for this collection.

    Parameters

    • id: string

      A document ID with invalid source data.

    • [options]: { strict: boolean } = {}

      Additional options to configure retrieval.

      • strict: boolean

    Returns Document

    An in-memory instance for the invalid Document

get

  • get(id: string, [options]?: { strict: boolean; invalid: boolean }): Document

  • Get an element from the DocumentCollection by its ID.

    throws

    If strict is true and the Document cannot be found.

    Parameters

    • id: string

      The ID of the Document to retrieve.

    • [options]: { strict: boolean; invalid: boolean } = {}

      Additional options to configure retrieval.

      • strict: boolean
      • invalid: boolean

    Returns Document

set

  • set(id: any, document: any): void

delete

  • delete(id: any): void

search

  • search(search: { query: string; filters: FieldFilter[]; exclude: string[] }): string[]

  • Find all Documents which match a given search term using a full-text search against their indexed HTML fields and their name. If filters are provided, results are filtered to only those that match the provided values.

    Parameters

    • search: { query: string; filters: FieldFilter[]; exclude: string[] }

      An object configuring the search

    Returns string[]

updateAll

  • updateAll(transformation: any, condition?: Function, options?: any): Promise<Document[]>

  • Update all objects in this DocumentCollection with a provided transformation. Conditionally filter to only apply to Entities which match a certain condition.

    Parameters

    • transformation: any

      An object of data or function to apply to all matched objects

    • condition: Function = null

      A function which tests whether to target each object

    • options: any = {}

    Returns Promise<Document[]>

    An array of updated data once the operation is complete

_preCreateDocuments

  • _preCreateDocuments(result: any[], options: any, userId: string): void

  • Preliminary actions taken before a set of Documents in this Collection are created.

    internal

    Parameters

    • result: any[]

      An Array of created data objects

    • options: any

      Options which modified the creation operation

    • userId: string

      The ID of the User who triggered the operation

    Returns void

_onCreateDocuments

  • _onCreateDocuments(documents: Document[], result: any[], options: any, userId: string): void

  • Follow-up actions taken after a set of Documents in this Collection are created.

    internal

    Parameters

    • documents: Document[]

      An Array of created Documents

    • result: any[]

      An Array of created data objects

    • options: any

      Options which modified the creation operation

    • userId: string

      The ID of the User who triggered the operation

    Returns void

_preUpdateDocuments

  • _preUpdateDocuments(result: any[], options: any, userId: string): void

  • Preliminary actions taken before a set of Documents in this Collection are updated.

    internal

    Parameters

    • result: any[]

      An Array of incremental data objects

    • options: any

      Options which modified the update operation

    • userId: string

      The ID of the User who triggered the operation

    Returns void

_onUpdateDocuments

  • _onUpdateDocuments(documents: Document[], result: any[], options: any, userId: string): void

  • Follow-up actions taken after a set of Documents in this Collection are updated.

    internal

    Parameters

    • documents: Document[]

      An Array of updated Documents

    • result: any[]

      An Array of incremental data objects

    • options: any

      Options which modified the update operation

    • userId: string

      The ID of the User who triggered the operation

    Returns void

_preDeleteDocuments

  • _preDeleteDocuments(result: string[], options: any, userId: string): void

  • Preliminary actions taken before a set of Documents in this Collection are deleted.

    internal

    Parameters

    • result: string[]

      An Array of document IDs being deleted

    • options: any

      Options which modified the deletion operation

    • userId: string

      The ID of the User who triggered the operation

    Returns void

_onDeleteDocuments

  • _onDeleteDocuments(documents: Document[], result: string[], options: any, userId: string): void

  • Follow-up actions taken after a set of Documents in this Collection are deleted.

    internal

    Parameters

    • documents: Document[]

      An Array of deleted Documents

    • result: string[]

      An Array of document IDs being deleted

    • options: any

      Options which modified the deletion operation

    • userId: string

      The ID of the User who triggered the operation

    Returns void

_onDeleteFolder

  • _onDeleteFolder(parentFolder: Folder, deleteFolderId: string, deleteContents: boolean): string[]

  • Handle shifting documents in a deleted folder to a new parent folder.

    internal

    Parameters

    • parentFolder: Folder

      The parent folder to which documents should be shifted

    • deleteFolderId: string

      The ID of the folder being deleted

    • deleteContents: boolean

      Whether to delete the contents of the folder

    Returns string[]

    An array of document IDs to deleted

Static getSearchableFields

  • getSearchableFields(documentName: string, documentSubtype?: string, isEmbedded?: boolean): Set<string>

  • Get the searchable fields for a given document or index, based on its data model

    Parameters

    • documentName: string

      The document type name

    • documentSubtype: string = ""
    • isEmbedded: boolean = false

    Returns Set<string>

    The dot-delimited property paths of searchable fields