"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.styleCycleKey = exports.smartIconsNextSet = exports.smartIconsFloating = exports.setCurrentLocation = exports.sendInstantMessage = exports.remoteDebugLotusScript = exports.pictureProperties = exports.pasteBitmapAsObject = exports.pasteBitmapAsBackground = exports.insertSubform = exports.goUpLevel = exports.formActions = exports.findFreeTimeDialog = exports.exitNotes = exports.execute = exports.exchangeUnreadMarks = exports.directories = exports.dialingRules = exports.debugLotusScript = exports.copySelectedAsTable = exports.clear = exports.checkCalendar = exports.calendarGoTo = exports.calendarFormat = exports.addToIMContactList = exports.addBookmark = exports.viewShowThisUnread = exports.verifyPassword = exports.validateInternetAddress = exports.setViewInfo = exports.setEnvironment = exports.postedCommand = exports.passwordQuality = exports.mailSend = exports.launchApp = exports.hotspotProperties = exports.hotspotClear = exports.hashPassword = exports.environment = exports.enableAlarms = exports.dialogBox = exports.checkAlarms = exports._notes_vmx = exports._notes = void 0;
const tslib_1 = require("tslib");
/**
* @file Miscellaneous
* @module miscellaneous
* @category Miscellaneous
*/
const notesf_base = tslib_1.__importStar(require("../notes/miscellaneous"));
const notesf_vmx = tslib_1.__importStar(require("../notes/voltmx/miscellaneous"));
const API = tslib_1.__importStar(require("../rosetta/API"));
const notesf = () => API.isCurrentFrameworkVoltMX() ? notesf_vmx : notesf_base;
const notesc = notesf; // notes commands are exposed in the notes functions source file; this notesc is just for visual cue
exports._notes = notesf_base;
exports._notes_vmx = notesf_vmx;
//-----------------------------
// Notes @functions misc
/**
* Triggers the alarm daemon to check for new alarms in the mail file.
* @throws {Error} no plans to implement
*/
function checkAlarms() {
return notesf().CheckAlarms();
}
exports.checkAlarms = checkAlarms;
/**
* Brings up a dialog box that displays the current document (either open or
* selected in a view). The dialog box shares fields with the underlying document.
* The user interacts with the dialog box as usual, clicking OK or Cancel when
* finished.
*
* This function can be used with any form, but it's particularly useful with forms
* that contain a single table or layout region, because the user can interact with
* the table or layout region as if it were a dialog box.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function dialogBox() {
return notesf().DialogBox();
}
exports.dialogBox = dialogBox;
/**
* Starts or stops the alarm daemon.
* @throws {Error} no plans to implement
*/
function enableAlarms() {
return notesf().EnableAlarms();
}
exports.enableAlarms = enableAlarms;
/**
* Sets or returns an environment variable stored in a formula.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function environment(key, value) {
return notesf().Environment(key, value);
}
exports.environment = environment;
/**
* Encodes a string.
* @param {string} text. The string that you want to encode.
* @returns {string} encodedString.
*/
function hashPassword(text) {
return notesf().HashPassword(text);
}
exports.hashPassword = hashPassword;
/**
* Removes a hotspot, without deleting the underlying text or graphic.
* @throws {Error} no plans to implement
*/
function hotspotClear() {
return notesf().HotspotClear();
}
exports.hotspotClear = hotspotClear;
/**
* Displays the Properties box for the current hotspot.
* @throws {Error} no plans to implement
*/
function hotspotProperties() {
return notesf().HotspotProperties();
}
exports.hotspotProperties = hotspotProperties;
/**
* Launches the requested Domino® application.
* @throws {Error} no plans to implement
*/
function launchApp() {
return notesf().LaunchApp();
}
exports.launchApp = launchApp;
/**
* There are two ways to use @MailSend:
* - When used with no parameters, @MailSend mails the current document (the one
* being processed when the @function is evaluated) to the recipient designated
* in the document's SendTo field. The document must have a SendTo field.
* - When used with one or more parameters, @MailSend composes a new mail memo
* based on the information you supply in the arguments list, and sends it to the
* recipients listed in the sendTo, copyTo, and blindcopyTo arguments.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function mailSend() {
return notesf().MailSend();
}
exports.mailSend = mailSend;
/**
* Evaluates the return value of a Password data type field with a number.
* @throws {Error} no plans to implement
*/
function passwordQuality() {
return notesf().PasswordQuality();
}
exports.passwordQuality = passwordQuality;
/**
* Indicates whether a field is locked by an administration policy and cannot be
* modified.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function postedCommand() {
return notesf().PostedCommand();
}
exports.postedCommand = postedCommand;
/**
* Sets an environment variable stored in the user's notes.ini file (Windows™,
* OS/2, and UNIX™) or Notes® Preferences file (Macintosh).
* @throws {Error} method not implemented
*/
function setEnvironment(key, value) {
if (value === undefined) {
throw new Error('Insufficient arguments');
}
return notesf().SetEnvironment(key, value);
}
exports.setEnvironment = setEnvironment;
/**
* In Standard Outline views, filters a view to display only documents from a
* specified category. In Calendar views, filters a view to display only documents
* that contain a specified string in a specified column.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function setViewInfo() {
return notesf().SetViewInfo();
}
exports.setViewInfo = setViewInfo;
/**
* Validates an Internet address based on the RFC 822 or RFC 821 Address Format
* Syntax.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function validateInternetAddress() {
return notesf().ValidateInternetAddress();
}
exports.validateInternetAddress = validateInternetAddress;
/**
* Compares two passwords.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function verifyPassword() {
return notesf().VerifyPassword();
}
exports.verifyPassword = verifyPassword;
/**
* Changes a view to show only unread documents, or to show read and unread
* documents.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function viewShowThisUnread() {
return notesf().ViewShowThisUnread();
}
exports.viewShowThisUnread = viewShowThisUnread;
//-----------------------------
// Notes @Commands misc
/**
* Adds a bookmark with the specified URL or current object.
* @throws {Error} no plans to implement
*/
function addBookmark() {
return notesc().AddBookmark();
}
exports.addBookmark = addBookmark;
/**
* Adds a name or names to a personal group in the Instant Messaging Contact List.
* @throws {Error} no plans to implement
*/
function addToIMContactList() {
return notesc().AddToIMContactList();
}
exports.addToIMContactList = addToIMContactList;
/**
* Changes the Calendar view to display one day, two days, one work week, one week,
* two work weeks, two weeks, one work month, one month, or one year.
* @throws {Error} no plans to implement
*/
function calendarFormat() {
return notesc().CalendarFormat();
}
exports.calendarFormat = calendarFormat;
/**
* Goes to a particular date in a Calendar view.
* @throws {Error} no plans to implement
*/
function calendarGoTo() {
return notesc().CalendarGoTo();
}
exports.calendarGoTo = calendarGoTo;
/**
* Pops up a dialog box containing a one-day calendar view. The current database
* must contain a calendar view for this command to function properly.
* @throws {Error} no plans to implement
*/
function checkCalendar() {
return notesc().CheckCalendar();
}
exports.checkCalendar = checkCalendar;
/**
* Performs the menu command Edit - Delete.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function clear() {
return notesc().Clear();
}
exports.clear = clear;
/**
* Copies one or more selected entries as a table.
* @throws {Error} no plans to implement
*/
function copySelectedAsTable() {
return notesc().CopySelectedAsTable();
}
exports.copySelectedAsTable = copySelectedAsTable;
/**
* Puts Designer into debug mode, so that all LotusScript® scripts run in the
* debugger. The command is a toggle; selecting it again takes Notes® out of debug
* mode.
* @throws {Error} no plans to implement
*/
function debugLotusScript() {
return notesc().DebugLotusScript();
}
exports.debugLotusScript = debugLotusScript;
/**
* Displays the Dialing Rules dialog box, which allows you to define dialing rules
* for a modem in a Location document in a Domino® Directory.
* @throws {Error} no plans to implement
*/
function dialingRules() {
return notesc().DialingRules();
}
exports.dialingRules = dialingRules;
/**
* Displays the Directories dialog box which allows you to search for an address,
* view detailed information about an address entry, and add an entry to your
* Domino® Directory with the Directories dialog box.
* @throws {Error} no plans to implement
*/
function directories() {
return notesc().Directories();
}
exports.directories = directories;
/**
* For two selected database replicas, marks the documents as read in one replica
* that are marked as read in the other.
* @throws {Error} no plans to implement
*/
function exchangeUnreadMarks() {
return notesc().ExchangeUnreadMarks();
}
exports.exchangeUnreadMarks = exchangeUnreadMarks;
/**
* Launches an application.
* @throws {Error} no plans to implement
*/
function execute() {
return notesc().Execute();
}
exports.execute = execute;
/**
* 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
*/
function exitNotes() {
return notesc().ExitNotes();
}
exports.exitNotes = exitNotes;
/**
* Opens the Free Time dialog box to allow searches for available meeting times.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function findFreeTimeDialog() {
return notesc().FindFreeTimeDialog();
}
exports.findFreeTimeDialog = findFreeTimeDialog;
/**
* Displays the actions pane for the current form, subform, or Page. The command is
* a toggle; selecting it again hides the actions pane.
* @throws {Error} no plans to implement
*/
function formActions() {
return notesc().FormActions();
}
exports.formActions = formActions;
/**
* Displays the view containing the current document when the user closes that
* document.
* @throws {Error} no plans to implement
*/
function goUpLevel() {
return notesc().GoUpLevel();
}
exports.goUpLevel = goUpLevel;
/**
* Displays the Insert Subform dialog box, where you can select a subform to be
* inserted on a form.
* @throws {Error} no plans to implement
*/
function insertSubform() {
return notesc().InsertSubform();
}
exports.insertSubform = insertSubform;
/**
* Pastes a bitmap into the background of a navigator. All other objects in the
* navigator overlay the background bitmap.
* @throws {Error} no plans to implement
*/
function pasteBitmapAsBackground() {
return notesc().PasteBitmapAsBackground();
}
exports.pasteBitmapAsBackground = pasteBitmapAsBackground;
/**
* Pastes a bitmap into a navigator. The bitmap becomes a hotspot which can be
* edited like any other hotspot.
* @throws {Error} no plans to implement
*/
function pasteBitmapAsObject() {
return notesc().PasteBitmapAsObject();
}
exports.pasteBitmapAsObject = pasteBitmapAsObject;
/**
* Displays the Properties box for a bitmap in a rich text field.
* @throws {Error} no plans to implement
*/
function pictureProperties() {
return notesc().PictureProperties();
}
exports.pictureProperties = pictureProperties;
/**
* From the Notes® Remote Debugger client, opens the Select Debug Target dialog box.
* @throws {Error} no plans to implement
*/
function remoteDebugLotusScript() {
return notesc().RemoteDebugLotusScript();
}
exports.remoteDebugLotusScript = remoteDebugLotusScript;
/**
* Starts a chat with one or more users.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function sendInstantMessage() {
return notesc().SendInstantMessage();
}
exports.sendInstantMessage = sendInstantMessage;
/**
* Displays the Choose Location dialog box, where you can choose your current
* workstation location, such as Office, Island, or Travel.
* @throws {Error} no plans to implement
*/
function setCurrentLocation() {
return notesc().SetCurrentLocation();
}
exports.setCurrentLocation = setCurrentLocation;
/**
* Makes the SmartIcons palette "float" so that users can move it around on the
* screen.
* @throws {Error} no plans to implement
*/
function smartIconsFloating() {
return notesc().SmartIconsFloating();
}
exports.smartIconsFloating = smartIconsFloating;
/**
* Switches to display the next set of SmartIcons in the Icon bar.
* @throws {Error} no plans to implement
*/
function smartIconsNextSet() {
return notesc().SmartIconsNextSet();
}
exports.smartIconsNextSet = smartIconsNextSet;
/**
* Cycles through the list of styles that have been defined for the current
* document, form, or page. This is the same as pressing F11. Each time you invoke
* StyleCycleKey, a different style goes into effect.
* @throws {Error} no plans to implement
*/
function styleCycleKey() {
return notesc().StyleCycleKey();
}
exports.styleCycleKey = styleCycleKey;
//# sourceMappingURL=miscellaneous.js.map