API Reference

This chapter documents the script APIs which can be used by Squish test scripts. For complete examples that make use of all the main Squish API features, see Tutorials, How to Create Test Scripts, and How to Test Applications - Specifics.

Extension APIs are documented in: QML Extension API (Qt), JavaScript Extension API (Web), and Java Extension API for Custom Widgets (Java).

Convenience Function Parameters

Functions that take an objectOrName argument can be passed a reference to an object or the symbolic or real (multi-property) name of an object. Functions that take an object argument must be passed an object reference, and functions that take an objectName must be passed an object's symbolic or real name. Object references are returned by the Object waitForObject(objectOrName), Object waitForObjectExists(name), Object findObject(objectName) and SequenceOfObjects findAllObjects(objectName) functions.

Convenience Functions