Files

An interface for retrieving and managing file attachements.

Drops can include file attachements. MindDrop creates a FileReference containing metadata about the file for every file attachement.

File references contain a attachedTo property which keeps track of the resources the file is attached to. When the last attachedTo value is removed, the file is automatically deleted.

Retrieves file references by ID. If provided a single ID string, returns the file reference or null if not found. If provided an array of IDs, returns an array of the corresponding file references.

Files.get(id: string | string[]): FileReference | null | FileReferenceMap

Retrieves all file references.

Files.getAll(): FileReferenceMap

Creates a new file reference from a file and dispatches a files:create event. Returns a promise which resolves to the new file reference.

Files.create(core: Core, file: File, attachedTo?: string[]): Promise<FileReference>

Deletes a file and its reference and dispatches a files:delete event. Returns the deleted file reference.

Files.delete(core: Core, id: string): FileReference

Adds resource IDs to a file reference's attachedTo value and dispatches a files:add-attachments event as well as a files:update-file-reference event. Returns the updated file reference.

Files.addAttachments(core: Core, fileId: string, resourceIds: string[]): FileReference;

Removes resource IDs from a file reference's attachedTo value.

If the file reference's attachedTo value becomes empty, the files is deleted.

Dispatches a files:replace-attachments event as well as a files:update-file-reference event unless the file was deleted, in which case a files:delete event is dispatched.

Returns the updated file reference.

Files.removeAttachments(core: Core, fileId: string, resourceIds: string[]): FileReference;

Replaces the resource IDs (removing the current ones and adding the given ones) in file reference's attachedTo value.

If resourceIds is an empty array, the file will be deleted.

Dispatches a files:replace-attachments event as well as a files:update-file-reference event unless the file was deleted, in which case a files:delete event is dispatched.

Returns the updated file reference.

Files.replaceAttachments(core: Core, fileId: string, resourceIds: string[]): FileReference;

Loads file references into the store and dispatches a files:load event.

Files.load(core: Core, files: FileReference[]): void

Clears file references from the store and dispatches a files:clear event.

Adds file specific event listeners. Equivalent to calling addEventListener directly on core, but provides more advanced type definitions.

Files.addEventListener(core: Core, event: FileEvent, callback: EventListenerCallback): void

Removes file specific event listeners. Equivalent to calling removeEventListener directly on core, but provides more advanced type definitions.

Files.removeEventListener(core: Core, event: FileEvent, callback: EventListenerCallback): void

UpdateFileReferenceEventData

FileReferenceChanges

AddAttachmentsEventData

RemoveAttachmentsEventData

ReplaceAttachmentsEventData