new Application(propsopt) → {Application}
The description of a mobile application test object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
Object |
<optional> |
Initializes the description using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- Application
Methods
identifier(idopt) → {string|Description}
The application identifier string.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string |
<optional> |
When provided, this method acts as a setter and sets the identifier value. |
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(valueopt) → {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(packagedopt) → {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(nameopt) → {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
objectProperties(objectPropertiesopt) → {Dictionary|Description}
The concrete test object properties including custom properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
objectProperties |
Dictionary |
<optional> |
When provided, this method acts as a setter and sets the objectProperties value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectProperties value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- Dictionary | Description
upload(uploadopt) → {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(versionopt) → {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(valueopt)
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.
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
|