The depth of this folder in its sidebar tree
An array of other Folders which are the displayed children of this one. This differs from the results of Folder.getSubfolders because reports the subset of child folders which are displayed to the current User in the UI.
Return whether the folder is displayed in the sidebar to the current User.
Return an array of the Document instances which are contained within this Folder.
Return an array of the Document instances which are contained within this Folder.
Return a reference to the Document type which is contained within this Folder.
Return a reference to the WorldCollection instance which provides Documents to this Folder.
Return whether the folder is currently expanded within the sidebar interface.
Return the list of ancestors of this folder, starting with the parent.
Export all Documents contained in this Folder to a given Compendium pack. Optionally update existing Documents within the Pack by name, otherwise append all new entries.
A Compendium pack to which the documents will be exported
The updated Compendium Collection instance
Provide a dialog form that allows for exporting the contents of a Folder into an eligible Compendium pack.
A pack ID to set as the default choice in the select input
Additional options passed to the Dialog.prompt method
A Promise which resolves or rejects once the dialog has been submitted or closed
Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.
An array of Folder documents which are subfolders of this one
Present a Dialog form to create a new Folder.
Initial data with which to populate the creation form
A Promise which resolves to the created Folder, or null if the dialog was closed.
The client-side Folder document which extends the common BaseFolder model.
ClientDocumentMixin
Folders The world-level collection of Folder documents
FolderConfig The Folder configuration application