@express-document-sdk / AddOnData
AddOnData class provides APIs to read, write, remove private metadata to a Node. This metadata is accessible only to the add-on that has set it.
• get remainingQuota(): Readonly<object>
Readonly<object>
an object with the remaining quota for private metadata on the node for this add-on. The object contains the following properties:
• numKeys: number
• sizeInBytes: number
[iterator]()• [iterator](): Iterator<[string, string], any, any>
Iterator<[string, string], any, any>
an iterator for all the private metadata entries on the node. The iterator yields the metadata key-value pairs.
• clear(): void
Clears all private metadata entries on the node.
void
• getItem(key): undefined | string
Retrieves the private metadata value for the specified key on the node.
• key: string
The key of the private metadata entry to retrieve.
undefined | string
The value of the private metadata entry.
• keys(): string[]
string[]
an array of all keys for the private metadata entries on the node.
• removeItem(key): void
Removes a single private metadata entry on the node.
• key: string
The key of the private metadata entry to remove.
void
• setItem(key, value): void
Sets a private metadata entry on the node.
• key: string
The key for the private metadata entry.
• value: string
The value for the private metadata entry.
void