Class CompendiumFolderCollection

apps

invalidDocumentIds

Static documentName

documentClass

• get documentClass(): typeof Document

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

  Returns typeof Document

name

• get name(): string

• The Collection class name

  Returns string

createDocument

• createDocument(data, context?): Document

• Instantiate a Document for inclusion in the Collection.

  Parameters

  • data: object

    The Document data.
  • Optional context: object = {}

    Document creation context.

  Returns Document

getInvalid

• getInvalid(id, options?): Document

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

  Parameters

  • id: string

    A document ID with invalid source data.
  • Optional options: {
        strict: boolean;
    } = {}

    Additional options to configure retrieval.

    • strict: boolean

      Throw an Error if the requested ID is not in the set of invalid IDs for this collection.

  Returns Document

  An in-memory instance for the invalid Document

  Throws

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

get

• get(id, options?): Document

• Get an element from the DocumentCollection by its ID.

  Parameters

  • id: string

    The ID of the Document to retrieve.
  • Optional options: {
        strict: boolean;
        invalid: boolean;
    } = {}

    Additional options to configure retrieval.

    • strict: boolean

      Throw an Error if the requested Document does not exist.

    • invalid: boolean

      Allow retrieving an invalid Document.

  Returns Document

  Throws

  If strict is true and the Document cannot be found.

set

• set(id, document): void

• Parameters

  • id: any
  • document: any

  Returns void

  Inherit Doc

delete

• delete(id): boolean

• Parameters

  • id: any

  Returns boolean

  Inherit Doc

search

• search(search): 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

    • query: string

      A case-insensitive search string

    • filters: FieldFilter[]

      An array of filters to apply

    • exclude: string[]

      An array of document IDs to exclude from search results

  Returns string[]

_onModifyContents

• _onModifyContents(action, documents, result, operation, user): void
• Internal

  Follow-up actions to take when a database operation modifies Documents in this DocumentCollection.

  Parameters

  • action: DatabaseAction

    The database action performed
  • documents: ClientDocument[]

    The array of modified Documents
  • result: any[]

    The result of the database operation
  • operation: DatabaseOperation

    Database operation details
  • user: User

    The User who performed the operation

  Returns void

Static getSearchableFields

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

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

  Parameters

  • documentName: string

    The document type name
  • Optional documentSubtype: string = ""

    The document subtype name
  • Optional isEmbedded: boolean = false

    Whether the document is an embedded object

  Returns Set<string>

  The dot-delimited property paths of searchable fields