Document Metadata

Getting the Document ID and Title

Through the Add-on UI SDK Document object, you can retrieve some information about the current document. Currently, there are asynchronous methods that allow you to retrieve the id() of the document and the title(). Also, associated events will let you listen for when the Document ID or the Document Title have changed, respectively via the documentIdAvailable and documentTitleChange events, which you can listen for with the addOnUISdk.app.on() method.

Example

Copy
import addOnUISdk from "https://new.express.adobe.com/static/add-on-sdk/sdk.js";
  
addOnUISdk.ready.then(() => {
  
  // Get the document ID
  const docId = await addOnUISdk.app.document.id();
  // urn:aaid:sc:VA6C2:679a7c92-33ce-4320-a610-f58ccaf56aa8

  // Get the document title
  const docTitle = await addOnUISdk.app.document.title();
  console.log(`Document ID: ${docId}; Document Title: ${docTitle}`);

  // Listen for document ID change
  addOnUISdk.app.on("documentIdAvailable", data => {
    console.log(`Document ID changed to: ${data.documentId}`);
  });

  // Listen for document title change
  addOnUISdk.app.on("documentTitleChange", data => {
    console.log(`Document title changed to: ${data.documentTitle}`);
  });
});
Copied to your clipboard
import addOnUISdk from "https://new.express.adobe.com/static/add-on-sdk/sdk.js";
  
addOnUISdk.ready.then(() => {
  
  // Get the document ID
  const docId = await addOnUISdk.app.document.id();
  // urn:aaid:sc:VA6C2:679a7c92-33ce-4320-a610-f58ccaf56aa8

  // Get the document title
  const docTitle = await addOnUISdk.app.document.title();
  console.log(`Document ID: ${docId}; Document Title: ${docTitle}`);

  // Listen for document ID change
  addOnUISdk.app.on("documentIdAvailable", data => {
    console.log(`Document ID changed to: ${data.documentId}`);
  });

  // Listen for document title change
  addOnUISdk.app.on("documentTitleChange", data => {
    console.log(`Document title changed to: ${data.documentTitle}`);
  });
});

Last updated 1/20/2025

Was this helpful?

Yes

No