agent.js

"use strict";
/***************************************************
* Licensed Materials - Property of HCL.
* (c)Copyright HCL America, Inc. 2023-2024
****************************************************/
Object.defineProperty(exports, "__esModule", { value: true });
exports.agentTestRun = exports.agentSetServerName = exports.agentLog = exports.agentEdit = exports.runScheduledAgents = exports.runAgent = exports.isAgentEnabled = exports.agentEnableDisable = exports.agentRun = exports._notes = void 0;
const tslib_1 = require("tslib");
/**
 * @file Agents (Domino)
 * @module agent
 * @category Agents
 */
const notesc = tslib_1.__importStar(require("../notes/agent"));
exports._notes = notesc;
/**
 * Runs the currently selected agent and then displays its log.
 * @param {Array} ...args any arguments
 * @throws {Error} method not implemented
 * @TODO this needs to be implemented
 */
function agentRun() {
    return notesc.AgentRun();
}
exports.agentRun = agentRun;
/**
 * Enables or disables the specified agent.
 * @param {Array} ...args any arguments
 * @throws {Error} method not implemented
 * @TODO this needs to be implemented
 */
function agentEnableDisable() {
    return notesc.AgentEnableDisable();
}
exports.agentEnableDisable = agentEnableDisable;
/**
 * Indicates whether or not a scheduled agent is enabled.
 * @throws {Error} method not implemented
 * @TODO this needs to be implemented
 */
function isAgentEnabled() {
    return notesc.IsAgentEnabled();
}
exports.isAgentEnabled = isAgentEnabled;
/**
 * Executes a specified agent.
 * @throws {Error} method not implemented
 * @TODO this needs to be implemented
 */
function runAgent() {
    return notesc.RunAgent();
}
exports.runAgent = runAgent;
/**
 * 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 runScheduledAgents() {
    return notesc.RunScheduledAgents();
}
exports.runScheduledAgents = runScheduledAgents;
/**
 * Opens the Agent Properties box for the currently selected agent.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function agentEdit() {
    return notesc.AgentEdit();
}
exports.agentEdit = agentEdit;
/**
 * Displays the log for the currently selected agent. The log contains information
 * about when the agent last ran, what actions it performed, and when it finished
 * running.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function agentLog() {
    return notesc.AgentLog();
}
exports.agentLog = agentLog;
/**
 * Specifies a scheduled agent to run on a particular server.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function agentSetServerName() {
    return notesc.AgentSetServerName();
}
exports.agentSetServerName = agentSetServerName;
/**
 * Displays a log for the currently selected agent, describing what actions the
 * agent will perform when run.
 * @param {Array} ...args any arguments
 * @throws {Error} No plans to implement
 */
function agentTestRun() {
    return notesc.AgentTestRun();
}
exports.agentTestRun = agentTestRun;
//# sourceMappingURL=agent.js.map