url address of a web page, e.g., google.com

Whether or not to wait for a page to complete loading after typing.

Whether or not to wait for the app or URL to complete loading. Default is true.

Duration in seconds to wait after typing.

Duration in seconds to wait after opening the app or URL, in addition to the wait for load.

Type using the keyboard.

func `Type`(

func Type(

text: String,

withReturn: Bool = false,

waitTime: Int = 0,

Click on something, either specified by the `at` argument or the `element` argument.

func Click(

at: String = "",

_at: String = "",

element: UIElement? = nil,

clickType: String = "left",

withCommand: Bool = false,

Click(at: "Styles.zip", clickType: "doubleClick")

- Instruction: click slider closest to pointer size

- Instruction: click "slider" closest to and on the right of "pointer size"

Click(at: "slider", spatialRelation: "closest", anchorConcept: "pointer size")

Click(at: "slider", spatialRelation: "closest,right", anchorConcept: "pointer size")

Moves the cursor to an object. Disambiguate by specifing the spatial relation between the target element and an anchor concept.

func Move(

to: String = "",

_to: String = "",

element: UIElement? = nil,

spatialRelation: String = "",

anchorConcept: String = "",

If `elementOverallDescription` is given, then accept candidate elements whose normalized string

distance to `elementOverallDescription` is below this threshold value.

similarity to `elementOverallDescription` is above this threshold value.

If given, then the search is limited to elements contained within this root element.

Searches for an element that matches the input criteria and gets the element's value for a specified attribute.

func GetAttributeOfElement(

elementRole: String = "",

elementOverallDescription: String = "",

attribute: String = "",

threshold: Double = 0.75,

root: UIElement? = nil,

spatialRelation: String = "",

anchorRole: String = "",

anchorOverallDescription: String = "",

anchorElements: [UIElement] = [],

horizontalRank: Int? = nil,

verticalRank: Int? = nil

) -> String

Role of the target element. Required if elementOverallDescription is not given.

Description of the element. Required if elementRoles are not provided.

Valid options are: "role", "description", "title", "value". For example, use "value" to get the value of text elements.

If `elementOverallDescription` is given, then accept candidate elements whose normalized string similarity with `elementOverallDescription` is above this threshold value.

If given, then the search is limited to elements contained within this root element.

A comma-separated String of spatial relationships between the target elements and the anchor.

Role of element(s) used as anchor for spatial relation.

Description of an object used as an anchor with spatialRelation.

Elements to use as anchor for spatial relation constraints. If `anchorElements` is provided, then anchorRole and anchorOverallDescription are ignored.

If given, sorts the elements by x-coordinate of frame midpoint and returns the element with this rank. Left-most element has rank 1.

If given, sorts the elements by y-coordinate of frame midpoint and returns the element with this rank. Top-most element has rank 1.

String value of an attribute of an element

Examples:

- Instruction: Get the value of the radioButton element with description "radioButton tab point & click"

var value = GetAttributeOfElement(elementRole: "radioButton", elementOverallDescription: "radioButton tab point & click", attribute: "value")

- Instruction: Get the value of the valueIndicator element closest to and on the right of "statictext text double-click speed"

var value = GetAttributeOfElement(elementRole: "valueIndicator", attribute: "value", spatialRelation: "closest,right", anchorOverallDescription: "statictext text double-click speed")

Respond to the user with a message and optionally ask for user confirmation to proceed.

func Respond(message: String, requireConfirm: Bool = false)

func Respond(_message: String, requireConfirm: Bool = false)

Checks if all the concepts can be found on the current visible screen.

func ConceptsExist(concepts: [String]) -> Bool

func ConceptsExist(_concepts: [String]) -> Bool

Print("Simular")

///

Gets a JSON representation of a dictionary.

func GetJSONFromDict(dict: [String: Any]) -> String

A [String: Any] dictionary.

A JSON representation of the input dictionary.

Examples:

- Instruction: convert dict to json.

var json = GetJSONFromDict(dict)

Put Agent into sleep state for a certain amount of time.

func Wait(unit: String, waitTime: Int)

func Wait(_waitTime: Int, unit: String="s")

Units of waitTime, default is s for seconds. Options are s and ms.

Options are "s" for seconds (default) and "ms" for milliseconds.

- Instruction: Wait for 3s

Wait(waitTime: 3, unit: "s")

Wait(3)

- Instruction: Wait for 0.5s

- Instruction: Wait for 500ms

Wait(waitTime: 500, unit: "ms")

- Instruction: Wait for 6 seconds

Wait(waitTime: 6)

Read the contents of a file whose location is specified by `path`.

func ReadFile(path: String) -> String

Either an absolute path to a file, or a name of a file (assumed to be in the default app cache directory).

Contents of the file as a String

Examples:

- Instruction: read the file named results.json

var results = ReadFile(path: "results.json")

- Instruction: get contents of file /Users/somebody/Documents/project/links.txt

var links = ReadFile(path: "/Users/somebody/Documents/project/links.txt")

Writes the given text to a file. If the file already exists, then appends text to it, with an option to overwrite the existing content.

Unless specified path, writes to desktop /Library/Caches/com.simular.SimularNote/SimularActionResult/

Will throw an error if there is non-folder file named SimularActionResult also existing at desktop

func WriteToFile(

text: String,

filePath: String? = nil,

path: String? = "SimularActionResult.txt",

overwrite: Bool = false

)

Text to write to a file.

Full path to a file. If not provided, then the default is a file "SimularActionResult.txt" at the desktop.

path of the file, default at /Library/Caches/com.simular.SimularNote/SimularActionResult/{path}.txt. If path contains "/", treat it as full path

Whether or not to overwrite the contents if filePath points to an existing file.

- Instruction: Append jsonResult to /User/somebody/Documents/result.json

WriteToFile(text: jsonResult, filePath: "/User/somebody/Documents/result.json")

WriteToFile(text: jsonResult, path: "/User/somebody/Documents/result.json")

- Instruction: Write jsonResult to /User/someone/Desktop/result.json, overwrite existing file.

WriteToFile(text: jsonResult, filePath: "/User/someone/Desktop/result.json", overwrite: true)

WriteToFile(text: jsonResult, path: "/User/someone/Desktop/result.json", overwrite: true)

- Instruction: Write jsonResult to default action result file, overwrite existing file.

WriteToFile(text: jsonResult, overwrite: true)