"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.toolsUserLogoff = exports.toolsSpellCheck = exports.toolsSmartIcons = exports.toolsSetupUserSetup = exports.toolsSetupPorts = exports.toolsSetupMail = exports.toolsSetupLocation = exports.toolsScanUnreadSelected = exports.toolsScanUnreadPreferred = exports.toolsScanUnreadChoose = exports.toolsRunMacro = exports.toolsRunBackgroundMacros = exports.toolsReplicate = exports.toolsRefreshSelectedDocs = exports.toolsRefreshAllDocs = exports.toolsMarkSelectedUnread = exports.toolsMarkSelectedRead = exports.toolsMarkAllUnread = exports.toolsMarkAllRead = exports.toolsHangUp = exports.toolsCategorize = exports.toolsCall = exports._notes = void 0;
const tslib_1 = require("tslib");
/**
* @file Tools
* @module tools
* @category Tools
*/
const notesc = tslib_1.__importStar(require("../notes/tools"));
exports._notes = notesc;
//-----------------------------
// Notes @Commands tools
/**
* Displays the Call Server dialog box, where the user can select a server to dial
* in to.
* @throws {Error} no plans to implement
*/
function toolsCall() {
return notesc.ToolsCall();
}
exports.toolsCall = toolsCall;
/**
* Categorizes the current document.
* @throws {Error} no plans to implement
*/
function toolsCategorize() {
return notesc.ToolsCategorize();
}
exports.toolsCategorize = toolsCategorize;
/**
* Displays the Hang Up dialog box.
* @throws {Error} no plans to implement
*/
function toolsHangUp() {
return notesc.ToolsHangUp();
}
exports.toolsHangUp = toolsHangUp;
/**
* Marks all of the documents in a database as read.
* @throws {Error} no plans to implement
*/
function toolsMarkAllRead() {
return notesc.ToolsMarkAllRead();
}
exports.toolsMarkAllRead = toolsMarkAllRead;
/**
* Marks all of the documents in a database as unread.
* @throws {Error} no plans to implement
*/
function toolsMarkAllUnread() {
return notesc.ToolsMarkAllUnread();
}
exports.toolsMarkAllUnread = toolsMarkAllUnread;
/**
* In a view or folder, marks all of the selected documents as read.
* @throws {Error} no plans to implement
*/
function toolsMarkSelectedRead() {
return notesc.ToolsMarkSelectedRead();
}
exports.toolsMarkSelectedRead = toolsMarkSelectedRead;
/**
* In a view or folder, marks all of the selected documents as unread.
* @throws {Error} no plans to implement
*/
function toolsMarkSelectedUnread() {
return notesc.ToolsMarkSelectedUnread();
}
exports.toolsMarkSelectedUnread = toolsMarkSelectedUnread;
/**
* Refreshes the fields of all the documents in a view or folder.
* @throws {Error} no plans to implement
*/
function toolsRefreshAllDocs() {
return notesc.ToolsRefreshAllDocs();
}
exports.toolsRefreshAllDocs = toolsRefreshAllDocs;
/**
* Refreshes the fields of all the selected documents in a view or folder.
* @throws {Error} no plans to implement
*/
function toolsRefreshSelectedDocs() {
return notesc.ToolsRefreshSelectedDocs();
}
exports.toolsRefreshSelectedDocs = toolsRefreshSelectedDocs;
/**
* Displays the Replicate dialog box, where the user can choose to replicate the
* current database using the options defined in Replicator or using special
* one-time options.
* @throws {Error} no plans to implement
*/
function toolsReplicate() {
return notesc.ToolsReplicate();
}
exports.toolsReplicate = toolsReplicate;
/**
* Runs all of the database's scheduled agents, regardless of when they are
* scheduled to run. The agents will then run as usual at their regularly scheduled
* times.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function toolsRunBackgroundMacros() {
return notesc.ToolsRunBackgroundMacros();
}
exports.toolsRunBackgroundMacros = toolsRunBackgroundMacros;
/**
* Executes a specified agent.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function toolsRunMacro() {
return notesc.ToolsRunMacro();
}
exports.toolsRunMacro = toolsRunMacro;
/**
* Displays the Scan Unread Preferred Setup dialog box, where the user can select
* the preferred databases to be scanned for unread documents.
* @throws {Error} no plans to implement
*/
function toolsScanUnreadChoose() {
return notesc.ToolsScanUnreadChoose();
}
exports.toolsScanUnreadChoose = toolsScanUnreadChoose;
/**
* Displays the Scan Unread dialog box, where the user can see unread counts for
* each of the user preferred databases.
* @throws {Error} no plans to implement
*/
function toolsScanUnreadPreferred() {
return notesc.ToolsScanUnreadPreferred();
}
exports.toolsScanUnreadPreferred = toolsScanUnreadPreferred;
/**
* Opens the selected database to the first unread document. The user can then
* navigate to subsequent unread documents.
* @throws {Error} no plans to implement
*/
function toolsScanUnreadSelected() {
return notesc.ToolsScanUnreadSelected();
}
exports.toolsScanUnreadSelected = toolsScanUnreadSelected;
/**
* Opens the current location document in your Personal Address Book in Edit mode,
* allowing you to change your home server, mail database location, and time zone.
* @throws {Error} no plans to implement
*/
function toolsSetupLocation() {
return notesc.ToolsSetupLocation();
}
exports.toolsSetupLocation = toolsSetupLocation;
/**
* Displays the Mail section of the User Preferences dialog box, where the user can
* indicate how often Notes® should check for new mail, whether to sign and encrypt
* outgoing mail, and so on.
* @throws {Error} no plans to implement
*/
function toolsSetupMail() {
return notesc.ToolsSetupMail();
}
exports.toolsSetupMail = toolsSetupMail;
/**
* Displays the Ports section of the User Preferences dialog box, where the user
* can enable and disable network ports.
* @throws {Error} no plans to implement
*/
function toolsSetupPorts() {
return notesc.ToolsSetupPorts();
}
exports.toolsSetupPorts = toolsSetupPorts;
/**
* Displays the Basics section of the User Preferences dialog box, where the user
* defines Notes® startup options.
* @throws {Error} no plans to implement
*/
function toolsSetupUserSetup() {
return notesc.ToolsSetupUserSetup();
}
exports.toolsSetupUserSetup = toolsSetupUserSetup;
/**
* Displays the Toolbar Preferences dialog box where you can create new toolbars
* and customize the content and display of existing toolbars.
* @throws {Error} no plans to implement
*/
function toolsSmartIcons() {
return notesc.ToolsSmartIcons();
}
exports.toolsSmartIcons = toolsSmartIcons;
/**
* Starts the Notes® spell checker.
* @throws {Error} no plans to implement
*/
function toolsSpellCheck() {
return notesc.ToolsSpellCheck();
}
exports.toolsSpellCheck = toolsSpellCheck;
/**
* Logs the user off of all Domino® servers. Reconnecting to a Domino® server
* requires the user Notes® ID and, if one is set, password.
* @throws {Error} no plans to implement
*/
function toolsUserLogoff() {
return notesc.ToolsUserLogoff();
}
exports.toolsUserLogoff = toolsUserLogoff;
//# sourceMappingURL=tools.js.map