filemeta
Lite API 3.1. Declare workspace.filemeta.namespaces; patch also needs filemeta.write and contribution write access. Paths are Space-relative. Missing namespaces return an empty object. patch preserves other keys; null is a value and remove deletes keys. Envelopes are limited to 1 MiB; filesystem limits can be smaller. Metadata grants do not grant content writes.
Usage guide: files. API index.
Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.
PluginFileMeta
Section titled “PluginFileMeta”PluginFileMeta.read
Section titled “PluginFileMeta.read”Supported hosts: Lite
Read the complete namespace object; a missing namespace returns an empty object.
read(path: string, namespace: string): Promise<FileMetaValues>;| Parameter | Type | Required |
|---|---|---|
path |
string |
Yes |
namespace |
string |
Yes |
Returns: Promise<FileMetaValues>.
PluginFileMeta.patch
Section titled “PluginFileMeta.patch”Supported hosts: Lite
Set or remove selected keys while preserving all other keys.
patch(path: string, namespace: string, patch: FileMetaPatch): Promise<FileMetaValues>;| Parameter | Type | Required |
|---|---|---|
path |
string |
Yes |
namespace |
string |
Yes |
patch |
FileMetaPatch |
Yes |
Returns: Promise<FileMetaValues>.
Related types: FileMetaValues, FileMetaPatch.