@nutrient-sdk/react-native/src/document/Bookmark.ts

Nutrient React Native SDK

/**
 * A Bookmark is a named location in a document.
 * @interface Bookmark
 * @memberof Bookmark
 * @property {string} [name] - The bookmark name. This is optional.
 * @property {string} displayName - The bookmark display name.
 * @property {string} identifier - A string uniquely identifying the bookmark.
 * @property {number} pageIndex - The page index on which the bookmark is located.
 */
export class Bookmark {
    constructor(params: { displayName: string; identifier: string; pageIndex: number; name?: string }) {
        const { displayName, identifier, pageIndex, name } = params;
        
        this.displayName = displayName;
        this.identifier = identifier;
        this.pageIndex = pageIndex;
        this.name = name;
    }

    /**
     * The bookmark name. This is optional.
     */
    name?: string;
    /**
     * The bookmark display name.
     */
    displayName: string;
    /**
     * A string uniquely identifying the bookmark.
     */
    identifier: string;
    /**
     * The page index on which the bookmark is located.
     */
    pageIndex: number;
}