appium-mac2-driver/build/lib/commands/applescript.d.ts

XCTest-based Appium driver for macOS apps automation

/**
 * Executes the given AppleScript command or a whole script based on the
 * given options. Either of these options must be provided. If both are provided
 * then the `command` one gets the priority.
 * Note that AppleScript command cannot contain line breaks. Consider making it
 * to a script in such case.
 * Note that by default AppleScript engine blocks commands/scripts execution if your script
 * is trying to access some private entities, like cameras or the desktop screen
 * and no permissions to do it are given to the parent (for example, Appium or Terminal)
 * process in System Preferences -> Privacy list.
 *
 * @this {Mac2Driver}
 * @param {string} [script] A valid AppleScript to execute
 * @param {string} [language] Overrides the scripting language. Basically, sets
 *                 the value of `-l` command line argument of `osascript` tool.
 *                 If unset the AppleScript language is assumed.
 * @param {string} [command] A valid AppleScript as a single command (no line breaks) to execute
 * @param {string} [cwd] The path to an existing folder, which is going to be set as
 *                       the working directory for the command/script being executed.
 * @param {number} [timeout] The number of seconds to wait until a long-running command is finished.
 *                           An error is thrown if the command is still running after this timeout expires.
 * @returns {Promise<string>} The actual stdout of the given command/script
 * @throws {Error} If the exit code of the given command/script is not zero.
 * The actual stderr output is set to the error message value.
 */
export function macosExecAppleScript(this: import("../driver").Mac2Driver, script?: string, language?: string, command?: string, cwd?: string, timeout?: number): Promise<string>;
export type Mac2Driver = import("../driver").Mac2Driver;
//# sourceMappingURL=applescript.d.ts.map