MCPcopy Create free account
hub / github.com/PSPDFKit/nutrient-document-engine-mcp-server / Bookmark

Interface Bookmark

src/api/DocumentEngineSchema.ts:1465–1494  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

1463 * A record representing a bookmark.
1464 */
1465 export interface Bookmark {
1466 /**
1467 * The optional bookmark name. This is used to identify the bookmark.
1468 */
1469 name?: string;
1470 type: 'pspdfkit/bookmark';
1471 /**
1472 * The specification version that the record is compliant to.
1473 */
1474 v: 1;
1475 action: /**
1476 * Represents a PDF action.
1477 *
1478 * There are many different action types. You can learn more about their semantics
1479 * [here](https://www.nutrient.io/guides/ios/annotations/pdf-actions/).
1480 *
1481 * All actions have a `type` property. Depending on the type, the action object
1482 * includes additional properties.
1483 * example:
1484 * {
1485 * "type": "goTo",
1486 * "pageIndex": 0
1487 * }
1488 */
1489 Action;
1490 /**
1491 * The PDF object ID of the bookmark in the PDF.
1492 */
1493 pdfBookmarkId?: string;
1494 }
1495 /**
1496 * BookmarkRecord
1497 */

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected