Methods

identifier(id_opt) → {string|Description}

Parameters:

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored identifier value; otherwise it returns 'this' for use with the builder pattern.

Type

string | Description

index(value_opt) → {number|Description}

The 0-based index of this object, relative to all other objects with an otherwise identical description.

Parameters:

Name	Type	Attributes	Description
value	number	<optional>	When provided, this method acts as a setter and sets the index to the specified value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored index; otherwise it returns 'this' for use with the builder pattern.

Type

number | Description

isPackaged(packaged_opt) → {boolean|Description}

Indicates whether this application is packaged (instrumented) or not.

Parameters:

Name	Type	Attributes	Description
packaged	boolean	<optional>	When provided, this method acts as a setter and sets the isPackaged value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored isPackaged value; otherwise it returns 'this' for use with the builder pattern.

Type

boolean | Description

name(name_opt) → {string|Description}

The name of the mobile application.

Parameters:

Name	Type	Attributes	Description
name	string	<optional>	When provided, this method acts as a setter and sets the name value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.

Type

string | Description

upload(upload_opt) → {number|Description}

The application upload number. The upload number can be used to identify the application uniquely when the application is uploaded more than once.

Parameters:

Name	Type	Attributes	Description
upload	number	<optional>	When provided, this method acts as a setter and sets the application upload number.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored application upload number; otherwise it returns 'this' for use with the builder pattern.

Type

number | Description

version(version_opt) → {string|Description}

The application version.

Parameters:

Name	Type	Attributes	Description
version	string	<optional>	When provided, this method acts as a setter and sets the version value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored version value; otherwise it returns 'this' for use with the builder pattern.

Type

string | Description

vri(value_opt)

Sets a VisualRelation definition.
The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.

Parameters:

Name	Type	Attributes	Description
value	Array.<Object>	<optional>	Array that contains multiple VRI definitions for this test object. Properties Name Type Attributes Default Description anchor Object The related test object. horizontal Horizontal <optional> The horizontal relation definition. hInline boolean <optional> false The horizontal inline definition. vertical Vertical <optional> The vertical relation definition. vInline string <optional> false The vertical inline definition. proximity Proximity <optional> The proximity relation definition.