rosettajs_dist_lib_rosetta_miscellaneous.js
"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports._notes = void 0;
exports.checkAlarms = checkAlarms;
exports.enableAlarms = enableAlarms;
exports.environment = environment;
exports.hashPassword = hashPassword;
exports.hotspotClear = hotspotClear;
exports.hotspotProperties = hotspotProperties;
exports.launchApp = launchApp;
exports.passwordQuality = passwordQuality;
exports.postedCommand = postedCommand;
exports.setEnvironment = setEnvironment;
exports.setViewInfo = setViewInfo;
exports.validateInternetAddress = validateInternetAddress;
exports.verifyPassword = verifyPassword;
exports.viewShowThisUnread = viewShowThisUnread;
exports.addBookmark = addBookmark;
exports.addToIMContactList = addToIMContactList;
exports.calendarFormat = calendarFormat;
exports.calendarGoTo = calendarGoTo;
exports.checkCalendar = checkCalendar;
exports.clear = clear;
exports.copySelectedAsTable = copySelectedAsTable;
exports.debugLotusScript = debugLotusScript;
exports.dialingRules = dialingRules;
exports.directories = directories;
exports.exchangeUnreadMarks = exchangeUnreadMarks;
exports.execute = execute;
exports.exitNotes = exitNotes;
exports.findFreeTimeDialog = findFreeTimeDialog;
exports.formActions = formActions;
exports.goUpLevel = goUpLevel;
exports.insertSubform = insertSubform;
exports.pasteBitmapAsBackground = pasteBitmapAsBackground;
exports.pasteBitmapAsObject = pasteBitmapAsObject;
exports.pictureProperties = pictureProperties;
exports.remoteDebugLotusScript = remoteDebugLotusScript;
exports.sendInstantMessage = sendInstantMessage;
exports.setCurrentLocation = setCurrentLocation;
exports.smartIconsFloating = smartIconsFloating;
exports.smartIconsNextSet = smartIconsNextSet;
exports.styleCycleKey = styleCycleKey;
const tslib_1 = require("tslib");
/**
* @file Miscellaneous
* @module miscellaneous
* @category Miscellaneous
*/
const notesf = tslib_1.__importStar(require("../notes/miscellaneous"));
const notesc = notesf; // notes commands are exposed in the notes functions source file; this notesc is just for visual cue
exports._notes = notesf;
//-----------------------------
// 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();
}
/**
* Starts or stops the alarm daemon.
* @throws {Error} no plans to implement
*/
function enableAlarms() {
return notesf.EnableAlarms();
}
/**
* Sets or returns an environment variable stored in a formula.
* @param {string} key The name of the environment variable you want to retrieve or set.
* @param {string} [value] Optional value to set for the key. If not specified, the value of the key will be returned.
* @returns {string|null} If value not specified, the value of the environment variable. If value was specified,
* the encrypted value of the environment variable that was set.
*/
function environment(key, value) {
return notesf.Environment(key, value);
}
/**
* Encodes a string.
* @param {string} text. The string that you want to encode.
* @returns {string} encodedString.
*/
function hashPassword(text) {
return notesf.HashPassword(text);
}
/**
* Removes a hotspot, without deleting the underlying text or graphic.
* @throws {Error} no plans to implement
*/
function hotspotClear() {
return notesf.HotspotClear();
}
/**
* Displays the Properties box for the current hotspot.
* @throws {Error} no plans to implement
*/
function hotspotProperties() {
return notesf.HotspotProperties();
}
/**
* Launches the requested Domino® application.
* @throws {Error} no plans to implement
*/
function launchApp() {
return notesf.LaunchApp();
}
/**
* Evaluates the return value of a Password data type field with a number.
* @throws {Error} no plans to implement
*/
function passwordQuality() {
return notesf.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();
}
/**
* 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);
}
/**
* 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();
}
/**
* 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();
}
/**
* Compares two passwords.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function verifyPassword() {
return notesf.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();
}
//-----------------------------
// Notes @Commands misc
/**
* Adds a bookmark with the specified URL or current object.
* @throws {Error} no plans to implement
*/
function addBookmark() {
return notesc.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();
}
/**
* 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();
}
/**
* Goes to a particular date in a Calendar view.
* @throws {Error} no plans to implement
*/
function calendarGoTo() {
return notesc.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();
}
/**
* Performs the menu command Edit - Delete.
* @throws {Error} no plans to implement
* @TODO this needs to be implemented
*/
function clear() {
return notesc.Clear();
}
/**
* Copies one or more selected entries as a table.
* @throws {Error} no plans to implement
*/
function copySelectedAsTable() {
return notesc.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();
}
/**
* 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();
}
/**
* 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();
}
/**
* 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();
}
/**
* Launches an application.
* @throws {Error} no plans to implement
*/
function execute() {
return notesc.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();
}
/**
* 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();
}
/**
* 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();
}
/**
* Displays the view containing the current document when the user closes that
* document.
* @throws {Error} no plans to implement
*/
function goUpLevel() {
return notesc.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();
}
/**
* 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();
}
/**
* 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();
}
/**
* Displays the Properties box for a bitmap in a rich text field.
* @throws {Error} no plans to implement
*/
function pictureProperties() {
return notesc.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();
}
/**
* Starts a chat with one or more users.
* @throws {Error} method not implemented
* @TODO this needs to be implemented
*/
function sendInstantMessage() {
return notesc.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();
}
/**
* 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();
}
/**
* Switches to display the next set of SmartIcons in the Icon bar.
* @throws {Error} no plans to implement
*/
function smartIconsNextSet() {
return notesc.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();
}
//# sourceMappingURL=miscellaneous.js.map