Get primary Document instances
Create primary Document instances
Update primary Document instances
Delete primary Document instances
Activate the Socket event listeners used to receive responses from events which modify database documents
The active game socket
Describe the scopes which are suitable as the namespace for a flag key
Describe the scopes which are suitable as the namespace for a flag key
Retrieve Documents based on provided query parameters
The Document definition
Context for the requested operation
The created Document instances
Perform document creation operations
The Document definition
Context for the requested operation
The created Document instances
Perform document update operations
The Document definition
Context for the requested operation
The updated Document instances
Perform document deletion operations
The Document definition
Context for the requested operation
The deleted Document instances
Provide the Logger implementation that should be used for database operations
Log a database operation for an embedded document, capturing the action taken and relevant IDs
The action performed
The document type
The documents modified
Construct a standardized error message given the context of an attempted operation
Handle a SocketResponse from the server when one or multiple documents were created
The provided Socket response
An Array of created Document instances
Handle a SocketResponse from the server when one or multiple documents were updated
The provided Socket response
An Array of updated Document instances
Handle a SocketResponse from the server where Documents are deleted.
The provided Socket response
An Array of deleted Document instances
Perform a standardized pre-creation workflow for all Document types. For internal use only.
Perform a standardized post-creation workflow for all Document types. For internal use only.
An array of callback operations performed after every Document is created
Perform a standardized pre-update workflow for all Document types.
Perform a standardized post-update workflow for all Document types.
An array of callback operations performed after every Document is updated
Perform a standardized pre-delete workflow for all Document types.
Perform a standardized post-deletion workflow for all Document types.
An array of callback operations performed after every Document is deleted
Get the parent document for given request from its provided UUID, if any.
The parent document UUID, or null
The parent document for the transaction
Obtain the document collection for a given Document type, parent, and compendium pack.
The Document name
A parent Document, if applicable
A compendium pack identifier, if applicable
The relevant collection instance for this request
Build a CRUD request.
The initial request data.
Build a CRUD response.
The response data.
The type of response.
The initial response result.
The response options.
Retrieve a Document's Token ancestor, if it exists.
The parent Document
The Token ancestor, or null
A cached array of valid flag scopes which can be read and written.
The client-side database backend implementation which handles Document modification operations.