file.js

"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.fileSaveNewVersion = exports.filePrintSetup = exports.filePageSetup = exports.fileOpenDBRepID = exports.fileNewReplica = exports.fileNewDatabase = exports.fileImport = exports.fileFullTextUpdate = exports.fileFullTextInfo = exports.fileFullTextDelete = exports.fileFullTextCreate = exports.fileExport = exports.fileExit = exports.fileDatabaseUseServer = exports.fileDatabaseRemove = exports.fileDatabaseInfo = exports.fileDatabaseDelete = exports.fileDatabaseCopy = exports.fileDatabaseCompact = exports.fileDatabaseACL = exports.fileSave = exports.filePrint = exports.fileOpenDatabase = exports.fileCloseWindow = exports._notes_vmx = exports._notes = void 0;
const tslib_1 = require("tslib");
/**
 * @file File
 * @module file
 * @category File
 */
const notesc_base = tslib_1.__importStar(require("../notes/file"));
const notesc_vmx = tslib_1.__importStar(require("../notes/voltmx/file"));
const API = tslib_1.__importStar(require("../rosetta/API"));
const notesc = () => API.isCurrentFrameworkVoltMX() ? notesc_vmx : notesc_base;
exports._notes = notesc_base;
exports._notes_vmx = notesc_vmx;
/**
 * Closes the current application window. Same as the FileCloseWindow command
 * @returns {void}
 */
const fileCloseWindow = () => {
    return notesc().FileCloseWindow();
};
exports.fileCloseWindow = fileCloseWindow;
/**
 * Opens the specified database to the specified view, highlighting the first
 * document whose value in the sort column matches the key. You specify a database
 * using its server and file name.
 * @param {*} serverDatabase
 * @param {string} viewName
 * @param {*} key
 * @returns {Promise<boolean>}
 */
const fileOpenDatabase = (serverDatabase, viewName, key) => {
    return notesc().FileOpenDatabase(serverDatabase, viewName, key);
};
exports.fileOpenDatabase = fileOpenDatabase;
/**
 * Prints the currently open or selected document(s), or the current view.
 * @param {string} numCopies - The number of copies you want to print. Specify an empty string ("") for one copy.
 * @param {string} fromPage - The page of a document where you want to start printing. Specify an empty string ("") if you want to print all pages.
 * @param {string} toPage - The page of a document where you want to stop printing. Specify an empty string ("") if you want to print all pages.
 * @param {string} ifDraft - Either the word "draft", to indicate that you want draft quality printing; or an empty string ("") if you want regular quality printing.
 * @param {string} ifView - Either the word "printview", to indicate that you want to print the current view; or an empty string ("") if you want to print the selected document(s) in a view, not the view itself.
 * @param {string} formName - The name of the form you want to use to print the document. Specify an empty string ("") if you want to print the document using its current form.
 * @param {string} breakType - Either the word "pagebreak", the word "line", or an empty string ("").
 * @param {string} ifReset - Either the word "resetpages", or an empty string ("").
 * @param {any} startDate - Time-date. Optional. Used with the printview parameter when printing a calendar view; indicates the first date to be printed.
 * @param {any} endDate - Time-date. Optional. Used with the printview parameter when printing a calendar view; indicates the last date to be printed.
 * @returns {void}
 */
const filePrint = (numCopies, fromPage, toPage, ifDraft, ifView, formName, breakType, ifReset, startDate, endDate) => {
    return notesc().FilePrint(numCopies, fromPage, toPage, ifDraft, ifView, formName, breakType, ifReset, startDate, endDate);
};
exports.filePrint = filePrint;
/**
 * Performs the menu command File - Save.
 * @returns {Promise<boolean>}
 */
const fileSave = () => {
    return notesc().FileSave();
};
exports.fileSave = fileSave;
/**
 * Displays the access control list for the current database.
 * @throws {Error} No plans to implement
 */
const fileDatabaseACL = () => {
    return notesc().FileDatabaseACL();
};
exports.fileDatabaseACL = fileDatabaseACL;
/**
 * Compacts the white space in a database, and at the same time, converts the old
 * database to the new format.
 * @throws {Error} No plans to implement
 */
const fileDatabaseCompact = () => {
    return notesc().FileDatabaseCompact();
};
exports.fileDatabaseCompact = fileDatabaseCompact;
/**
 * Displays the Copy Database dialog box, where the user can copy the current
 * database to a new location.
 * @throws {Error} No plans to implement
 */
const fileDatabaseCopy = () => {
    return notesc().FileDatabaseCopy();
};
exports.fileDatabaseCopy = fileDatabaseCopy;
/**
 * Permanently deletes the current database file from the hard disk where it is
 * stored.
 * @throws {Error} No plans to implement
 */
const fileDatabaseDelete = () => {
    return notesc().FileDatabaseDelete();
};
exports.fileDatabaseDelete = fileDatabaseDelete;
/**
 * Displays the Properties box for the current database.
 * @throws {Error} No plans to implement
 */
const fileDatabaseInfo = () => {
    return notesc().FileDatabaseInfo();
};
exports.fileDatabaseInfo = fileDatabaseInfo;
/**
 * Removes the current database icon from the workspace.
 * @throws {Error} No plans to implement
 */
const fileDatabaseRemove = () => {
    return notesc().FileDatabaseRemove();
};
exports.fileDatabaseRemove = fileDatabaseRemove;
/**
 * Displays the Switch Servers dialog box, where the user can choose a server that
 * contains a replica of the currently selected database.
 * @throws {Error} No plans to implement
 */
const fileDatabaseUseServer = () => {
    return notesc().FileDatabaseUseServer();
};
exports.fileDatabaseUseServer = fileDatabaseUseServer;
/**
 * Performs the menu command File - Exit (File - Quit on the Macintosh), which
 * closes Notes/Domino and all its open windows.
 * @throws {Error} No plans to implement
 */
const fileExit = () => {
    return notesc().FileExit();
};
exports.fileExit = fileExit;
/**
 * Exports a Notes/Domino document or view.
 * @throws {Error} No plans to implement
 */
const fileExport = () => {
    return notesc().FileExport();
};
exports.fileExport = fileExport;
/**
 * Displays the Full-Text Create Index dialog box, where the user can specify
 * settings for the database's full-text index.
 * @throws {Error} No plans to implement
 */
const fileFullTextCreate = () => {
    return notesc().FileFullTextCreate();
};
exports.fileFullTextCreate = fileFullTextCreate;
/**
 * Deletes a database's full-text index.
 * @throws {Error} No plans to implement
 */
const fileFullTextDelete = () => {
    return notesc().FileFullTextDelete();
};
exports.fileFullTextDelete = fileFullTextDelete;
/**
 * Displays the Full Text tab of the current database's Properties box.
 * @throws {Error} No plans to implement
 */
const fileFullTextInfo = () => {
    return notesc().FileFullTextInfo();
};
exports.fileFullTextInfo = fileFullTextInfo;
/**
 * Updates full-text indexes for local databases or queues the update request for
 * server-based databases.
 * @throws {Error} No plans to implement
 */
const fileFullTextUpdate = () => {
    return notesc().FileFullTextUpdate();
};
exports.fileFullTextUpdate = fileFullTextUpdate;
/**
 * Imports a file into a Notes/Domino document or view.
 * @throws {Error} No plans to implement
 */
const fileImport = () => {
    return notesc().FileImport();
};
exports.fileImport = fileImport;
/**
 * Displays the New Database dialog box, where the user can select a server, title,
 * and file name for a new database.
 * @throws {Error} No plans to implement
 */
const fileNewDatabase = () => {
    return notesc().FileNewDatabase();
};
exports.fileNewDatabase = fileNewDatabase;
/**
 * Displays the New Replica dialog box, where the user can create a replica of the
 * current database.
 * @throws {Error} No plans to implement
 */
const fileNewReplica = () => {
    return notesc().FileNewReplica();
};
exports.fileNewReplica = fileNewReplica;
/**
 * Opens the specified database to the specified view, highlighting the first
 * document whose value in the sort column matches the key. You specify a database
 * using its replica ID, and Notes/Domino searches the workspace and all servers
 * available in the current session to find a replica.
 * @throws {Error} No plans to implement
 */
const fileOpenDBRepID = () => {
    return notesc().FileOpenDBRepID();
};
exports.fileOpenDBRepID = fileOpenDBRepID;
/**
 * Displays the Page Setup dialog box (or, on the Macintosh, the File Print Margins
 * dialog box), which allows you to specify print settings for the selected
 * database.
 * @throws {Error} No plans to implement
 */
const filePageSetup = () => {
    return notesc().FilePageSetup();
};
exports.filePageSetup = filePageSetup;
/**
 * Displays the Print Setup dialog box, which allows you to direct the current view
 * or document to a printer or a file that you specify.
 * @throws {Error} No plans to implement
 */
const filePrintSetup = () => {
    return notesc().FilePrintSetup();
};
exports.filePrintSetup = filePrintSetup;
/**
 * Saves a document as a new version.
 * @throws {Error} No plans to implement
 */
const fileSaveNewVersion = () => {
    return notesc().FileSaveNewVersion();
};
exports.fileSaveNewVersion = fileSaveNewVersion;
//# sourceMappingURL=file.js.map