Document Settings

Summary

Document Settings provide persistent per-document storage for extension data. Settings are scoped to a specific document and are not shared across other documents. Use this for document-level notes, annotations, and document-specific configuration.

Overview

• Store data specific to a document (not shared across documents)
• Data persists across browser sessions for the same document
• Key-value storage model (values must be strings)
• All operations return Promises

Sub-Sections

• Fetch Document Settings — Retrieve document-specific stored values
• Add Document Settings — Store or update document-specific values
• Delete Document Settings — Remove document-specific stored values

API Reference

// Fetch a value
SigmaSDK.WRITER.storage.document.fetch("key")
    .then(value => console.log(value));

// Add / Update a value
SigmaSDK.WRITER.storage.document.add({ key: "key", value: "value" })
    .then(() => console.log("Saved"));

// Delete a value
SigmaSDK.WRITER.storage.document.delete("key")
    .then(() => console.log("Deleted"));

Scope Comparison

Related Pages

• Fetch Document Settings
• Add Document Settings
• Delete Document Settings
• Storage Overview
• User Settings