## Constants

<dl>
<dt><a href="#common">common</a></dt>
<dd><p>Global namespace for common modules.</p>
</dd>
<dt><a href="#util">util</a></dt>
<dd><p>Global namespace for util modules.</p>
</dd>
<dt><a href="#ui5">ui5</a></dt>
<dd><p>Global namespace for UI5 modules.</p>
</dd>
<dt><a href="#nonUi5">nonUi5</a></dt>
<dd><p>Global namespace for non UI5 modules.</p>
</dd>
<dt><a href="#service">service</a></dt>
<dd><p>Global namespace for service modules.</p>
</dd>
<dt><a href="#mobile">mobile</a></dt>
<dd><p>Global namespace for mobile modules.</p>
</dd>
<dt><a href="#flp">flp</a></dt>
<dd><p>Global namespace for Fiori Launchpad (FLP) modules.</p>
</dd>
</dl>

<a name="common"></a>

## common
Global namespace for common modules.

**Kind**: global constant  

* [common](#common)
    * [.assertion](#common.assertion)
        * [.expectEqual(value1, value2)](#common.assertion.expectEqual)
        * [.expectUnequal(value1, value2)](#common.assertion.expectUnequal)
        * [.expectTrue(value)](#common.assertion.expectTrue)
        * [.expectFalse(value)](#common.assertion.expectFalse)
        * [.expectDefined(value)](#common.assertion.expectDefined)
        * [.expectUndefined(value)](#common.assertion.expectUndefined)
        * [.expectUrlToBe()](#common.assertion.expectUrlToBe)
        * [.expectToContain(value1, value2)](#common.assertion.expectToContain)
    * [.date](#common.date)
        * [.getToday([format])](#common.date.getToday) ⇒ <code>String</code>
        * [.getTomorrow([format])](#common.date.getTomorrow) ⇒ <code>String</code>
        * [.getNextMonth([format])](#common.date.getNextMonth) ⇒ <code>String</code>
        * [.getPreviousMonth([format])](#common.date.getPreviousMonth) ⇒ <code>String</code>
        * [.getNextYear([format])](#common.date.getNextYear) ⇒ <code>String</code>
        * [.getPreviousYear([format])](#common.date.getPreviousYear) ⇒ <code>String</code>
        * [.getSpecific(date, [format])](#common.date.getSpecific) ⇒ <code>String</code>
        * [.calculate([date], [format])](#common.date.calculate) ⇒ <code>String</code> \| <code>Date</code>
        * [.getCurrentDateAndTime([format])](#common.date.getCurrentDateAndTime) ⇒ <code>String</code> \| <code>Date</code>
        * [.calculateWithTime([date], [time], [format])](#common.date.calculateWithTime) ⇒ <code>String</code> \| <code>Date</code>
    * [.navigation](#common.navigation)
        * [.navigateToUrl(url)](#common.navigation.navigateToUrl)
        * [.navigateToUrlAndRetry(url, [retries], [interval])](#common.navigation.navigateToUrlAndRetry)
    * [.userInteraction](#common.userInteraction)
        * [.fillActive(value)](#common.userInteraction.fillActive)
        * [.fillActiveAndRetry(value, [retries], [interval])](#common.userInteraction.fillActiveAndRetry)
        * [.clearAndFillActive(value)](#common.userInteraction.clearAndFillActive)
        * [.clearAndFillActiveAndRetry(value, [retries], [interval])](#common.userInteraction.clearAndFillActiveAndRetry)
        * [.pressKey(keys)](#common.userInteraction.pressKey)
        * [.pressEnter()](#common.userInteraction.pressEnter)
        * [.pressTab()](#common.userInteraction.pressTab)
        * [.pressF4()](#common.userInteraction.pressF4)
        * [.pressBackspace()](#common.userInteraction.pressBackspace)
        * [.pressEscape()](#common.userInteraction.pressEscape)
        * [.pressArrowLeft()](#common.userInteraction.pressArrowLeft)
        * [.pressArrowRight()](#common.userInteraction.pressArrowRight)

<a name="common.assertion"></a>

### common.assertion
**Kind**: static class of [<code>common</code>](#common)  

* [.assertion](#common.assertion)
    * [.expectEqual(value1, value2)](#common.assertion.expectEqual)
    * [.expectUnequal(value1, value2)](#common.assertion.expectUnequal)
    * [.expectTrue(value)](#common.assertion.expectTrue)
    * [.expectFalse(value)](#common.assertion.expectFalse)
    * [.expectDefined(value)](#common.assertion.expectDefined)
    * [.expectUndefined(value)](#common.assertion.expectUndefined)
    * [.expectUrlToBe()](#common.assertion.expectUrlToBe)
    * [.expectToContain(value1, value2)](#common.assertion.expectToContain)

<a name="common.assertion.expectEqual"></a>

#### assertion.expectEqual(value1, value2)
Expects the passed values to be equal.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value1 | <code>Any</code> | Value (1) to be equal to value (2) |
| value2 | <code>Any</code> | Value (2) to be equal to value (1) |

**Example**  
```js
common.assertion.expectEqual(value1, value2);
```
<a name="common.assertion.expectUnequal"></a>

#### assertion.expectUnequal(value1, value2)
Expects the passed values to be unequal.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value1 | <code>Any</code> | Value (1) to be unequal to value (2) |
| value2 | <code>Any</code> | Value (2) to be unequal to value (1) |

**Example**  
```js
common.assertion.expectUnequal(value1, value2);
```
<a name="common.assertion.expectTrue"></a>

#### assertion.expectTrue(value)
Expects the passed value to be true.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>Any</code> | Value to be equal to true |

**Example**  
```js
common.assertion.expectTrue(value);
```
<a name="common.assertion.expectFalse"></a>

#### assertion.expectFalse(value)
Expects the passed value to be false.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>Boolean</code> | The value to be false. |

**Example**  
```js
common.assertion.expectFalse(false);
```
<a name="common.assertion.expectDefined"></a>

#### assertion.expectDefined(value)
Expects the passed values is defined.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>Any</code> | Value to be defined (not undefined) |

**Example**  
```js
common.assertion.expectDefined(value);
```
<a name="common.assertion.expectUndefined"></a>

#### assertion.expectUndefined(value)
Expects the passed values is undefined.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>Any</code> | Value to be undefined |

**Example**  
```js
common.assertion.expectUndefined(value);
```
<a name="common.assertion.expectUrlToBe"></a>

#### assertion.expectUrlToBe()
Expects the url to be the passed value.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  
**Example**  
```js
await common.assertion.expectUrlToBe("www.sap.com");
```
<a name="common.assertion.expectToContain"></a>

#### assertion.expectToContain(value1, value2)
Expects the first passed value to contain the second passed value, after normalizing whitespace.

**Kind**: static method of [<code>assertion</code>](#common.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| value1 | <code>string</code> | The string expected to contain value2. |
| value2 | <code>string</code> | The string expected to be found within value1. |

**Example**  
```js
await common.assertion.expectToContain("foo bar baz", "bar");
```
<a name="common.date"></a>

### common.date
**Kind**: static class of [<code>common</code>](#common)  

* [.date](#common.date)
    * [.getToday([format])](#common.date.getToday) ⇒ <code>String</code>
    * [.getTomorrow([format])](#common.date.getTomorrow) ⇒ <code>String</code>
    * [.getNextMonth([format])](#common.date.getNextMonth) ⇒ <code>String</code>
    * [.getPreviousMonth([format])](#common.date.getPreviousMonth) ⇒ <code>String</code>
    * [.getNextYear([format])](#common.date.getNextYear) ⇒ <code>String</code>
    * [.getPreviousYear([format])](#common.date.getPreviousYear) ⇒ <code>String</code>
    * [.getSpecific(date, [format])](#common.date.getSpecific) ⇒ <code>String</code>
    * [.calculate([date], [format])](#common.date.calculate) ⇒ <code>String</code> \| <code>Date</code>
    * [.getCurrentDateAndTime([format])](#common.date.getCurrentDateAndTime) ⇒ <code>String</code> \| <code>Date</code>
    * [.calculateWithTime([date], [time], [format])](#common.date.calculateWithTime) ⇒ <code>String</code> \| <code>Date</code>

<a name="common.date.getToday"></a>

#### date.getToday([format]) ⇒ <code>String</code>
Returns the current day in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getToday("mm/dd/yyyy");
```
<a name="common.date.getTomorrow"></a>

#### date.getTomorrow([format]) ⇒ <code>String</code>
Returns tomorrows date in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getTomorrow("mm/dd/yyyy");
```
<a name="common.date.getNextMonth"></a>

#### date.getNextMonth([format]) ⇒ <code>String</code>
Returns the current day one month later in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getNextMonth("mm/dd/yyyy");
```
<a name="common.date.getPreviousMonth"></a>

#### date.getPreviousMonth([format]) ⇒ <code>String</code>
Returns the current day one month before in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getPreviousMonth("mm/dd/yyyy");
```
<a name="common.date.getNextYear"></a>

#### date.getNextYear([format]) ⇒ <code>String</code>
Returns the current day one year later in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getNextYear("mm/dd/yyyy");
```
<a name="common.date.getPreviousYear"></a>

#### date.getPreviousYear([format]) ⇒ <code>String</code>
Returns the current day one year before in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getPreviousYear("mm/dd/yyyy");
```
<a name="common.date.getSpecific"></a>

#### date.getSpecific(date, [format]) ⇒ <code>String</code>
Returns a specific date in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> - The date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| date | <code>String</code> |  | A specific date string. |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.getSpecific("2020, 0, 17", "mm/dd/yyyy");
```
<a name="common.date.calculate"></a>

#### date.calculate([date], [format]) ⇒ <code>String</code> \| <code>Date</code>
Calculates the date based on the input parameter and returns it in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> \| <code>Date</code> - The calculated date in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [date] | <code>String</code> | <code>&quot;today&quot;</code> | Supported values: "today", "tomorrow", "nextMonth", "previousMonth", "nextYear", "previousYear" If the date is not provided, "today" will be used. |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |

**Example**  
```js
const date = await common.date.calculate("today", "mm/dd/yyyy");
```
<a name="common.date.getCurrentDateAndTime"></a>

#### date.getCurrentDateAndTime([format]) ⇒ <code>String</code> \| <code>Date</code>
Returns the current date and time in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> \| <code>Date</code> - The calculated date and time in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected format as a string, which consists of date and time formats, separated by a whitespace or another delimiter. Supported formats are the same as for the [calculateWithTime](#common.date.calculateWithTime) method.<br> |

**Example**  
```js
const date = common.date.getCurrentDateAndTime("mm/dd/yyyy HH:mm:ss");
// returns a string like "06/17/2025 08:17:27"
```
**Example**  
```js
const date = common.date.getCurrentDateAndTime();
// returns a Date object like "Tue Jun 17 2025 08:17:27 GMT+0200 (Central European Summer Time)"
```
<a name="common.date.calculateWithTime"></a>

#### date.calculateWithTime([date], [time], [format]) ⇒ <code>String</code> \| <code>Date</code>
Calculates the date and time based on the input parameter and returns it in the given format.

**Kind**: static method of [<code>date</code>](#common.date)  
**Returns**: <code>String</code> \| <code>Date</code> - The calculated date and time in the given format.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [date] | <code>String</code> | <code>&quot;today&quot;</code> | Supported values: "today", "tomorrow", "nextMonth", "previousMonth", "nextYear", "previousYear". |
| [time] | <code>String</code> |  | The time of day. Supported formats: "HH:MM:SS" (e.g. "10:30:20"), "HH:MM" (e.g. "10:30"), "HH" (e.g. "10"). It can also be in 12-hour format with AM/PM (e.g. "10:30 PM", "3 AM"). It can also be a time anchor, such as "currentTime", "startOfDay", or "endOfDay".<br> If not provided, the time will default to the "startOfDay". |
| [format] | <code>String</code> | <code>&quot;object&quot;</code> | The expected output format as a string, which consists of <b>date and time formats, separated by a whitespace or another delimiter</b> (such as 'T' substring).<br> - Supported <b>date</b> formats are the same as for the [calculate](#common.date.calculate) method.<br> - Supported <b>time</b> formats are the following: "HH\:mm:ss" (24-hour format), "h\:mm:ss a" (12-hour format), "HH\:mm:ss z" (24-hour format with timezone), "h\:mm:ss a z" (12-hour format with timezone), "HH\:mm" (24-hour format), "h\:mm a" (12-hour format), "HH" (24-hour format), "h a" (12-hour format).<br> - Examples of <b>expected format</b>: "datetime", "object", "mm/dd/yyyy HH\:mm:ss", "dd.mm.yyyy h\:mm:ss a", "dd/mm/yyyy HH\:mm:ss z", "yyyymmddTh\:mm:ss a z", "yyyy/mm/dd HH\:mm", "mmm dd, yyyy h\:mm a", "mmm d, yyyy HH", "mmm d, yyyy h a", and other combinations of supported date and time formats.<br> |

**Example**  
```js
const date = common.date.calculateWithTime("today", "10:00");
// returns a Date object like "Tue Jun 17 2025 08:17:27 GMT+0200 (Central European Summer Time)"
```
**Example**  
```js
const date = common.date.calculateWithTime("today", "10:00:00", "mm/dd/yyyy HH:mm:ss");
// returns a string like "06/17/2025 10:00:00"
```
**Example**  
```js
const date = common.date.calculateWithTime("nextMonth", "9:00 PM", "mm-dd-yyyy h:mm a");
// returns a string like "07-17-2025 9:00 PM"
```
**Example**  
```js
const date = common.date.calculateWithTime("previousMonth", "22:00:45", "dd.mm.yyyy HH:mm:ss");
// returns a string like "17.05.2025 22:00:45"
```
**Example**  
```js
const date = common.date.calculateWithTime("nextYear", "3 AM", "dd/mm/yyyy h a");
// returns a string like "17/06/2026 3 AM"
```
**Example**  
```js
const date = common.date.calculateWithTime("previousYear", "15:30", "yyyymmddTHH:mm");
// returns a string like "20240617T15:30"
```
**Example**  
```js
const date = common.date.calculateWithTime("tomorrow", "10:00:50", "mmm dd, yyyy HH:mm:ss z");
// returns a string like "Jun 18, 2025 10:00:50 GMT+02:00"
```
**Example**  
```js
const date = common.date.calculateWithTime("today", "startOfDay", "dd.mm.yyyy HH:mm:ss");
// returns a string like "17.06.2025 00:00:00"
```
<a name="common.navigation"></a>

### common.navigation
**Kind**: static class of [<code>common</code>](#common)  

* [.navigation](#common.navigation)
    * [.navigateToUrl(url)](#common.navigation.navigateToUrl)
    * [.navigateToUrlAndRetry(url, [retries], [interval])](#common.navigation.navigateToUrlAndRetry)

<a name="common.navigation.navigateToUrl"></a>

#### navigation.navigateToUrl(url)
Navigates to the passed url.

**Kind**: static method of [<code>navigation</code>](#common.navigation)  

| Param | Type | Description |
| --- | --- | --- |
| url | <code>String</code> | The url. |

**Example**  
```js
await common.navigation.navigateToUrl("www.sap.com");
```
<a name="common.navigation.navigateToUrlAndRetry"></a>

#### navigation.navigateToUrlAndRetry(url, [retries], [interval])
Navigates to the passed url and retries the function in case of a failure.

**Kind**: static method of [<code>navigation</code>](#common.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| url | <code>String</code> |  | The url to navigate to. |
| [retries] | <code>Integer</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Integer</code> | <code>5000</code> | The interval of the retries (ms), can be set in config for all functions under params stepRetriesIntervals. |

**Example**  
```js
await common.navigation.navigateToUrlAndRetry("www.sap.com");
```
<a name="common.userInteraction"></a>

### common.userInteraction
**Kind**: static class of [<code>common</code>](#common)  

* [.userInteraction](#common.userInteraction)
    * [.fillActive(value)](#common.userInteraction.fillActive)
    * [.fillActiveAndRetry(value, [retries], [interval])](#common.userInteraction.fillActiveAndRetry)
    * [.clearAndFillActive(value)](#common.userInteraction.clearAndFillActive)
    * [.clearAndFillActiveAndRetry(value, [retries], [interval])](#common.userInteraction.clearAndFillActiveAndRetry)
    * [.pressKey(keys)](#common.userInteraction.pressKey)
    * [.pressEnter()](#common.userInteraction.pressEnter)
    * [.pressTab()](#common.userInteraction.pressTab)
    * [.pressF4()](#common.userInteraction.pressF4)
    * [.pressBackspace()](#common.userInteraction.pressBackspace)
    * [.pressEscape()](#common.userInteraction.pressEscape)
    * [.pressArrowLeft()](#common.userInteraction.pressArrowLeft)
    * [.pressArrowRight()](#common.userInteraction.pressArrowRight)

<a name="common.userInteraction.fillActive"></a>

#### userInteraction.fillActive(value)
Fills the active input with the given value.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>String</code> \| <code>Number</code> | The value to enter. |

**Example**  
```js
await common.userInteraction.fillActive("My Value");
```
<a name="common.userInteraction.fillActiveAndRetry"></a>

#### userInteraction.fillActiveAndRetry(value, [retries], [interval])
Enters the given value to the active input field and retries the action in case it fails.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| value | <code>String</code> |  | The value to enter. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await common.userInteraction.fillActiveAndRetry("My Value");
```
<a name="common.userInteraction.clearAndFillActive"></a>

#### userInteraction.clearAndFillActive(value)
Clears and fills the active input.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>String</code> | The value to fill. |

**Example**  
```js
await common.userInteraction.clearAndFillActive("My Value");
```
<a name="common.userInteraction.clearAndFillActiveAndRetry"></a>

#### userInteraction.clearAndFillActiveAndRetry(value, [retries], [interval])
CClears and fills the active input. Retries the action in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| value | <code>String</code> |  | The value to fill. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await common.userInteraction.clearAndFillActiveAndRetry("My Value");
```
<a name="common.userInteraction.pressKey"></a>

#### userInteraction.pressKey(keys)
Performs the specified keypress. Possible values: <a href="https://w3c.github.io/webdriver/#keyboard-actions" target="_blank">WebDriver Keyboard Actions</a>

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| keys | <code>String</code> \| <code>Array.&lt;String&gt;</code> | The key or combination of keys to execute. |

**Example**  
```js
await common.userInteraction.pressKey("Enter");
```
**Example**  
```js
await common.userInteraction.pressKey("\uE004");
```
**Example**  
```js
await common.userInteraction.pressKey(["\uE009", "Alt"]);
```
<a name="common.userInteraction.pressEnter"></a>

#### userInteraction.pressEnter()
Performs the Enter keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressEnter();
```
<a name="common.userInteraction.pressTab"></a>

#### userInteraction.pressTab()
Performs the Tab keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressTab();
```
<a name="common.userInteraction.pressF4"></a>

#### userInteraction.pressF4()
Performs the F4 keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressF4();
```
<a name="common.userInteraction.pressBackspace"></a>

#### userInteraction.pressBackspace()
Performs the Backspace keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressBackspace();
```
<a name="common.userInteraction.pressEscape"></a>

#### userInteraction.pressEscape()
Performs the Escape keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressEscape();
```
<a name="common.userInteraction.pressArrowLeft"></a>

#### userInteraction.pressArrowLeft()
Performs the Arrow Left keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressArrowLeft();
```
<a name="common.userInteraction.pressArrowRight"></a>

#### userInteraction.pressArrowRight()
Performs the Arrow Right keypress.

**Kind**: static method of [<code>userInteraction</code>](#common.userInteraction)  
**Example**  
```js
await common.userInteraction.pressArrowRight();
```
<a name="util"></a>

## util
Global namespace for util modules.

**Kind**: global constant  

* [util](#util)
    * [.browser](#util.browser)
        * [.getBaseUrl()](#util.browser.getBaseUrl) ⇒ <code>String</code>
        * [.setBaseUrl(baseUrl:)](#util.browser.setBaseUrl)
        * [.logCurrentUrl()](#util.browser.logCurrentUrl)
        * [.getCurrentUrl()](#util.browser.getCurrentUrl)
        * [.resetFocus()](#util.browser.resetFocus)
        * [.sleep([duration])](#util.browser.sleep)
        * [.collectCoverage()](#util.browser.collectCoverage)
        * [.sleepAndCollectCoverage([duration])](#util.browser.sleepAndCollectCoverage)
        * [.refresh()](#util.browser.refresh)
        * [.clearBrowser([clearLocal], [clearSession], [clearCookies])](#util.browser.clearBrowser)
        * [.getBrowserName()](#util.browser.getBrowserName) ⇒ <code>String</code>
        * [.getUI5Version([timeout])](#util.browser.getUI5Version)
        * [.logUI5Version()](#util.browser.logUI5Version)
        * [.executeScript(command)](#util.browser.executeScript) ⇒ <code>Any</code>
        * [.waitUntil(condition, [options])](#util.browser.waitUntil) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.switchToNewWindow(titleOrUrl, [timeout])](#util.browser.switchToNewWindow)
        * [.switchToWindow(handle)](#util.browser.switchToWindow)
        * [.getCurrentWindow()](#util.browser.getCurrentWindow) ⇒ <code>Object</code>
        * [.switchToIframe(selector)](#util.browser.switchToIframe)
        * [.switchToDefaultContent()](#util.browser.switchToDefaultContent)
        * [.back()](#util.browser.back)
        * [.forward()](#util.browser.forward)
        * [.log(message)](#util.browser.log)
        * [.warn(message)](#util.browser.warn)
        * [.error(message)](#util.browser.error)
        * [.isMobile()](#util.browser.isMobile) ⇒ <code>boolean</code>
        * [.isAndroid()](#util.browser.isAndroid) ⇒ <code>boolean</code>
        * [.isIos()](#util.browser.isIos) ⇒ <code>boolean</code>
    * [.component](#util.component)
        * [new component()](#new_util.component_new)
        * [.loadEntryPoint([folderPath])](#util.component.loadEntryPoint) ⇒ <code>Object</code>
        * [.storeEntryPoint(data, [folderPath])](#util.component.storeEntryPoint)
    * [.console](#util.console)
        * [.log(message, [textColor], [backgroundColor], [brightness])](#util.console.log)
        * [.error(message)](#util.console.error)
        * [.warn(message)](#util.console.warn)
        * [.success(message)](#util.console.success)
        * [.info(message)](#util.console.info)
    * [.data](#util.data)
        * [.getData(filename, [source])](#util.data.getData) ⇒ <code>Object</code>
        * [.getSecureData(filename, [source], [options])](#util.data.getSecureData) ⇒ <code>Object</code>
        * [.readDataFromFile(filePath)](#util.data.readDataFromFile) ⇒ <code>Object</code>
        * [.writeDataToFile(filePath, data)](#util.data.writeDataToFile)
        * [.decrypt(data, options)](#util.data.decrypt) ⇒ <code>String</code>
    * [.file](#util.file)
        * [.upload(files, [selector])](#util.file.upload)
        * [.uploadWebGui(files, selector)](#util.file.uploadWebGui)
        * [.parsePdf(pdfStream, renderingMethod)](#util.file.parsePdf) ⇒ <code>String</code>
        * [.expectPdfContainsText(pdfStream, text, renderingMethod)](#util.file.expectPdfContainsText)
        * [.expectPdfNotContainsText(pdfStream, text, renderingMethod)](#util.file.expectPdfNotContainsText)
        * [.getExcelData(filePath, fileName, [sheetIndex], [conversionType])](#util.file.getExcelData)
        * [.getTextData(filePath)](#util.file.getTextData)
        * [.expectTextDataToContain(filePath)](#util.file.expectTextDataToContain)
        * [.getXmlData(filePath)](#util.file.getXmlData)
        * [.getAttributeValuesFromJson(object)](#util.file.getAttributeValuesFromJson)
        * [.findFilePathRecursively(directory, fileName)](#util.file.findFilePathRecursively)
        * [.getFileNamesByExtensions(dirPath, fileExtensions)](#util.file.getFileNamesByExtensions)
    * [.formatter](#util.formatter)
        * [.sliceStringAt(input, slicePoint, length)](#util.formatter.sliceStringAt) ⇒ <code>String</code>
        * [.sliceStringAfter(input, slicePoint, length)](#util.formatter.sliceStringAfter) ⇒ <code>String</code>
        * [.trimString(input)](#util.formatter.trimString)
        * [.extractNumberFromString(input, [index])](#util.formatter.extractNumberFromString) ⇒ <code>String</code>
        * [.stringifyJSON(object)](#util.formatter.stringifyJSON) ⇒ <code>String</code>
        * [.addRemoveLeadingZeros(number, length)](#util.formatter.addRemoveLeadingZeros) ⇒ <code>String</code>
        * [.formatDate(date, format, [locale])](#util.formatter.formatDate) ⇒ <code>String</code>
        * [.formatDateWithTime(date, format, [locale])](#util.formatter.formatDateWithTime) ⇒ <code>String</code> \| <code>Date</code>
    * [.function](#util.function)
        * [.retry(fct, args, [retries], [interval], [scope])](#util.function.retry)
        * [.executeOptional(fct, args)](#util.function.executeOptional)
    * [.system](#util.system)
        * [.getOS()](#util.system.getOS) ⇒ <code>String</code>
    * [.userSettings](#util.userSettings)

<a name="util.browser"></a>

### util.browser
**Kind**: static class of [<code>util</code>](#util)  

* [.browser](#util.browser)
    * [.getBaseUrl()](#util.browser.getBaseUrl) ⇒ <code>String</code>
    * [.setBaseUrl(baseUrl:)](#util.browser.setBaseUrl)
    * [.logCurrentUrl()](#util.browser.logCurrentUrl)
    * [.getCurrentUrl()](#util.browser.getCurrentUrl)
    * [.resetFocus()](#util.browser.resetFocus)
    * [.sleep([duration])](#util.browser.sleep)
    * [.collectCoverage()](#util.browser.collectCoverage)
    * [.sleepAndCollectCoverage([duration])](#util.browser.sleepAndCollectCoverage)
    * [.refresh()](#util.browser.refresh)
    * [.clearBrowser([clearLocal], [clearSession], [clearCookies])](#util.browser.clearBrowser)
    * [.getBrowserName()](#util.browser.getBrowserName) ⇒ <code>String</code>
    * [.getUI5Version([timeout])](#util.browser.getUI5Version)
    * [.logUI5Version()](#util.browser.logUI5Version)
    * [.executeScript(command)](#util.browser.executeScript) ⇒ <code>Any</code>
    * [.waitUntil(condition, [options])](#util.browser.waitUntil) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.switchToNewWindow(titleOrUrl, [timeout])](#util.browser.switchToNewWindow)
    * [.switchToWindow(handle)](#util.browser.switchToWindow)
    * [.getCurrentWindow()](#util.browser.getCurrentWindow) ⇒ <code>Object</code>
    * [.switchToIframe(selector)](#util.browser.switchToIframe)
    * [.switchToDefaultContent()](#util.browser.switchToDefaultContent)
    * [.back()](#util.browser.back)
    * [.forward()](#util.browser.forward)
    * [.log(message)](#util.browser.log)
    * [.warn(message)](#util.browser.warn)
    * [.error(message)](#util.browser.error)
    * [.isMobile()](#util.browser.isMobile) ⇒ <code>boolean</code>
    * [.isAndroid()](#util.browser.isAndroid) ⇒ <code>boolean</code>
    * [.isIos()](#util.browser.isIos) ⇒ <code>boolean</code>

<a name="util.browser.getBaseUrl"></a>

#### browser.getBaseUrl() ⇒ <code>String</code>
Retrieves the baseUrl from the configuration file.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>String</code> - The baseUrl.  
**Example**  
```js
const baseUrl = util.browser.getBaseUrl();
```
<a name="util.browser.setBaseUrl"></a>

#### browser.setBaseUrl(baseUrl:)
Sets or overwrites the baseUrl in the configuration file.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Description |
| --- | --- | --- |
| baseUrl: | <code>String</code> | base URL to set |

**Example**  
```js
await util.browser.setBaseUrl("https://www.sap.com");
```
<a name="util.browser.logCurrentUrl"></a>

#### browser.logCurrentUrl()
Displays the current URL in the console.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.logCurrentUrl();
```
<a name="util.browser.getCurrentUrl"></a>

#### browser.getCurrentUrl()
Returns the current URL

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.getCurrentUrl();
```
<a name="util.browser.resetFocus"></a>

#### browser.resetFocus()
Resets the focus in case it set for a specific element.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.resetFocus();
```
<a name="util.browser.sleep"></a>

#### browser.sleep([duration])
Sleeps (pauses execution) for the passed duration.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [duration] | <code>Number</code> | <code>1000</code> | The time to pause (ms). |

**Example**  
```js
await util.browser.sleep(30000);
```
<a name="util.browser.collectCoverage"></a>

#### browser.collectCoverage()
Trigger collection of coverage by coverage service.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.collectCoverage();
```
<a name="util.browser.sleepAndCollectCoverage"></a>

#### browser.sleepAndCollectCoverage([duration])
Trigger collection of coverage by coverage service.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [duration] | <code>Number</code> | <code>1000</code> | The time to pause (ms). |

**Example**  
```js
await util.browser.sleepAndCollectCoverage(3000);
```
<a name="util.browser.refresh"></a>

#### browser.refresh()
Refreshes the page.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.refresh();
```
<a name="util.browser.clearBrowser"></a>

#### browser.clearBrowser([clearLocal], [clearSession], [clearCookies])
Clears the local and session cache and deletes all browser cookies.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [clearLocal] | <code>Boolean</code> | <code>true</code> | Specifies if the local cache will be cleared. |
| [clearSession] | <code>Boolean</code> | <code>true</code> | Specifies if the session cache will be cleared. |
| [clearCookies] | <code>Boolean</code> | <code>true</code> | Specifies if the cookies will be cleared. |

**Example**  
```js
await util.browser.clearBrowser();
```
<a name="util.browser.getBrowserName"></a>

#### browser.getBrowserName() ⇒ <code>String</code>
Retrieves the name of the current browser.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>String</code> - The browser name.  
**Example**  
```js
const browserName = util.browser.getBrowserName();
```
<a name="util.browser.getUI5Version"></a>

#### browser.getUI5Version([timeout])
Gets the UI5 version and creation date for UI5 based applications.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await util.browser.getUI5Version();
```
<a name="util.browser.logUI5Version"></a>

#### browser.logUI5Version()
Logs the UI5 version and creation date for UI5 based applications to the console.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.logUI5Version();
```
<a name="util.browser.executeScript"></a>

#### browser.executeScript(command) ⇒ <code>Any</code>
Executes the specified JavaScript command.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>Any</code> - The result from the executed function.  

| Param | Type | Description |
| --- | --- | --- |
| command | <code>String</code> \| <code>function</code> | The command to execute. |

**Example**  
```js
await util.browser.executeScript(command);
```
<a name="util.browser.waitUntil"></a>

#### browser.waitUntil(condition, [options]) ⇒ <code>Promise.&lt;void&gt;</code>
Waits until the specified function returns true or the timeout is reached.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>Promise.&lt;void&gt;</code> - Resolves when the function returns true or the timeout is reached.  

| Param | Type | Description |
| --- | --- | --- |
| condition | <code>function</code> | The function to wait for. |
| [options] | <code>Object</code> | Options for the wait. |
| [options.timeout] | <code>Number</code> | The timeout to wait (ms). |
| [options.timeoutMsg] | <code>String</code> | The message to display if the timeout is reached. |
| [options.interval] | <code>Number</code> | The interval to check the function (ms). |

**Example**  
```js
await util.browser.waitUntil(async () => await ui5.element.isVisible(selector), { timeout: 5000, timeoutMsg: "Element not visible" });
```
<a name="util.browser.switchToNewWindow"></a>

#### browser.switchToNewWindow(titleOrUrl, [timeout])
Switches to the window or tab with the given title.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| titleOrUrl | <code>String</code> \| <code>RegExp</code> |  | Window title or url of the expected window or tab (can be either a string or part of it as regular expression). |
| [timeout] | <code>Number</code> | <code>10000</code> | The timeout to wait (ms). |

**Example**  
```js
await util.browser.switchToNewWindow("SAP - Home");
```
**Example**  
```js
await util.browser.switchToNewWindow(/Home/);
```
**Example**  
```js
await util.browser.switchToNewWindow("www.sap.com");
```
<a name="util.browser.switchToWindow"></a>

#### browser.switchToWindow(handle)
Switches to the passed window.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Description |
| --- | --- | --- |
| handle | <code>Object</code> | The window handle. |

**Example**  
```js
await util.browser.switchToWindow(originalWindowHandle);
```
<a name="util.browser.getCurrentWindow"></a>

#### browser.getCurrentWindow() ⇒ <code>Object</code>
Returns the current window handle.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>Object</code> - The window handle.  
**Example**  
```js
const originalWindowHandle = await util.browser.getCurrentWindow();
```
<a name="util.browser.switchToIframe"></a>

#### browser.switchToIframe(selector)
Switches to the passed iframe.

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Description |
| --- | --- | --- |
| selector | <code>String</code> | The CSS selector describing the iframe element. |

**Example**  
```js
await util.browser.switchToIframe("iframe[id='frame01']");
```
<a name="util.browser.switchToDefaultContent"></a>

#### browser.switchToDefaultContent()
Switches to the default content of the HTML page.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.switchToDefaultContent();
```
<a name="util.browser.back"></a>

#### browser.back()
Go one step back in browser history.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.back();
```
<a name="util.browser.forward"></a>

#### browser.forward()
Go one step ahead in browser history.

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Example**  
```js
await util.browser.forward();
```
<a name="util.browser.log"></a>

#### browser.log(message)
add log message to browser logs, can be viewed in the html report

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | string - The message to be logged. |

**Example**  
```js
await util.browser.log("Created PO 123456");
```
<a name="util.browser.warn"></a>

#### browser.warn(message)
add warning message to browser logs, can be viewed in the html report

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | string - The warning message to be logged. |

**Example**  
```js
await util.browser.warn("This is a warning message");
```
<a name="util.browser.error"></a>

#### browser.error(message)
add error message to browser logs, can be viewed in the html report

**Kind**: static method of [<code>browser</code>](#util.browser)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | string - The error message to be logged. |

**Example**  
```js
await util.browser.error("This is an error message");
```
<a name="util.browser.isMobile"></a>

#### browser.isMobile() ⇒ <code>boolean</code>
Indicates a mobile session

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>boolean</code> - Return true if its a mobile session driver.  
**Example**  
```js
await util.browser.isMobile();
```
<a name="util.browser.isAndroid"></a>

#### browser.isAndroid() ⇒ <code>boolean</code>
Indicates a mobile session

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>boolean</code> - Return true if its a Android session driver.  
**Example**  
```js
await util.browser.isAndroid();
```
<a name="util.browser.isIos"></a>

#### browser.isIos() ⇒ <code>boolean</code>
Indicates an iOS session

**Kind**: static method of [<code>browser</code>](#util.browser)  
**Returns**: <code>boolean</code> - Return true if its a iOS session driver.  
**Example**  
```js
await util.browser.isIos();
```
<a name="util.component"></a>

### util.component
**Kind**: static class of [<code>util</code>](#util)  

* [.component](#util.component)
    * [new component()](#new_util.component_new)
    * [.loadEntryPoint([folderPath])](#util.component.loadEntryPoint) ⇒ <code>Object</code>
    * [.storeEntryPoint(data, [folderPath])](#util.component.storeEntryPoint)

<a name="new_util.component_new"></a>

#### new component()
This class provides functions for writing component tests with qmate-proxy-service

<a name="util.component.loadEntryPoint"></a>

#### component.loadEntryPoint([folderPath]) ⇒ <code>Object</code>
Will be called in component test scripts. Returns a previously stored entry point object for sharing information (like a draft id) between preparation and the actual component tests.

**Kind**: static method of [<code>component</code>](#util.component)  
**Returns**: <code>Object</code> - The data object of the stored entry point.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [folderPath] | <code>String</code> | <code>&quot;./entrypoints&quot;</code> | Custom folder path where entry points are stored. |

**Example**  
```js
const entryPoint = util.component.loadEntryPoint();
```
<a name="util.component.storeEntryPoint"></a>

#### component.storeEntryPoint(data, [folderPath])
Will be called in preparation scripts before component tests. Stores an entry point object for sharing information (like a draft id) between preparation and the actual component tests.

**Kind**: static method of [<code>component</code>](#util.component)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| data | <code>Object</code> |  | The data object of the entry point to store. |
| [folderPath] | <code>String</code> | <code>&quot;./entrypoints&quot;</code> | Custom folder path where entry points are stored. |

**Example**  
```js
const entryPoint = util.component.storeEntryPoint({"draftId": "0123456789"});
```
<a name="util.console"></a>

### util.console
**Kind**: static class of [<code>util</code>](#util)  

* [.console](#util.console)
    * [.log(message, [textColor], [backgroundColor], [brightness])](#util.console.log)
    * [.error(message)](#util.console.error)
    * [.warn(message)](#util.console.warn)
    * [.success(message)](#util.console.success)
    * [.info(message)](#util.console.info)

<a name="util.console.log"></a>

#### console.log(message, [textColor], [backgroundColor], [brightness])
Logs a message to the console in the given color.

**Kind**: static method of [<code>console</code>](#util.console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | The message to log. |
| [textColor] | <code>String</code> | The color of the text: "black, white", "red", "yellow", "green", "blue", "cyan", "magenta". |
| [backgroundColor] | <code>String</code> | The color of the background: "black, white", "red", "yellow", "green", "blue", "cyan", "magenta". |
| [brightness] | <code>String</code> | Adjusts the brightness of the color: "bright", "dim". Leave empty for default. |

**Example**  
```js
util.console.log("The document has been saved.", "green");
```
<a name="util.console.error"></a>

#### console.error(message)
Logs a error message to the console in red.

**Kind**: static method of [<code>console</code>](#util.console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | The message to log. |

**Example**  
```js
util.console.error("Error: Please investigate.");
```
<a name="util.console.warn"></a>

#### console.warn(message)
Logs a warning message to the console in yellow.

**Kind**: static method of [<code>console</code>](#util.console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | The message to log. |

**Example**  
```js
util.console.warn("Optional step not executed.");
```
<a name="util.console.success"></a>

#### console.success(message)
Logs a success message to the console in green.

**Kind**: static method of [<code>console</code>](#util.console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | The message to log. |

**Example**  
```js
util.console.success("The document has been saved.");
```
<a name="util.console.info"></a>

#### console.info(message)
Logs a info message to the console in cyan.

**Kind**: static method of [<code>console</code>](#util.console)  

| Param | Type | Description |
| --- | --- | --- |
| message | <code>String</code> | The message to log. |

**Example**  
```js
util.console.success("The document has been saved.");
```
<a name="util.data"></a>

### util.data
**Kind**: static class of [<code>util</code>](#util)  

* [.data](#util.data)
    * [.getData(filename, [source])](#util.data.getData) ⇒ <code>Object</code>
    * [.getSecureData(filename, [source], [options])](#util.data.getSecureData) ⇒ <code>Object</code>
    * [.readDataFromFile(filePath)](#util.data.readDataFromFile) ⇒ <code>Object</code>
    * [.writeDataToFile(filePath, data)](#util.data.writeDataToFile)
    * [.decrypt(data, options)](#util.data.decrypt) ⇒ <code>String</code>

<a name="util.data.getData"></a>

#### data.getData(filename, [source]) ⇒ <code>Object</code>
Returns the data object with the given filename (JSON, stored in data folder).

**Kind**: static method of [<code>data</code>](#util.data)  
**Returns**: <code>Object</code> - The data object.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| filename | <code>String</code> |  | The name of the data file. |
| [source] | <code>String</code> | <code>data</code> | The source key defined under params.import of the config file. |

**Example**  
```js
const data = util.data.getData("myTest");
```
<a name="util.data.getSecureData"></a>

#### data.getSecureData(filename, [source], [options]) ⇒ <code>Object</code>
Returns and encrypts the data object with the given filename (JSON, stored in data folder). Will return the local file object if private key is not accessible.

**Kind**: static method of [<code>data</code>](#util.data)  
**Returns**: <code>Object</code> - The encrypted or local data object.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| filename | <code>String</code> |  | The name of the data file (without suffix '.secure' or '.local'). |
| [source] | <code>String</code> | <code>data</code> | The source key defined under params.import of the config file. |
| [options] | <code>Object</code> |  | The options object. |

**Example**  
```js
const secureData = util.data.getSecureData("myTest");
```
<a name="util.data.readDataFromFile"></a>

#### data.readDataFromFile(filePath) ⇒ <code>Object</code>
Reads the data object from the given filepath.

**Kind**: static method of [<code>data</code>](#util.data)  
**Returns**: <code>Object</code> - The data object.  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>String</code> | The filepath. |

**Example**  
```js
const data = util.data.readDataFromFile("./data/myData.json");
```
<a name="util.data.writeDataToFile"></a>

#### data.writeDataToFile(filePath, data)
Writes the data object to the given filepath.

**Kind**: static method of [<code>data</code>](#util.data)  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>String</code> | The filepath. |
| data | <code>Object</code> | The data object to write. |

**Example**  
```js
const data = util.data.writeDataToFile("myTest");
```
<a name="util.data.decrypt"></a>

#### data.decrypt(data, options) ⇒ <code>String</code>
Decrypts the passed input data.

**Kind**: static method of [<code>data</code>](#util.data)  
**Returns**: <code>String</code> - The decrypted data.  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>String</code> \| <code>Array.&lt;String&gt;</code> | The encrypted data to decrypt. Single value or array of values for different keys. |
| options | <code>Object</code> | The decryption options. |

**Example**  
```js
const decrypted = util.data.decrypt("d704004c262faa8ef4bdcf34c8a94883e15524872c7bef334d26a391a1934cf47338b749d99426980ee4cc7a81deaef21439c6894ab0324cdb29b9b6332635baca442651c5d37847f52bb90b8868e037271a7d456024b39b65fdf4dc62e8d82a3d5683a72e4324c59d339742fc79749f0ee74abef916d38e306218adc48e3547a2b346962249320c962d22cb46d9998de36d8219a2496c0997d0fc389f76fb1431a9b57c317886e9c9795c0a09ad98d9fa0b7687d10814dc7973397f3f72a227a04ead4c3d1d428c096a51922ffc4d7afc3952df1c130def5c5fb3e834605cbf1454885966cc65c77046343f4c678e74931fb2dd6cac8dae17837cf674f288d6550dd7fa6b01f5b7ea68aa6bd27d79dd5d53edb5fd4b4edce824bd31b3939352ad7a71a16bab8c54025c2bb92c54e022fcd23ff08bc54a17fc50d00dc3b884cadbfdefe1e75901fdf80e7324ad02a891f2c4863fa120ca238520b79126c65a03");
```
<a name="util.file"></a>

### util.file
**Kind**: static class of [<code>util</code>](#util)  

* [.file](#util.file)
    * [.upload(files, [selector])](#util.file.upload)
    * [.uploadWebGui(files, selector)](#util.file.uploadWebGui)
    * [.parsePdf(pdfStream, renderingMethod)](#util.file.parsePdf) ⇒ <code>String</code>
    * [.expectPdfContainsText(pdfStream, text, renderingMethod)](#util.file.expectPdfContainsText)
    * [.expectPdfNotContainsText(pdfStream, text, renderingMethod)](#util.file.expectPdfNotContainsText)
    * [.getExcelData(filePath, fileName, [sheetIndex], [conversionType])](#util.file.getExcelData)
    * [.getTextData(filePath)](#util.file.getTextData)
    * [.expectTextDataToContain(filePath)](#util.file.expectTextDataToContain)
    * [.getXmlData(filePath)](#util.file.getXmlData)
    * [.getAttributeValuesFromJson(object)](#util.file.getAttributeValuesFromJson)
    * [.findFilePathRecursively(directory, fileName)](#util.file.findFilePathRecursively)
    * [.getFileNamesByExtensions(dirPath, fileExtensions)](#util.file.getFileNamesByExtensions)

<a name="util.file.upload"></a>

#### file.upload(files, [selector])
Uploads all the file/s by the paths given in the Array.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| files | <code>Array.&lt;String&gt;</code> |  | Array with path/s of file/s to be uploaded. |
| [selector] | <code>String</code> | <code>&quot;input[type&#x3D;&#x27;file&#x27;]&quot;</code> | Custom selector of uploader control (in case there are more then one present). |

**Example**  
```js
await util.file.upload(["path/to/text1.txt", "path/to/text2.txt"]); // uses the default uploader control
```
**Example**  
```js
await util.file.upload(["path/to/text1.txt", "path/to/text2.txt"], "input[id='myUpload']"); // upload to file uploader with matching selector
```
<a name="util.file.uploadWebGui"></a>

#### file.uploadWebGui(files, selector)
Uploads all the file/s by the paths given in the Array for SAP WebGUI apps.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| files | <code>Array.&lt;String&gt;</code> | Array with path/s of file/s to be uploaded. |
| selector | <code>String</code> | Custom selector of the input element |

**Example**  
```js
await util.file.uploadWebGui(["path/to/text1.txt"], "INPUT[title='External file name']");
```
<a name="util.file.parsePdf"></a>

#### file.parsePdf(pdfStream, renderingMethod) ⇒ <code>String</code>
Parses the text from PDF stream. Returned text can be asserted to verify the PDF document content.

**Kind**: static method of [<code>file</code>](#util.file)  
**Returns**: <code>String</code> - The parsed PDF text.  
**See**: <a href="TODO">Parse PDF</a>  

| Param | Type | Description |
| --- | --- | --- |
| pdfStream | <code>Buffer</code> | PDF stream to be downloaded. |
| renderingMethod | <code>function</code> | Function to customize the parsing process. |

**Example**  
```js
await util.file.parsePdf(pdfStream, customRenderingMethod);
```
<a name="util.file.expectPdfContainsText"></a>

#### file.expectPdfContainsText(pdfStream, text, renderingMethod)
Parses the PDF and checks for given text to be contained in PDF.

**Kind**: static method of [<code>file</code>](#util.file)  
**See**: <a href="TODO">Parse pdf</a>  

| Param | Type | Description |
| --- | --- | --- |
| pdfStream | <code>Buffer</code> | PDF stream to be downloaded. |
| text | <code>String</code> | The expected text. |
| renderingMethod | <code>function</code> | Function to customize the parsing process. |

**Example**  
```js
await util.file.expectPdfContainsText(pdfStream, "abc");
```
<a name="util.file.expectPdfNotContainsText"></a>

#### file.expectPdfNotContainsText(pdfStream, text, renderingMethod)
Parses the PDF and checks for given text not to be contained in PDF.

**Kind**: static method of [<code>file</code>](#util.file)  
**See**: <a href="TODO">Parse pdf</a>  

| Param | Type | Description |
| --- | --- | --- |
| pdfStream | <code>Buffer</code> | PDF stream to be downloaded |
| text | <code>String</code> | The text expected to be not contained in the PDF. |
| renderingMethod | <code>function</code> | Function to customize the parsing process. |

**Example**  
```js
await util.file.expectPdfNotContainsText(pdfStream, "abc");
```
<a name="util.file.getExcelData"></a>

#### file.getExcelData(filePath, fileName, [sheetIndex], [conversionType])
- It returns the excel data based on the conversion type which is passed

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | File path is required |
| fileName | <code>string</code> | File Name is required |
| [sheetIndex] | <code>number</code> | sheetIndex is required |
| [conversionType] | <code>string</code> | Value for this are [json, csv, txt] |

**Example**  
```js
const myTableContent = await util.file.getExcelData("/Users/path/myWork", "myTable.xlx");
```
<a name="util.file.getTextData"></a>

#### file.getTextData(filePath)
- Returns the content of a .txt file.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | Path to the file. |

**Example**  
```js
const txtData = await util.file.getTextData(path.resolve(__dirname, "./testFiles/test3.txt"));
const isDateIncluded = txtData.includes("26.6.2023");
common.assertion.expectEqual(isDateIncluded, true);
```
<a name="util.file.expectTextDataToContain"></a>

#### file.expectTextDataToContain(filePath)
- Reads the specified .txt file and asserts if it includes a specific string.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | Path to the file. |

**Example**  
```js
await util.file.expectTextDataToContain("/Users/path/myWork", "supplierList.txt");
```
<a name="util.file.getXmlData"></a>

#### file.getXmlData(filePath)
- Returns the converted JSON object based on the passed XML file.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>string</code> | Path to the file. |

**Example**  
```js
const xmlData = await util.file.getXmlData(path.resolve(__dirname, "./testFiles/test2.xml"));
```
<a name="util.file.getAttributeValuesFromJson"></a>

#### file.getAttributeValuesFromJson(object)
- Traverses the passed JSON object and returns the value/s of the passed attribute if found. Else returns empty Array.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| object | <code>object</code> | The JSON Object to search through. |

**Example**  
```js
const attribute = util.file.getAttributeValuesFromJson(xmlData, "CtrlSum");
```
<a name="util.file.findFilePathRecursively"></a>

#### file.findFilePathRecursively(directory, fileName)
- Returns the absolute path of the file with the given filename. Searches Recursively for the file within the given directory.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| directory | <code>string</code> | The name of the directory. |
| fileName | <code>string</code> | The name of the file. |

**Example**  
```js
await util.file.findFilePathRecursively("/Users","test.xls");
```
<a name="util.file.getFileNamesByExtensions"></a>

#### file.getFileNamesByExtensions(dirPath, fileExtensions)
- Returns the filename/s of the given directory filtered by the given extensions.

**Kind**: static method of [<code>file</code>](#util.file)  

| Param | Type | Description |
| --- | --- | --- |
| dirPath | <code>string</code> | The path to the directory. |
| fileExtensions | <code>string</code> \| <code>Array.&lt;string&gt;</code> | The file extension as string or multiple as string array. |

**Example**  
```js
const fileName = await util.file.getFileNamesByExtensions("regression/downloads", "xml");
const fileNames = await util.file.getFileNamesByExtensions("regression/downloads", "["xml", "txt"]");
```
<a name="util.formatter"></a>

### util.formatter
**Kind**: static class of [<code>util</code>](#util)  

* [.formatter](#util.formatter)
    * [.sliceStringAt(input, slicePoint, length)](#util.formatter.sliceStringAt) ⇒ <code>String</code>
    * [.sliceStringAfter(input, slicePoint, length)](#util.formatter.sliceStringAfter) ⇒ <code>String</code>
    * [.trimString(input)](#util.formatter.trimString)
    * [.extractNumberFromString(input, [index])](#util.formatter.extractNumberFromString) ⇒ <code>String</code>
    * [.stringifyJSON(object)](#util.formatter.stringifyJSON) ⇒ <code>String</code>
    * [.addRemoveLeadingZeros(number, length)](#util.formatter.addRemoveLeadingZeros) ⇒ <code>String</code>
    * [.formatDate(date, format, [locale])](#util.formatter.formatDate) ⇒ <code>String</code>
    * [.formatDateWithTime(date, format, [locale])](#util.formatter.formatDateWithTime) ⇒ <code>String</code> \| <code>Date</code>

<a name="util.formatter.sliceStringAt"></a>

#### formatter.sliceStringAt(input, slicePoint, length) ⇒ <code>String</code>
Slices the given string beginning at a specific substring.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> - The sliced string.  

| Param | Type | Description |
| --- | --- | --- |
| input | <code>String</code> | The input string to slice. |
| slicePoint | <code>String</code> | The substring at which the input string is being sliced. |
| length | <code>number</code> | The required length of the returning string (starting at the index of the passed slice point). |

**Example**  
```js
const sliced = util.formatter.sliceStringAt("prefixNR12345postfix", "NR", 7);
// returns "NR12345"
```
<a name="util.formatter.sliceStringAfter"></a>

#### formatter.sliceStringAfter(input, slicePoint, length) ⇒ <code>String</code>
Slices the given string after a specific substring.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> - The sliced string.  

| Param | Type | Description |
| --- | --- | --- |
| input | <code>String</code> | The input string to slice. |
| slicePoint | <code>String</code> | The substring after which the input string is being sliced. |
| length | <code>number</code> | The required length of the returning string (starting at the index after the passed slice point). |

**Example**  
```js
const sliced = util.formatter.sliceStringAfter("prefixNR12345postfix", "NR", 5);
// returns "12345"
```
<a name="util.formatter.trimString"></a>

#### formatter.trimString(input)
Removes whitespace from both sides of the given string.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  

| Param | Type | Description |
| --- | --- | --- |
| input | <code>String</code> | The input string to trim. |

**Example**  
```js
const trimmed = util.formatter.trimString("   value ");
// returns "value"
```
<a name="util.formatter.extractNumberFromString"></a>

#### formatter.extractNumberFromString(input, [index]) ⇒ <code>String</code>
Extracts all numbers from a string.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> - The extracted number.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| input | <code>String</code> |  | The input string to extract the number. |
| [index] | <code>number</code> | <code>0</code> | If there are multiple numbers in the string you can pass an index to return a specific number. |

**Example**  
```js
const extracted = util.formatter.extractNumberFromString("prefixNR12345postfix");
// returns "12345"
```
**Example**  
```js
const extracted = util.formatter.extractNumberFromString("first12345 someText second 20 abc", 1);
// returns "20"
```
<a name="util.formatter.stringifyJSON"></a>

#### formatter.stringifyJSON(object) ⇒ <code>String</code>
Converts a JSON object to string.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> - The converted JSON object.  

| Param | Type | Description |
| --- | --- | --- |
| object | <code>Object</code> | The JSON to be converted. |

**Example**  
```js
console.log(`Printing the current selector: ${util.formatter.stringifyJSON(selector)}`);
```
<a name="util.formatter.addRemoveLeadingZeros"></a>

#### formatter.addRemoveLeadingZeros(number, length) ⇒ <code>String</code>
Adds or removes leading zeros to the passed number to format it to the required length.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> - The formatted number.  

| Param | Type | Description |
| --- | --- | --- |
| number | <code>String</code> | The number to be formatted. |
| length | <code>Number</code> | The required length of the number. |

**Example**  
```js
const itemNumber = util.formatter.addRemoveLeadingZeros(10, 5);
```
<a name="util.formatter.formatDate"></a>

#### formatter.formatDate(date, format, [locale]) ⇒ <code>String</code>
formats date.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> - The formatted date as string.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| date | <code>Date</code> |  | The date object to be formatted. |
| format | <code>String</code> |  | The expected format ("mm/dd/yyyy", "mm-dd-yyyy", "dd.mm.yyyy", "dd/mm/yyyy", "yyyymmdd", "yyyy/mm/dd", "yyyy.mm.dd", "yyyy-mm-dd", "dd.mm.yyyy.hh.mm", "mmm dd, yyyy", "mmm d, yyyy", "g.yy.mm.dd", "g/yy/mm/dd", "g-yy-mm-dd" "datetime", "object"). |
| [locale] | <code>String</code> | <code>&quot;en-US&quot;</code> | The locale format of the date. E.g. "en-US", "de-DE", etc. |

**Example**  
```js
const date = new Date(2020, 0, 17);
const formattedDate = util.formatter.formatDate(date, "mm/dd/yyyy");
// returns "01/17/2020"
```
**Example**  
```js
const date = new Date(2022, 3, 12);
const formattedDate = util.formatter.formatDate(date, "mmm dd, yyyy");
// returns "Apr 03, 2022"
```
<a name="util.formatter.formatDateWithTime"></a>

#### formatter.formatDateWithTime(date, format, [locale]) ⇒ <code>String</code> \| <code>Date</code>
formats date with time.

**Kind**: static method of [<code>formatter</code>](#util.formatter)  
**Returns**: <code>String</code> \| <code>Date</code> - The formatted date with time as string or date object.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| date | <code>Date</code> |  | The date object to be formatted. |
| format | <code>String</code> |  | The expected format ("datetime", "object", "mm/dd/yyyy HH\:mm:ss", "dd.mm.yyyy h\:mm:ss a", "dd/mm/yyyy HH\:mm:ss z", "yyyymmdd h\:mm:ss a z", "yyyy/mm/dd HH\:mm", "mmm dd, yyyy h\:mm a", "mmm d, yyyy HH", "mmm d, yyyy h a", etc.).<br> See the `format` argument of the [calculateWithTime](#common.date.calculateWithTime) function for more details on the available formats. |
| [locale] | <code>String</code> | <code>&quot;en-US&quot;</code> | The locale format of the date. E.g. "en-US", "de-DE", etc. |

**Example**  
```js
const date = new Date(2020, 0, 17, 15, 30, 45);
const formattedDate = util.formatter.formatDateWithTime(date, "mm/dd/yyyy HH:mm:ss");
// returns "01/17/2020 15:30:45"
```
**Example**  
```js
const date = new Date(2022, 3, 12, 9, 5, 0);
const formattedDate = util.formatter.formatDateWithTime(date, "mmm dd, yyyy h:mm:ss a");
// returns "Apr 12, 2022 9:05:00 AM"
```
**Example**  
```js
const date = new Date(2022, 3, 12, 9, 5, 0);
const formattedDate = util.formatter.formatDateWithTime(date, "dd/mm/yyyy HH:mm:ss z");
// returns "12/04/2022 09:05:00 GMT+02:00"
```
**Example**  
```js
const date = new Date(2022, 3, 12, 9, 5, 0);
const formattedDate = util.formatter.formatDateWithTime(date, "yyyy/mm/dd HH:mm");
// returns "2022/04/12 09:05"
```
**Example**  
```js
const date = new Date(2022, 3, 12, 9, 5, 0);
const formattedDate = util.formatter.formatDateWithTime(date, "mmm dd, yyyy h:mm a");
// returns "Apr 12, 2022 9:05 AM"
```
<a name="util.function"></a>

### util.function
**Kind**: static class of [<code>util</code>](#util)  

* [.function](#util.function)
    * [.retry(fct, args, [retries], [interval], [scope])](#util.function.retry)
    * [.executeOptional(fct, args)](#util.function.executeOptional)

<a name="util.function.retry"></a>

#### function.retry(fct, args, [retries], [interval], [scope])
Retries the passed function n times with a specific interval until it executed successfully.

**Kind**: static method of [<code>function</code>](#util.function)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| fct | <code>function</code> |  | The function to retry. |
| args | <code>Array</code> |  | An array of the arguments passed to the function. |
| [retries] | <code>Integer</code> | <code>3</code> | The number of retries. Can be set in config for all functions under "params" - "stepsRetries". |
| [interval] | <code>Integer</code> | <code>5000</code> | The interval of the retries (ms). Can be set in config for all functions under "params" - "stepRetriesIntervals". |
| [scope] | <code>Object</code> | <code></code> | The function scope. Defaults is the global object. |

**Example**  
```js
await util.function.retry(ui5.userInteraction.fill, [selector, value], 4, 10000);
```
**Example**  
```js
await util.function.retry(async () => {
 await ui5.userInteraction.fill(selector, "ABC");
}, [], 2, 30000);
```
<a name="util.function.executeOptional"></a>

#### function.executeOptional(fct, args)
Executes the given function optionally. If it fails, a promise will be returned anyway.

**Kind**: static method of [<code>function</code>](#util.function)  

| Param | Type | Description |
| --- | --- | --- |
| fct | <code>function</code> | The function to execute. |
| args | <code>Array</code> | An array of the arguments passed to the function. |

**Example**  
```js
await util.function.executeOptional(ui5.userInteraction.fill, [selector, value]);
```
**Example**  
```js
await util.function.executeOptional(async () => {
 await ui5.userInteraction.fill(selector, "ABC");
}, []);
```
<a name="util.system"></a>

### util.system
**Kind**: static class of [<code>util</code>](#util)  
<a name="util.system.getOS"></a>

#### system.getOS() ⇒ <code>String</code>
Returns the current operating system.

**Kind**: static method of [<code>system</code>](#util.system)  
**Returns**: <code>String</code> - AIX | Android | MacOS | FreeBSD | Linux | OpenBSD | Windows | SunOS  
**Example**  
```js
const os = await util.system.getOS();
```
<a name="util.userSettings"></a>

### util.userSettings
**Kind**: static class of [<code>util</code>](#util)  
<a name="ui5"></a>

## ui5
Global namespace for UI5 modules.

**Kind**: global constant  

* [ui5](#ui5)
    * [.assertion](#ui5.assertion)
        * [.expectAttributeToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectAttributeToBe)
        * [.expectAttributeToContain(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectAttributeToContain)
        * [.expectTextToBe(selector, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectTextToBe)
        * [.expectValueToBe(selector, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectValueToBe)
        * [.expectValueToBeDefined(selector, [index], [timeout])](#ui5.assertion.expectValueToBeDefined)
        * [.expectToBeNotEnabled(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeNotEnabled)
        * [.expectToBeEnabled(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeEnabled)
        * [.expectValidationError(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectValidationError)
        * [.expectValidationSuccess(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectValidationSuccess)
        * [.expectCssPropertyValueToBe(selector, cssProperty, compareValue, [index], [timeout])](#ui5.assertion.expectCssPropertyValueToBe)
        * [.expectBindingPathToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectBindingPathToBe)
        * [.expectBindingContextPathToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectBindingContextPathToBe)
        * [.expectToBeVisible(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeVisible)
        * [.expectToBeVisibleInViewport(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeVisibleInViewport)
        * [.expectToBeNotVisible(selector, [index], [timeout])](#ui5.assertion.expectToBeNotVisible)
        * [.expectMessageToastTextToBe(text, [timeout])](#ui5.assertion.expectMessageToastTextToBe)
    * [.confirmationDialog](#ui5.confirmationDialog)
        * [.clickButton(text, [timeout])](#ui5.confirmationDialog.clickButton)
        * [.clickOk([timeout])](#ui5.confirmationDialog.clickOk)
        * [.clickCancel([timeout])](#ui5.confirmationDialog.clickCancel)
        * [.clickYes([timeout])](#ui5.confirmationDialog.clickYes)
        * [.clickNo([timeout])](#ui5.confirmationDialog.clickNo)
        * [.clickCreate([timeout])](#ui5.confirmationDialog.clickCreate)
        * [.clickDelete([timeout])](#ui5.confirmationDialog.clickDelete)
        * [.clickRevokeApproval([timeout])](#ui5.confirmationDialog.clickRevokeApproval)
    * [.control](#ui5.control)
        * [.execute(callbackFunction, selectorOrElement, args)](#ui5.control.execute)
        * [.focus(selector, [index], [timeout])](#ui5.control.focus)
        * [.getProperty(selectorOrElement, propertyName)](#ui5.control.getProperty)
        * [.getAggregationProperty(selectorOrElement, propertyName)](#ui5.control.getAggregationProperty)
        * [.getAssociationProperty(selectorOrElement, propertyName)](#ui5.control.getAssociationProperty)
        * [.getBindingContextPathProperty(selectorOrElement)](#ui5.control.getBindingContextPathProperty)
        * [.getPropertyBinding(selectorOrElement, propertyName)](#ui5.control.getPropertyBinding) ⇒ <code>Array</code>
    * [.date](#ui5.date)
        * [.pick(selector, date, [index])](#ui5.date.pick)
        * [.pickRange(selector, range, [index])](#ui5.date.pickRange)
        * [.pickWithTime(selector, date, [index])](#ui5.date.pickWithTime)
        * [.fillRange(selector, range, [index])](#ui5.date.fillRange)
    * [.element](#ui5.element)
        * [.waitForAll(selector, [timeout])](#ui5.element.waitForAll)
        * [.getAllDisplayed(selector, [timeout])](#ui5.element.getAllDisplayed) ⇒ <code>Array.&lt;Object&gt;</code>
        * [.getDisplayed(selector, [index], [timeout])](#ui5.element.getDisplayed) ⇒ <code>Object</code>
        * [.getByText(selector, value, [index], [timeout])](#ui5.element.getByText) ⇒ <code>Object</code>
        * [.getByChild(elementSelector, childSelector, [index], [timeout])](#ui5.element.getByChild) ⇒ <code>Object</code>
        * [.getByParent(elementSelector, parentSelector, [index], [timeout])](#ui5.element.getByParent) ⇒ <code>Object</code>
        * [.getId(selector, [index], [timeout])](#ui5.element.getId) ⇒ <code>String</code>
        * [.getPropertyValue(selector, property, [index], [timeout])](#ui5.element.getPropertyValue) ⇒ <code>any</code>
        * [.getValue(selector, [index], [timeout])](#ui5.element.getValue) ⇒ <code>String</code>
        * [.getCssPropertyValue(selector, cssProperty, [index], [timeout])](#ui5.element.getCssPropertyValue) ⇒ <code>String</code>
        * [.getBindingValue(selector, bindingContext, [index], [timeout])](#ui5.element.getBindingValue) ⇒ <code>String</code>
        * [.isVisible(selector, [index], [timeout])](#ui5.element.isVisible) ⇒ <code>Boolean</code>
        * [.highlight(selector, [duration], [color])](#ui5.element.highlight)
    * [.errorDialog](#ui5.errorDialog)
        * [.expectToBeVisible()](#ui5.errorDialog.expectToBeVisible)
        * [.clickClose()](#ui5.errorDialog.clickClose)
    * [.footerBar](#ui5.footerBar)
        * [.clickButton(text, [timeout])](#ui5.footerBar.clickButton)
        * [.clickApply([timeout])](#ui5.footerBar.clickApply)
        * [.clickSave([timeout])](#ui5.footerBar.clickSave)
        * [.clickCreate([timeout])](#ui5.footerBar.clickCreate)
        * [.clickCancel([timeout])](#ui5.footerBar.clickCancel)
        * [.clickCheck([timeout])](#ui5.footerBar.clickCheck)
        * [.clickOrder([timeout])](#ui5.footerBar.clickOrder)
        * [.clickPost([timeout])](#ui5.footerBar.clickPost)
        * [.clickAdd([timeout])](#ui5.footerBar.clickAdd)
    * [.mockserver](#ui5.mockserver)
        * [.waitForUi5ApplicationLoad()](#ui5.mockserver.waitForUi5ApplicationLoad)
        * [.interactWithMockServer(mockServerPath, fnCallback, oParams)](#ui5.mockserver.interactWithMockServer)
        * [.attachFunctionBefore(method, mockServerPath, fnBeforeCallback, oParams)](#ui5.mockserver.attachFunctionBefore)
        * [.attachFunctionAfter(method, mockServerPath, fnAfterCallback, oParams)](#ui5.mockserver.attachFunctionAfter)
        * [.addNewRequest(method, mockServerPath, urlPathRegex, responseJsonPath, returnCode, isText, responseMessages, responseLocation)](#ui5.mockserver.addNewRequest)
        * [.removeRequest(method, mockServerPath, urlPathRegex)](#ui5.mockserver.removeRequest)
        * [.addOrOverrideRequest(method, mockServerPath, urlPathRegex, responseJsonPath, returnCode, isText, responseMessages, responseLocation)](#ui5.mockserver.addOrOverrideRequest)
        * [.startMockServer(mockServerPath)](#ui5.mockserver.startMockServer)
        * [.initMockServer(mockServerPath, mockServerOptions)](#ui5.mockserver.initMockServer)
        * [.initApplication(mockServerPath)](#ui5.mockserver.initApplication)
        * [.stopMockServer(mockServerPath)](#ui5.mockserver.stopMockServer)
        * [.loadMockDataFile(filePath, isText)](#ui5.mockserver.loadMockDataFile) ⇒ <code>String</code>
        * [.getEntitySetData(mockServerPath, entitySetName)](#ui5.mockserver.getEntitySetData) ⇒ <code>Array</code>
        * [.setEntitySetData(mockServerPath, entitySetName, entries)](#ui5.mockserver.setEntitySetData)
    * [.navigation](#ui5.navigation)
        * [.navigateToApplication(intent, [preventPopups], [verify], [refresh])](#ui5.navigation.navigateToApplication)
        * [.navigateToApplicationAndRetry(intent, [preventPopups], [verify], [retries], [interval])](#ui5.navigation.navigateToApplicationAndRetry)
        * [.navigateToSystemAndApplication(system, intent, [closePopups], [verify])](#ui5.navigation.navigateToSystemAndApplication)
        * [.navigateToSystemAndApplicationAndRetry(system, intent, [closePopups], [verify], [retries], [interval])](#ui5.navigation.navigateToSystemAndApplicationAndRetry)
        * [.navigateToApplicationWithQueryParams(intent, queryParams, [preventPopups], [verify])](#ui5.navigation.navigateToApplicationWithQueryParams)
        * [.navigateToApplicationWithQueryParamsAndRetry(intent, queryParams, [preventPopups], [verify], [retries], [interval])](#ui5.navigation.navigateToApplicationWithQueryParamsAndRetry)
        * [.closePopups([timeout])](#ui5.navigation.closePopups)
        * [.expectUnsupportedNavigationPopup(navigationTarget)](#ui5.navigation.expectUnsupportedNavigationPopup)
    * [.navigationBar](#ui5.navigationBar)
        * [.clickBack([timeout])](#ui5.navigationBar.clickBack)
        * [.clickSapLogo([timeout])](#ui5.navigationBar.clickSapLogo)
        * [.clickUserIcon([timeout])](#ui5.navigationBar.clickUserIcon)
        * [.expectPageTitle(compareValue)](#ui5.navigationBar.expectPageTitle)
        * [.expectShellHeader([timeout])](#ui5.navigationBar.expectShellHeader)
    * [.qunit](#ui5.qunit)
        * [.executeTests(path)](#ui5.qunit.executeTests)
    * [.session](#ui5.session)
        * [.login(username, [password], [verify], [timeout])](#ui5.session.login)
        * [.loginFiori(username, [password], [verify])](#ui5.session.loginFiori)
        * [.loginSapCloud(username, [password], [verify])](#ui5.session.loginSapCloud)
        * [.loginCustom(username, [password], usernameFieldSelector, passwordFieldSelector, logonButtonSelector, [verify])](#ui5.session.loginCustom)
        * [.loginCustomViaConfig(username, [password], [verify])](#ui5.session.loginCustomViaConfig)
        * [.logout([verify])](#ui5.session.logout)
        * [.switchUser(username, [password], [authenticator], [wait])](#ui5.session.switchUser)
        * [.expectLogoutText()](#ui5.session.expectLogoutText)
    * [.table](#ui5.table)
        * [.sortColumnAscending(columnName, tableSelector)](#ui5.table.sortColumnAscending)
        * [.sortColumnDescending(columnName, tableSelector)](#ui5.table.sortColumnDescending)
        * [.clickSettingsButton(tableSelector)](#ui5.table.clickSettingsButton)
        * [.getTotalNumberOfRows(tableSelectorOrId)](#ui5.table.getTotalNumberOfRows) ⇒ <code>Number</code>
        * [.getTotalNumberOfRowsByValues(tableSelectorOrId, values, [index])](#ui5.table.getTotalNumberOfRowsByValues) ⇒ <code>Number</code>
        * [.getSelectorsForRowsByValues(tableSelectorOrId, values)](#ui5.table.getSelectorsForRowsByValues)
        * [.getSelectorForRowByIndex(tableSelectorOrId, index)](#ui5.table.getSelectorForRowByIndex)
        * [.selectRowByIndex(tableSelectorOrId, index)](#ui5.table.selectRowByIndex)
        * [.selectAllRows(tableSelectorOrId)](#ui5.table.selectAllRows)
        * [.deselectRowByIndex(tableSelectorOrId)](#ui5.table.deselectRowByIndex)
        * [.deselectAllRows(tableSelectorOrId)](#ui5.table.deselectAllRows)
        * [.selectRowByValues(tableSelectorOrId, values, [index])](#ui5.table.selectRowByValues)
        * [.openItemByIndex(tableSelectorOrId, index)](#ui5.table.openItemByIndex)
        * [.openItemByValues(tableSelectorOrId, values, [index])](#ui5.table.openItemByValues)
    * [.userInteraction](#ui5.userInteraction)
        * [.click(selector, [index], [timeout])](#ui5.userInteraction.click)
        * [.clickAndRetry(selector, [index], [timeout], [retries], [interval])](#ui5.userInteraction.clickAndRetry)
        * [.doubleClick(selector, [index], [timeout])](#ui5.userInteraction.doubleClick)
        * [.rightClick(selector, [index], [timeout])](#ui5.userInteraction.rightClick)
        * [.clickTab(selector, [index], [timeout])](#ui5.userInteraction.clickTab)
        * [.clickListItem(selector, [index], [timeout])](#ui5.userInteraction.clickListItem)
        * [.check(selector, [index], [timeout])](#ui5.userInteraction.check)
        * [.uncheck(selector, [index], [timeout])](#ui5.userInteraction.uncheck)
        * [.fill(selector, value, [index], [timeout])](#ui5.userInteraction.fill)
        * [.fillAndRetry(selector, value, [index], [timeout], [retries], [interval])](#ui5.userInteraction.fillAndRetry)
        * [.clear(selector, [index], [timeout])](#ui5.userInteraction.clear)
        * [.clearAndRetry(selector, [index], [timeout], [retries], [interval])](#ui5.userInteraction.clearAndRetry)
        * [.clearAndFill(selector, value, [index], [timeout])](#ui5.userInteraction.clearAndFill)
        * [.clearAndFillAndRetry(selector, value, [index], [timeout], [retries], [interval], [verify])](#ui5.userInteraction.clearAndFillAndRetry)
        * [.clearSmartFieldInput(selector, [index], [timeout])](#ui5.userInteraction.clearSmartFieldInput)
        * [.clearAndFillSmartFieldInput(selector, value, [index], [timeout])](#ui5.userInteraction.clearAndFillSmartFieldInput)
        * [.clearAndFillSmartFieldInputAndRetry(selector, value, [index], [timeout], [retries], [interval])](#ui5.userInteraction.clearAndFillSmartFieldInputAndRetry)
        * [.selectBox(selector, value, [index])](#ui5.userInteraction.selectBox)
        * [.selectComboBox(selector, value, [index])](#ui5.userInteraction.selectComboBox)
        * [.selectMultiComboBox(selector, values, [index])](#ui5.userInteraction.selectMultiComboBox)
        * [.clickSelectArrow(selector, [index])](#ui5.userInteraction.clickSelectArrow)
        * [.clickSelectArrowAndRetry(selector, [index], [retries], [interval])](#ui5.userInteraction.clickSelectArrowAndRetry)
        * [.selectFromTab(selector, value, [index], [timeout])](#ui5.userInteraction.selectFromTab)
        * [.mouseOverElement(selector, [index], [timeout])](#ui5.userInteraction.mouseOverElement)
        * [.scrollToElement(selector, [index], [alignment], [timeout])](#ui5.userInteraction.scrollToElement)
        * [.selectAll([selector], [index], [timeout])](#ui5.userInteraction.selectAll)
        * [.openF4Help(selector, [index], [timeout], useF4Key)](#ui5.userInteraction.openF4Help)
        * [.searchFor(selector, [index], [timeout], useEnter)](#ui5.userInteraction.searchFor)
        * [.resetSearch(selector, [index], [timeout])](#ui5.userInteraction.resetSearch)

<a name="ui5.assertion"></a>

### ui5.assertion
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.assertion](#ui5.assertion)
    * [.expectAttributeToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectAttributeToBe)
    * [.expectAttributeToContain(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectAttributeToContain)
    * [.expectTextToBe(selector, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectTextToBe)
    * [.expectValueToBe(selector, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectValueToBe)
    * [.expectValueToBeDefined(selector, [index], [timeout])](#ui5.assertion.expectValueToBeDefined)
    * [.expectToBeNotEnabled(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeNotEnabled)
    * [.expectToBeEnabled(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeEnabled)
    * [.expectValidationError(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectValidationError)
    * [.expectValidationSuccess(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectValidationSuccess)
    * [.expectCssPropertyValueToBe(selector, cssProperty, compareValue, [index], [timeout])](#ui5.assertion.expectCssPropertyValueToBe)
    * [.expectBindingPathToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectBindingPathToBe)
    * [.expectBindingContextPathToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectBindingContextPathToBe)
    * [.expectToBeVisible(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeVisible)
    * [.expectToBeVisibleInViewport(selector, [index], [timeout], [loadPropertyTimeout])](#ui5.assertion.expectToBeVisibleInViewport)
    * [.expectToBeNotVisible(selector, [index], [timeout])](#ui5.assertion.expectToBeNotVisible)
    * [.expectMessageToastTextToBe(text, [timeout])](#ui5.assertion.expectMessageToastTextToBe)

<a name="ui5.assertion.expectAttributeToBe"></a>

#### assertion.expectAttributeToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])
Expects the passed elements attribute to be the compare value.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| attribute | <code>String</code> |  | The attribute to be compared. |
| compareValue | <code>String</code> \| <code>Boolean</code> \| <code>Number</code> \| <code>Object</code> |  | The compare value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectAttributeToBe(selector, "text", "Hello");
```
<a name="ui5.assertion.expectAttributeToContain"></a>

#### assertion.expectAttributeToContain(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])
Expects the passed elements attribute to contain the compare value.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| attribute | <code>String</code> |  | The attribute to be compared. |
| compareValue | <code>String</code> |  | The compare value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectAttributeToContain(selector, "text", "abc");
```
<a name="ui5.assertion.expectTextToBe"></a>

#### assertion.expectTextToBe(selector, compareValue, [index], [timeout], [loadPropertyTimeout])
Expects the passed elements text attribute to be the compare value.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| compareValue | <code>String</code> |  | The compare value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectTextToBe(selector, "Hello");
```
<a name="ui5.assertion.expectValueToBe"></a>

#### assertion.expectValueToBe(selector, compareValue, [index], [timeout], [loadPropertyTimeout])
Expects the passed elements value attribute to be the compare value.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| compareValue | <code>String</code> \| <code>Number</code> |  | The compare value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectValueToBe(selector, "123");
```
<a name="ui5.assertion.expectValueToBeDefined"></a>

#### assertion.expectValueToBeDefined(selector, [index], [timeout])
Expects the passed elements value to be defined.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.assertion.expectValueToBeDefined(selector);
```
<a name="ui5.assertion.expectToBeNotEnabled"></a>

#### assertion.expectToBeNotEnabled(selector, [index], [timeout], [loadPropertyTimeout])
Expects that the element is not enabled to the user.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectToBeNotEnabled(selector);
```
<a name="ui5.assertion.expectToBeEnabled"></a>

#### assertion.expectToBeEnabled(selector, [index], [timeout], [loadPropertyTimeout])
Expects that the element is enabled to the user.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectToBeEnabled(selector);
```
<a name="ui5.assertion.expectValidationError"></a>

#### assertion.expectValidationError(selector, [index], [timeout], [loadPropertyTimeout])
Expects the "valueState" of the element to be "Error".

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectValidationError(selector);
```
<a name="ui5.assertion.expectValidationSuccess"></a>

#### assertion.expectValidationSuccess(selector, [index], [timeout], [loadPropertyTimeout])
Expects the valueState of the element to be "None".

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectValidationSuccess(selector);
```
<a name="ui5.assertion.expectCssPropertyValueToBe"></a>

#### assertion.expectCssPropertyValueToBe(selector, cssProperty, compareValue, [index], [timeout])
Expects the CSS property value of the passed element to be the compare value.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| cssProperty | <code>String</code> |  | The CSS property of the element to compare with. |
| compareValue | <code>String</code> |  | The compare value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there is more than one element visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.assertion.expectCssPropertyValueToBe(selector, "color", "rgb(255, 0, 0)");
```
<a name="ui5.assertion.expectBindingPathToBe"></a>

#### assertion.expectBindingPathToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])
Expects the passed elements attribute binding-path to contain the compare value

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| attribute | <code>String</code> |  | The attribute to be compared. |
| compareValue | <code>String</code> \| <code>Array.&lt;String&gt;</code> |  | The compare value(s). |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectBindingPathToBe(selector, "text", "Hello");
```
<a name="ui5.assertion.expectBindingContextPathToBe"></a>

#### assertion.expectBindingContextPathToBe(selector, attribute, compareValue, [index], [timeout], [loadPropertyTimeout])
Expects the passed elements binding-context-path to be the compare value.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| attribute | <code>String</code> |  | The attribute to be compared. |
| compareValue | <code>String</code> |  | The compare value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectBindingContextPathToBe(selector, "text", "Hello");
```
<a name="ui5.assertion.expectToBeVisible"></a>

#### assertion.expectToBeVisible(selector, [index], [timeout], [loadPropertyTimeout])
Expects that the element is visible to the user.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectToBeVisible(selector);
```
<a name="ui5.assertion.expectToBeVisibleInViewport"></a>

#### assertion.expectToBeVisibleInViewport(selector, [index], [timeout], [loadPropertyTimeout])
Expects that the element is visible in the viewport.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [loadPropertyTimeout] | <code>Number</code> | <code>10000</code> | The timeout to wait for a specific property to have the given compare value. |

**Example**  
```js
await ui5.assertion.expectToBeVisibleInViewport(selector);
```
<a name="ui5.assertion.expectToBeNotVisible"></a>

#### assertion.expectToBeNotVisible(selector, [index], [timeout])
Expects that the element is not visible to the user.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). Recommendation is to lower the timeout since the element is not expected to show up. |

**Example**  
```js
await ui5.assertion.expectToBeNotVisible(selector, 0, 5000);
```
<a name="ui5.assertion.expectMessageToastTextToBe"></a>

#### assertion.expectMessageToastTextToBe(text, [timeout])
Expects the message toast with the passed text.

**Kind**: static method of [<code>assertion</code>](#ui5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| text | <code>String</code> |  | The expected text. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.assertion.expectMessageToastTextToBe(text);
```
<a name="ui5.confirmationDialog"></a>

### ui5.confirmationDialog
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.confirmationDialog](#ui5.confirmationDialog)
    * [.clickButton(text, [timeout])](#ui5.confirmationDialog.clickButton)
    * [.clickOk([timeout])](#ui5.confirmationDialog.clickOk)
    * [.clickCancel([timeout])](#ui5.confirmationDialog.clickCancel)
    * [.clickYes([timeout])](#ui5.confirmationDialog.clickYes)
    * [.clickNo([timeout])](#ui5.confirmationDialog.clickNo)
    * [.clickCreate([timeout])](#ui5.confirmationDialog.clickCreate)
    * [.clickDelete([timeout])](#ui5.confirmationDialog.clickDelete)
    * [.clickRevokeApproval([timeout])](#ui5.confirmationDialog.clickRevokeApproval)

<a name="ui5.confirmationDialog.clickButton"></a>

#### confirmationDialog.clickButton(text, [timeout])
Clicks the button with the given text at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| text | <code>String</code> |  | The text of the button. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.confirmationDialog.clickButton("Ok");
```
<a name="ui5.confirmationDialog.clickOk"></a>

#### confirmationDialog.clickOk([timeout])
Clicks the "OK" button at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.confirmationDialog.clickOk();
```
<a name="ui5.confirmationDialog.clickCancel"></a>

#### confirmationDialog.clickCancel([timeout])
Clicks the "Cancel" button at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.confirmationDialog.clickCancel();
```
<a name="ui5.confirmationDialog.clickYes"></a>

#### confirmationDialog.clickYes([timeout])
Clicks the "Yes" button at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Description |
| --- | --- | --- |
| [timeout] | <code>Number</code> | The timeout to wait (default value: 30 sec). |

**Example**  
```js
await ui5.confirmationDialog.clickYes();
```
<a name="ui5.confirmationDialog.clickNo"></a>

#### confirmationDialog.clickNo([timeout])
Clicks the "Yes" button at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Description |
| --- | --- | --- |
| [timeout] | <code>Number</code> | The timeout to wait (default value: 30 sec). |

**Example**  
```js
await ui5.confirmationDialog.clickNo();
```
<a name="ui5.confirmationDialog.clickCreate"></a>

#### confirmationDialog.clickCreate([timeout])
Clicks the create button in the confirmation dialog

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Description |
| --- | --- | --- |
| [timeout] | <code>Number</code> | The timeout to wait (default value: 30 sec). |

**Example**  
```js
await ui5.confirmationDialog.clickCreate();
```
<a name="ui5.confirmationDialog.clickDelete"></a>

#### confirmationDialog.clickDelete([timeout])
Clicks the "Delete" button at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Description |
| --- | --- | --- |
| [timeout] | <code>Number</code> | The timeout to wait (default value: 30 sec). |

**Example**  
```js
await ui5.confirmationDialog.clickDelete();
```
<a name="ui5.confirmationDialog.clickRevokeApproval"></a>

#### confirmationDialog.clickRevokeApproval([timeout])
Clicks the "Revoke Approval" button at the confirmation dialog.

**Kind**: static method of [<code>confirmationDialog</code>](#ui5.confirmationDialog)  

| Param | Type | Description |
| --- | --- | --- |
| [timeout] | <code>Number</code> | The timeout to wait (default value: 30 sec). |

**Example**  
```js
await ui5.confirmationDialog.clickRevokeApproval();
```
<a name="ui5.control"></a>

### ui5.control
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.control](#ui5.control)
    * [.execute(callbackFunction, selectorOrElement, args)](#ui5.control.execute)
    * [.focus(selector, [index], [timeout])](#ui5.control.focus)
    * [.getProperty(selectorOrElement, propertyName)](#ui5.control.getProperty)
    * [.getAggregationProperty(selectorOrElement, propertyName)](#ui5.control.getAggregationProperty)
    * [.getAssociationProperty(selectorOrElement, propertyName)](#ui5.control.getAssociationProperty)
    * [.getBindingContextPathProperty(selectorOrElement)](#ui5.control.getBindingContextPathProperty)
    * [.getPropertyBinding(selectorOrElement, propertyName)](#ui5.control.getPropertyBinding) ⇒ <code>Array</code>

<a name="ui5.control.execute"></a>

#### control.execute(callbackFunction, selectorOrElement, args)
Executes a native UI5 action as callback function in the browser on the given UI5 control.

**Kind**: static method of [<code>control</code>](#ui5.control)  

| Param | Type | Description |
| --- | --- | --- |
| callbackFunction | <code>function</code> | The client script function to be used with the control instance. Caution: The first and last parameter is reserved for the mockserver instance and the promise resolve function - done. |
| selectorOrElement | <code>Element</code> \| <code>Ui5Selector</code> \| <code>Ui5SelectorWithOptions</code> | The selector object, selector with options (selector, index, timeout) or the dom element (retrieved from ui5.element.getDisplayed). |
| args | <code>Object</code> | An object containing the arguments to pass to the callback function. |

**Example**  
```js
const selector = {"elementProperties":{"metadata":"sap.m.StandardListItem", "id": "*categoryList-7"}};
const args = {"property": "text"};
const title = await ui5.control.execute(function (control, args, done) {
  done(control.getProperty(args.property));
}, selector, args);
```
<a name="ui5.control.focus"></a>

#### control.focus(selector, [index], [timeout])
Focuses on the element with the given selector to get it into view. If focus is not possible scrollToElement is used.

**Kind**: static method of [<code>control</code>](#ui5.control)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.control.focus(selector);
```
**Example**  
```js
await ui5.control.focus(selector, 0, 5000);
```
<a name="ui5.control.getProperty"></a>

#### control.getProperty(selectorOrElement, propertyName)
Gets the UI5 control property of the given element.

**Kind**: static method of [<code>control</code>](#ui5.control)  

| Param | Type | Description |
| --- | --- | --- |
| selectorOrElement | <code>Element</code> \| <code>Ui5Selector</code> \| <code>Ui5SelectorWithOptions</code> | The selector object, selector with options (selector, index, timeout) or the dom element (retrieved from ui5.element.getDisplayed) |
| propertyName | <code>String</code> | The property name of the control to retrieve the value from. |

**Example**  
```js
const selector = { "elementProperties":{"metadata":"sap.m.StandardListItem","mProperties":{ "title":[{"path":"CategoryName"}] }};
const elem = await ui5.element.getDisplayed(selector);
const propertyName = "title";
const val = await ui5.control.getProperty(elem, propertyName);
```
<a name="ui5.control.getAggregationProperty"></a>

#### control.getAggregationProperty(selectorOrElement, propertyName)
Gets the UI5 control aggregation property  of the given element.

**Kind**: static method of [<code>control</code>](#ui5.control)  

| Param | Type | Description |
| --- | --- | --- |
| selectorOrElement | <code>Element</code> \| <code>Ui5Selector</code> \| <code>Ui5SelectorWithOptions</code> | The selector object, selector with options (selector, index, timeout) or the dom element (retrieved from ui5.element.getDisplayed) |
| propertyName | <code>String</code> | The aggregation property name of the control to retrieve the value from. |

**Example**  
```js
const selector = { "elementProperties":{"metadata":"sap.m.StandardListItem","mProperties":{ "items":[{"path":"/Categories"}] }};
const elem = await ui5.element.getDisplayed(selector);
const propertyName = "tooltip";
const val = await ui5.control.getAggregationProperty(elem, propertyName);
```
<a name="ui5.control.getAssociationProperty"></a>

#### control.getAssociationProperty(selectorOrElement, propertyName)
Get UI control property

**Kind**: static method of [<code>control</code>](#ui5.control)  

| Param | Type | Description |
| --- | --- | --- |
| selectorOrElement | <code>Element</code> \| <code>Ui5Selector</code> \| <code>Ui5SelectorWithOptions</code> | The selector object, selector with options (selector, index, timeout) or the dom element (retrieved from ui5.element.getDisplayed) |
| propertyName | <code>String</code> | The association property name of the control to retrieve the value from. |

**Example**  
```js
const selector = { "elementProperties":{"metadata":"sap.m.MultiComboBox","mProperties":{}};
const elem = await ui5.element.getDisplayed(selector);
const propertyName = "selectedItems";
const propertyValue = await ui5.control.getAssociationProperty(elem, propertyName);
```
<a name="ui5.control.getBindingContextPathProperty"></a>

#### control.getBindingContextPathProperty(selectorOrElement)
Get UI control binding context path

**Kind**: static method of [<code>control</code>](#ui5.control)  

| Param | Type | Description |
| --- | --- | --- |
| selectorOrElement | <code>Element</code> \| <code>Ui5Selector</code> \| <code>Ui5SelectorWithOptions</code> | The selector object, selector with options (selector, index, timeout) or the dom element (retrieved from ui5.element.getDisplayed) |

**Example**  
```js
const selector = { "elementProperties":{"metadata":"sap.m.StandardListItem","mProperties":{"title":[{"path":"CategoryName"}] }};
const elem = await ui5.element.getDisplayed(selector);
const context = await ui5.control.getBindingContextPathProperty(elem);
```
<a name="ui5.control.getPropertyBinding"></a>

#### control.getPropertyBinding(selectorOrElement, propertyName) ⇒ <code>Array</code>
Get UI control property

**Kind**: static method of [<code>control</code>](#ui5.control)  
**Returns**: <code>Array</code> - Array of bindings for the specific property  

| Param | Type | Description |
| --- | --- | --- |
| selectorOrElement | <code>Element</code> \| <code>Ui5Selector</code> \| <code>Ui5SelectorWithOptions</code> | The selector object, selector with options (selector, index, timeout) or the dom element (retrieved from ui5.element.getDisplayed) |
| propertyName | <code>String</code> | The property name to retrieve from the control binding |

**Example**  
```js
const selector = { "elementProperties":{"metadata":"sap.m.StandardListItem","mProperties":{ "title":[{"path":"CategoryName"}] }};
const elem = await ui5.element.getDisplayed(selector);
const propertyName = "title";
const binding = await ui5.control.getPropertyBinding(elem, propertyName);
```
<a name="ui5.date"></a>

### ui5.date
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.date](#ui5.date)
    * [.pick(selector, date, [index])](#ui5.date.pick)
    * [.pickRange(selector, range, [index])](#ui5.date.pickRange)
    * [.pickWithTime(selector, date, [index])](#ui5.date.pickWithTime)
    * [.fillRange(selector, range, [index])](#ui5.date.fillRange)

<a name="ui5.date.pick"></a>

#### date.pick(selector, date, [index])
Picks the passed date using the "DatePicker" with the given selector.

**Kind**: static method of [<code>date</code>](#ui5.date)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Selector</code> |  | The selector describing the element. |
| date | <code>Date</code> |  | The date object. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
const today = await common.date.calculate("today");
await ui5.date.pick(selector, today);
```
<a name="ui5.date.pickRange"></a>

#### date.pickRange(selector, range, [index])
Picks the passed date range using the "DatePicker" with the given selector.
Note that this will only work within the current month!

**Kind**: static method of [<code>date</code>](#ui5.date)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Selector</code> |  | The selector describing the element. |
| range | <code>Array.&lt;Object&gt;</code> |  | The array of date objects containing start- and end date. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
const start = await common.date.calculate("2020, 9, 20");
const end = await common.date.calculate("2021, 1, 3");
const range = [start, end];
await ui5.date.pickRange(selector, range);
```
<a name="ui5.date.pickWithTime"></a>

#### date.pickWithTime(selector, date, [index])
Picks the passed date with time using the "DateTimePicker" with the given selector.

**Kind**: static method of [<code>date</code>](#ui5.date)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Selector</code> |  | The selector describing the element. |
| date | <code>Date</code> |  | The date object. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
const tomorrowMorning = await common.date.calculateWithTime("tomorrow", "09:30:45");
await ui5.date.pickWithTime(selector, tomorrowMorning);
```
<a name="ui5.date.fillRange"></a>

#### date.fillRange(selector, range, [index])
Enters the passed date range to the date input with the given selector by providing the start- and end date.

**Kind**: static method of [<code>date</code>](#ui5.date)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Selector</code> |  | The selector describing the element. |
| range | <code>Array.&lt;Object&gt;</code> |  | The array of date objects containing start- and end date. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
const start = await common.date.calculate("2020, 9, 20", "dd.mm.yyyy");
const end = await common.date.calculate("2021, 1, 3", "dd.mm.yyyy");
const range = [start, end];
await ui5.date.fillRange(selector, range);
```
<a name="ui5.element"></a>

### ui5.element
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.element](#ui5.element)
    * [.waitForAll(selector, [timeout])](#ui5.element.waitForAll)
    * [.getAllDisplayed(selector, [timeout])](#ui5.element.getAllDisplayed) ⇒ <code>Array.&lt;Object&gt;</code>
    * [.getDisplayed(selector, [index], [timeout])](#ui5.element.getDisplayed) ⇒ <code>Object</code>
    * [.getByText(selector, value, [index], [timeout])](#ui5.element.getByText) ⇒ <code>Object</code>
    * [.getByChild(elementSelector, childSelector, [index], [timeout])](#ui5.element.getByChild) ⇒ <code>Object</code>
    * [.getByParent(elementSelector, parentSelector, [index], [timeout])](#ui5.element.getByParent) ⇒ <code>Object</code>
    * [.getId(selector, [index], [timeout])](#ui5.element.getId) ⇒ <code>String</code>
    * [.getPropertyValue(selector, property, [index], [timeout])](#ui5.element.getPropertyValue) ⇒ <code>any</code>
    * [.getValue(selector, [index], [timeout])](#ui5.element.getValue) ⇒ <code>String</code>
    * [.getCssPropertyValue(selector, cssProperty, [index], [timeout])](#ui5.element.getCssPropertyValue) ⇒ <code>String</code>
    * [.getBindingValue(selector, bindingContext, [index], [timeout])](#ui5.element.getBindingValue) ⇒ <code>String</code>
    * [.isVisible(selector, [index], [timeout])](#ui5.element.isVisible) ⇒ <code>Boolean</code>
    * [.highlight(selector, [duration], [color])](#ui5.element.highlight)

<a name="ui5.element.waitForAll"></a>

#### element.waitForAll(selector, [timeout])
Waits for all elements matching the given selector.

**Kind**: static method of [<code>element</code>](#ui5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the elements. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.element.waitForAll(selector);
```
<a name="ui5.element.getAllDisplayed"></a>

#### element.getAllDisplayed(selector, [timeout]) ⇒ <code>Array.&lt;Object&gt;</code>
Returns the visible elements with the given selector.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>Array.&lt;Object&gt;</code> - - The found elements.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the elements. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await ui5.element.getAllDisplayed(selector);
```
<a name="ui5.element.getDisplayed"></a>

#### element.getDisplayed(selector, [index], [timeout]) ⇒ <code>Object</code>
Returns the visible element.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await ui5.element.getDisplayed(selector);
```
<a name="ui5.element.getByText"></a>

#### element.getByText(selector, value, [index], [timeout]) ⇒ <code>Object</code>
Returns the element with the given selector and text value.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The text value of the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await ui5.element.getByText(selector, "Home");
```
<a name="ui5.element.getByChild"></a>

#### element.getByChild(elementSelector, childSelector, [index], [timeout]) ⇒ <code>Object</code>
Gets an element by its selector and child selector.
Can be used as unique combination between element and child properties when multiple elements have the same properties.
Note: For nested selectors, all properties except of the "elementProperties" are being ignored.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementSelector | <code>String</code> |  | The selector describing the requested element. |
| childSelector | <code>String</code> |  | The selector describing a child element of the requested element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case the combination applies to more than one element). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elementSelector = {
 "elementProperties": {...}
};
const childSelector = {
 "elementProperties": {...}
};
const elem = await ui5.element.getByChild(elementSelector, childSelector);
```
<a name="ui5.element.getByParent"></a>

#### element.getByParent(elementSelector, parentSelector, [index], [timeout]) ⇒ <code>Object</code>
Gets an element by its selector and parent selector.
Can be used as unique combination between element and parent properties when multiple elements have the same properties.
Note: For nested selectors, all properties except of the "elementProperties" are being ignored.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementSelector | <code>String</code> |  | The selector describing the requested element. |
| parentSelector | <code>String</code> |  | The selector describing the parent element of the requested element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case the combination applies to more than one element). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elementSelector = {
 "elementProperties": {...}
};
const parentSelector = {
 "elementProperties": {...}
};
const elem = await ui5.element.getByParent(elementSelector, parentSelector);
```
<a name="ui5.element.getId"></a>

#### element.getId(selector, [index], [timeout]) ⇒ <code>String</code>
Returns the id of the element with the given selector.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>String</code> - The id of the element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elemId = await ui5.element.getId(selector);
```
<a name="ui5.element.getPropertyValue"></a>

#### element.getPropertyValue(selector, property, [index], [timeout]) ⇒ <code>any</code>
Returns the UI5 property value of the passed element.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>any</code> - The property value of the element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| property | <code>String</code> |  | The property of the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elemValue = await ui5.element.getPropertyValue(selector, "text");
```
<a name="ui5.element.getValue"></a>

#### element.getValue(selector, [index], [timeout]) ⇒ <code>String</code>
Returns the inner value of the passed element.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>String</code> - The value of the element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elemValue = await ui5.element.getValue(selector);
```
<a name="ui5.element.getCssPropertyValue"></a>

#### element.getCssPropertyValue(selector, cssProperty, [index], [timeout]) ⇒ <code>String</code>
Returns the value of the passed CSS property of the element.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>String</code> - The value of the CSS property.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| cssProperty | <code>String</code> |  | The CSS property of the element to get value. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const cssPropertyValue = await ui5.element.getCssPropertyValue(selector, "visibility");
```
<a name="ui5.element.getBindingValue"></a>

#### element.getBindingValue(selector, bindingContext, [index], [timeout]) ⇒ <code>String</code>
Returns the value of the given binding property for a specific element.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>String</code> - The binding property value.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| bindingContext | <code>String</code> |  | The binding property to retrieve. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elemBindingValue = await ui5.element.getBindingValue(selector, "InvoiceGrossAmount");
```
<a name="ui5.element.isVisible"></a>

#### element.isVisible(selector, [index], [timeout]) ⇒ <code>Boolean</code>
Determines if the element is visible.

**Kind**: static method of [<code>element</code>](#ui5.element)  
**Returns**: <code>Boolean</code> - The bool value 'true' or 'false' if the element is visible or not.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const isVisible = await ui5.element.isVisible(selector);
```
<a name="ui5.element.highlight"></a>

#### element.highlight(selector, [duration], [color])
Highlights the element with the given selector.

**Kind**: static method of [<code>element</code>](#ui5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [duration] | <code>Number</code> | <code>2000</code> | The duration of the highlighting (ms). |
| [color] | <code>String</code> | <code>&quot;red&quot;</code> | The color of the highlighting (CSS color). |

**Example**  
```js
await ui5.element.highlight(selector, 3000, "green");
```
<a name="ui5.errorDialog"></a>

### ui5.errorDialog
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.errorDialog](#ui5.errorDialog)
    * [.expectToBeVisible()](#ui5.errorDialog.expectToBeVisible)
    * [.clickClose()](#ui5.errorDialog.clickClose)

<a name="ui5.errorDialog.expectToBeVisible"></a>

#### errorDialog.expectToBeVisible()
Expects that the error dialog is visible on the page.

**Kind**: static method of [<code>errorDialog</code>](#ui5.errorDialog)  
**Example**  
```js
await ui5.errorDialog.expectToBeVisible();
```
<a name="ui5.errorDialog.clickClose"></a>

#### errorDialog.clickClose()
Clicks the 'Close' button at the error dialog.

**Kind**: static method of [<code>errorDialog</code>](#ui5.errorDialog)  
**Example**  
```js
await ui5.errorDialog.clickClose();
```
<a name="ui5.footerBar"></a>

### ui5.footerBar
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.footerBar](#ui5.footerBar)
    * [.clickButton(text, [timeout])](#ui5.footerBar.clickButton)
    * [.clickApply([timeout])](#ui5.footerBar.clickApply)
    * [.clickSave([timeout])](#ui5.footerBar.clickSave)
    * [.clickCreate([timeout])](#ui5.footerBar.clickCreate)
    * [.clickCancel([timeout])](#ui5.footerBar.clickCancel)
    * [.clickCheck([timeout])](#ui5.footerBar.clickCheck)
    * [.clickOrder([timeout])](#ui5.footerBar.clickOrder)
    * [.clickPost([timeout])](#ui5.footerBar.clickPost)
    * [.clickAdd([timeout])](#ui5.footerBar.clickAdd)

<a name="ui5.footerBar.clickButton"></a>

#### footerBar.clickButton(text, [timeout])
Clicks the button with the given text at the footer bar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| text | <code>String</code> |  | The text of the button. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickButton("Ok");
```
<a name="ui5.footerBar.clickApply"></a>

#### footerBar.clickApply([timeout])
Clicks the 'Apply' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickApply();
```
<a name="ui5.footerBar.clickSave"></a>

#### footerBar.clickSave([timeout])
Clicks the 'Save' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickSave();
```
<a name="ui5.footerBar.clickCreate"></a>

#### footerBar.clickCreate([timeout])
Clicks the 'Create' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickCreate();
```
<a name="ui5.footerBar.clickCancel"></a>

#### footerBar.clickCancel([timeout])
Clicks the 'Cancel' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickCancel();
```
<a name="ui5.footerBar.clickCheck"></a>

#### footerBar.clickCheck([timeout])
Clicks the 'Check' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickCheck();
```
<a name="ui5.footerBar.clickOrder"></a>

#### footerBar.clickOrder([timeout])
Clicks the 'Order' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickOrder();
```
<a name="ui5.footerBar.clickPost"></a>

#### footerBar.clickPost([timeout])
Clicks the 'Post' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickPost();
```
<a name="ui5.footerBar.clickAdd"></a>

#### footerBar.clickAdd([timeout])
Clicks the 'Add' button at the footer toolbar.

**Kind**: static method of [<code>footerBar</code>](#ui5.footerBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.footerBar.clickAdd();
```
<a name="ui5.mockserver"></a>

### ui5.mockserver
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.mockserver](#ui5.mockserver)
    * [.waitForUi5ApplicationLoad()](#ui5.mockserver.waitForUi5ApplicationLoad)
    * [.interactWithMockServer(mockServerPath, fnCallback, oParams)](#ui5.mockserver.interactWithMockServer)
    * [.attachFunctionBefore(method, mockServerPath, fnBeforeCallback, oParams)](#ui5.mockserver.attachFunctionBefore)
    * [.attachFunctionAfter(method, mockServerPath, fnAfterCallback, oParams)](#ui5.mockserver.attachFunctionAfter)
    * [.addNewRequest(method, mockServerPath, urlPathRegex, responseJsonPath, returnCode, isText, responseMessages, responseLocation)](#ui5.mockserver.addNewRequest)
    * [.removeRequest(method, mockServerPath, urlPathRegex)](#ui5.mockserver.removeRequest)
    * [.addOrOverrideRequest(method, mockServerPath, urlPathRegex, responseJsonPath, returnCode, isText, responseMessages, responseLocation)](#ui5.mockserver.addOrOverrideRequest)
    * [.startMockServer(mockServerPath)](#ui5.mockserver.startMockServer)
    * [.initMockServer(mockServerPath, mockServerOptions)](#ui5.mockserver.initMockServer)
    * [.initApplication(mockServerPath)](#ui5.mockserver.initApplication)
    * [.stopMockServer(mockServerPath)](#ui5.mockserver.stopMockServer)
    * [.loadMockDataFile(filePath, isText)](#ui5.mockserver.loadMockDataFile) ⇒ <code>String</code>
    * [.getEntitySetData(mockServerPath, entitySetName)](#ui5.mockserver.getEntitySetData) ⇒ <code>Array</code>
    * [.setEntitySetData(mockServerPath, entitySetName, entries)](#ui5.mockserver.setEntitySetData)

<a name="ui5.mockserver.waitForUi5ApplicationLoad"></a>

#### mockserver.waitForUi5ApplicationLoad()
Waits for the UI5 framework to load and makes sure XHR request finished und busy indicators are not visible anymore.

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  
**Example**  
```js
await ui5.mockserver.waitForUi5ApplicationLoad(100);
```
<a name="ui5.mockserver.interactWithMockServer"></a>

#### mockserver.interactWithMockServer(mockServerPath, fnCallback, oParams)
Execute client script function to enable interaction with mockserver instance [you can write code in ui5 app context]

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver instance |
| fnCallback | <code>String</code> \| <code>Object</code> | The client script function that you can use to interact with your mockserver instance. [Caution] The first and last parameter is reserved (1st param is the mockserver instance and last parameter the promise resolve function - done) |
| oParams | <code>String</code> | Additional parameters you would like to inject in your client script function |

**Example**  
```js
await ui5.mockserver.interactWithMockServer("path/to/project/localService/main/mockserver", fnCallback, oParams);
```
<a name="ui5.mockserver.attachFunctionBefore"></a>

#### mockserver.attachFunctionBefore(method, mockServerPath, fnBeforeCallback, oParams)
Attaches a callback function in mockserver attachBefore event to be executed

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| method | <code>String</code> | The attachAfter http method [GET or POST]. |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method so the mockserver instance can be consumed]. |
| fnBeforeCallback | <code>String</code> \| <code>Object</code> | The callback function to be used in the native attachBefore method as described (https://ui5.sap.com/#/api/sap.ui.core.ui5.mockserver%23methods/Summary) |
| oParams | <code>Object</code> | Additional parameters you would like to inject in your client script function |

**Example**  
```js
await ui5.mockserver.attachFunctionBefore("GET", "path/to/project/localService/main/mockserver", fnBeforeCallback, oParams);
```
<a name="ui5.mockserver.attachFunctionAfter"></a>

#### mockserver.attachFunctionAfter(method, mockServerPath, fnAfterCallback, oParams)
Attaches a callback function in mockserver attachAfter event to be executed

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| method | <code>String</code> | The attachAfter http method [GET or POST]. |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method so the mockserver instance can be consumed]. |
| fnAfterCallback | <code>String</code> \| <code>Object</code> | The callback function to be used in the native attachAfter method as described (https://ui5.sap.com/#/api/sap.ui.core.ui5.mockserver%23methods/Summary) |
| oParams | <code>Object</code> | Additional parameters you would like to inject in your client script function |

**Example**  
```js
await ui5.mockserver.attachFunctionAfter("GET", "path/to/project/localService/main/mockserver",  fnAfterCallback);
```
<a name="ui5.mockserver.addNewRequest"></a>

#### mockserver.addNewRequest(method, mockServerPath, urlPathRegex, responseJsonPath, returnCode, isText, responseMessages, responseLocation)
Adds new mock request

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| method | <code>String</code> | The http method [GET,POST..]. |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| urlPathRegex | <code>String</code> | The url path regex to filter the requests |
| responseJsonPath | <code>String</code> | The json object or the path to your json file to be used as response [use relative path from the html page started]. |
| returnCode | <code>Integer</code> | The http response code to simulate for this mock request. |
| isText | <code>Boolean</code> | If true then content type is text/plain otherwise application/json. |
| responseMessages | <code>String</code> | Mocks the gw sap-message response messages [Don't forget to stringify your json before: JSON.stringify(msg)] |
| responseLocation | <code>String</code> | Mocks the location response messages header |

**Example**  
```js
await ui5.mockserver.addNewRequest("GET","path/to/project/localService/main/mockserver", "*.Headers.*", "path/to/project/localService/main/mockdata/test.json", 200, true, JSON.stringify(msg));
```
<a name="ui5.mockserver.removeRequest"></a>

#### mockserver.removeRequest(method, mockServerPath, urlPathRegex)
Removes request mock [Doesn't work currently - Mockserver bug]

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| method | <code>String</code> | The http method [GET,POST..]. |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| urlPathRegex | <code>String</code> | The url path regex to filter the requests |

**Example**  
```js
await ui5.mockserver.removeRequest("GET","path/to/project/localService/main/mockserver", "*.Headers.*");
```
<a name="ui5.mockserver.addOrOverrideRequest"></a>

#### mockserver.addOrOverrideRequest(method, mockServerPath, urlPathRegex, responseJsonPath, returnCode, isText, responseMessages, responseLocation)
Adds new or overrides an existing mock request

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| method | <code>String</code> | The http method [GET,POST..]. |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| urlPathRegex | <code>String</code> | The url path regex to filter the requests |
| responseJsonPath | <code>String</code> | The json object or the path to your json file to be used as response [use relative path from the html page started]. |
| returnCode | <code>Integer</code> | The http response code to simulate for this mock request. |
| isText | <code>Boolean</code> | If true then content type is text/plain otherwise application/json. |
| responseMessages | <code>String</code> | Mocks the gw sap-message response messages [Don't forget to stringify your json before: JSON.stringify(msg)] |
| responseLocation | <code>String</code> | Mocks the location response messages header |

**Example**  
```js
await ui5.mockserver.addOrOverrideRequest("GET","path/to/project/localService/main/mockserver", "*.Headers.*", "path/to/project/localService/main/mockdata/test.json", 200, true, JSON.stringify(msg));
```
<a name="ui5.mockserver.startMockServer"></a>

#### mockserver.startMockServer(mockServerPath)
(Re-)Starts mock server instance

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |

**Example**  
```js
await ui5.mockserver.startMockServer("path/to/project/localService/main/mockserver");
```
<a name="ui5.mockserver.initMockServer"></a>

#### mockserver.initMockServer(mockServerPath, mockServerOptions)
Initializes the provide mockserver instance on the fly

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| mockServerOptions | <code>String</code> | The mock server options |

**Example**  
```js
await ui5.mockserver.initMockServer("path/to/project/localService/main/mockserver", mockServerOptions);
```
<a name="ui5.mockserver.initApplication"></a>

#### mockserver.initApplication(mockServerPath)
Initializes the application [Used in the beggining of script, once the mockserver is fully initialized and request mocking is done]

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |

**Example**  
```js
await ui5.mockserver.initApplication("path/to/project/localService/main/mockserver");
```
<a name="ui5.mockserver.stopMockServer"></a>

#### mockserver.stopMockServer(mockServerPath)
Stops the mockserver instance

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |

**Example**  
```js
await ui5.mockserver.stopMockServer("path/to/project/localService/main/mockserver");
```
<a name="ui5.mockserver.loadMockDataFile"></a>

#### mockserver.loadMockDataFile(filePath, isText) ⇒ <code>String</code>
Loads a mock data file

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  
**Returns**: <code>String</code> - The json object  

| Param | Type | Description |
| --- | --- | --- |
| filePath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| isText | <code>Boolean</code> | If true then content type is text/plain otherwise application/json. |

**Example**  
```js
await ui5.mockserver.loadMockDataFile("path/to/project/mockData/myData.json", true);
```
<a name="ui5.mockserver.getEntitySetData"></a>

#### mockserver.getEntitySetData(mockServerPath, entitySetName) ⇒ <code>Array</code>
Retrieves entity data

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  
**Returns**: <code>Array</code> - An array of json objects  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| entitySetName | <code>String</code> | The entity set name |

**Example**  
```js
await ui5.mockserver.getEntitySetData("path/to/project/localService/main/mockserver", "Headers");
```
<a name="ui5.mockserver.setEntitySetData"></a>

#### mockserver.setEntitySetData(mockServerPath, entitySetName, entries)
Override entity data entries

**Kind**: static method of [<code>mockserver</code>](#ui5.mockserver)  

| Param | Type | Description |
| --- | --- | --- |
| mockServerPath | <code>String</code> | The full path to your mockserver file [make sure you implemented getMockServer method in this file to return the mockserver instance]. |
| entitySetName | <code>String</code> | The entity name |
| entries | <code>String</code> | The json object to be used as data to be inserted [use relative path from the html page started]. |

**Example**  
```js
await ui5.mockserver.setEntitySetData("path/to/project/localService/main/mockserver", "Headers", entries);
```
<a name="ui5.navigation"></a>

### ui5.navigation
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.navigation](#ui5.navigation)
    * [.navigateToApplication(intent, [preventPopups], [verify], [refresh])](#ui5.navigation.navigateToApplication)
    * [.navigateToApplicationAndRetry(intent, [preventPopups], [verify], [retries], [interval])](#ui5.navigation.navigateToApplicationAndRetry)
    * [.navigateToSystemAndApplication(system, intent, [closePopups], [verify])](#ui5.navigation.navigateToSystemAndApplication)
    * [.navigateToSystemAndApplicationAndRetry(system, intent, [closePopups], [verify], [retries], [interval])](#ui5.navigation.navigateToSystemAndApplicationAndRetry)
    * [.navigateToApplicationWithQueryParams(intent, queryParams, [preventPopups], [verify])](#ui5.navigation.navigateToApplicationWithQueryParams)
    * [.navigateToApplicationWithQueryParamsAndRetry(intent, queryParams, [preventPopups], [verify], [retries], [interval])](#ui5.navigation.navigateToApplicationWithQueryParamsAndRetry)
    * [.closePopups([timeout])](#ui5.navigation.closePopups)
    * [.expectUnsupportedNavigationPopup(navigationTarget)](#ui5.navigation.expectUnsupportedNavigationPopup)

<a name="ui5.navigation.navigateToApplication"></a>

#### navigation.navigateToApplication(intent, [preventPopups], [verify], [refresh])
Navigates to the application via the passed intent. The intent will be added to the baseUrl maintained in the config.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| intent | <code>String</code> |  | The intent of the application. |
| [preventPopups] | <code>Boolean</code> | <code>false</code> | Specifies if random popup appearance should be prevented. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the url should be asserted after the navigation. |
| [refresh] | <code>Boolean</code> | <code>false</code> | Refresh the page after navigation. |

**Example**  
```js
await ui5.navigation.navigateToApplication("PurchaseOrder-manage");
```
<a name="ui5.navigation.navigateToApplicationAndRetry"></a>

#### navigation.navigateToApplicationAndRetry(intent, [preventPopups], [verify], [retries], [interval])
Navigates to the application via the passed intent, and retries in case it fails.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| intent | <code>String</code> |  | The intent of the app. |
| [preventPopups] | <code>Boolean</code> | <code>false</code> | Specifies if random popup appearance should be prevented. Might not work for specific popups. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the url should be asserted after the navigation. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.navigation.navigateToApplicationAndRetry("PurchaseOrder-manage");
```
<a name="ui5.navigation.navigateToSystemAndApplication"></a>

#### navigation.navigateToSystemAndApplication(system, intent, [closePopups], [verify])
Navigates within the passed system to the application via the passed intent.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| system | <code>String</code> |  | The system url. |
| intent | <code>String</code> |  | The intent of the application. |
| [closePopups] | <code>Boolean</code> | <code>false</code> | Specifies if random popups should be closed after the navigation. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the url should be asserted after the navigation. |

**Example**  
```js
await ui5.navigation.navigateToSystemAndApplication("yourFioriLaunchpad.domain", "PurchaseOrder-manage");
```
<a name="ui5.navigation.navigateToSystemAndApplicationAndRetry"></a>

#### navigation.navigateToSystemAndApplicationAndRetry(system, intent, [closePopups], [verify], [retries], [interval])
Navigates within the passed system to the application via the passed intent, and retries in case it fails.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| system | <code>String</code> |  | The system url. |
| intent | <code>String</code> |  | The intent of the application. |
| [closePopups] | <code>Boolean</code> | <code>false</code> | Specifies if random popups should be closed after the navigation. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the url should be asserted after the navigation. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.navigation.navigateToSystemAndApplicationAndRetry("yourFioriLaunchpad.domain", "PurchaseOrder-manage");
```
<a name="ui5.navigation.navigateToApplicationWithQueryParams"></a>

#### navigation.navigateToApplicationWithQueryParams(intent, queryParams, [preventPopups], [verify])
Navigates to the application with the passed queryParams via the passed intent.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| intent | <code>String</code> |  | The intent of the app. |
| queryParams | <code>String</code> |  | [OPTIONAL] Add url query params. |
| [preventPopups] | <code>Boolean</code> | <code>false</code> | Specifies if random popup appearance should be prevented. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the url should be asserted after the navigation. |

**Example**  
```js
const intent = "PurchaseOrder-manage"
const queryParams = "?sap-language=EN&responderOn=true";
await ui5.navigation.navigateToApplicationWithQueryParams(intent, queryParams);
```
<a name="ui5.navigation.navigateToApplicationWithQueryParamsAndRetry"></a>

#### navigation.navigateToApplicationWithQueryParamsAndRetry(intent, queryParams, [preventPopups], [verify], [retries], [interval])
Navigates to the application via the passed intent, and retries in case it fails.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| intent | <code>String</code> |  | The intent of the app. |
| queryParams | <code>String</code> |  | [OPTIONAL] Add url query params. |
| [preventPopups] | <code>Boolean</code> | <code>false</code> | Specifies if random popup appearance should be prevented. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the url should be asserted after the navigation. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
const intent = "PurchaseOrder-manage"
const queryParams = "?sap-language=EN&responderOn=true";
await ui5.navigation.navigateToApplicationWithQueryParamsAndRetry(intent, queryParams);
```
<a name="ui5.navigation.closePopups"></a>

#### navigation.closePopups([timeout])
Closes all popups if they occur after navigating to a specific page.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait. |

**Example**  
```js
await ui5.navigation.closePopups();
```
<a name="ui5.navigation.expectUnsupportedNavigationPopup"></a>

#### navigation.expectUnsupportedNavigationPopup(navigationTarget)
Expects navigation to an app that is not supported.
This can be the case for Mocked tests when the application does not exist or when the app is not included in a role.

**Kind**: static method of [<code>navigation</code>](#ui5.navigation)  

| Param | Type | Description |
| --- | --- | --- |
| navigationTarget | <code>String</code> | The selector describing the element. |

**Example**  
```js
await ui5.navigation.expectUnsupportedNavigationPopup("#SupplierInvoice-display?FiscalYear=1234&SupplierInvoice=1234567890");
```
<a name="ui5.navigationBar"></a>

### ui5.navigationBar
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.navigationBar](#ui5.navigationBar)
    * [.clickBack([timeout])](#ui5.navigationBar.clickBack)
    * [.clickSapLogo([timeout])](#ui5.navigationBar.clickSapLogo)
    * [.clickUserIcon([timeout])](#ui5.navigationBar.clickUserIcon)
    * [.expectPageTitle(compareValue)](#ui5.navigationBar.expectPageTitle)
    * [.expectShellHeader([timeout])](#ui5.navigationBar.expectShellHeader)

<a name="ui5.navigationBar.clickBack"></a>

#### navigationBar.clickBack([timeout])
Navigates one layer back.

**Kind**: static method of [<code>navigationBar</code>](#ui5.navigationBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.navigationBar.clickBack();
```
<a name="ui5.navigationBar.clickSapLogo"></a>

#### navigationBar.clickSapLogo([timeout])
Clicks at the SAP Logo.

**Kind**: static method of [<code>navigationBar</code>](#ui5.navigationBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.navigationBar.clickSapLogo();
```
<a name="ui5.navigationBar.clickUserIcon"></a>

#### navigationBar.clickUserIcon([timeout])
Clicks at the Account Icon.

**Kind**: static method of [<code>navigationBar</code>](#ui5.navigationBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.navigationBar.clickUserIcon();
```
<a name="ui5.navigationBar.expectPageTitle"></a>

#### navigationBar.expectPageTitle(compareValue)
Expects the page title of the current page to be the compare value.

**Kind**: static method of [<code>navigationBar</code>](#ui5.navigationBar)  

| Param | Type | Description |
| --- | --- | --- |
| compareValue | <code>String</code> | The compare value. |

**Example**  
```js
await ui5.navigationBar.expectPageTitle("Home");
```
<a name="ui5.navigationBar.expectShellHeader"></a>

#### navigationBar.expectShellHeader([timeout])
Expects the shell header to be visible

**Kind**: static method of [<code>navigationBar</code>](#ui5.navigationBar)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.navigationBar.expectShellHeader();
```
<a name="ui5.qunit"></a>

### ui5.qunit
**Kind**: static class of [<code>ui5</code>](#ui5)  
<a name="ui5.qunit.executeTests"></a>

#### qunit.executeTests(path)
Executes QUnit & OPA5 tests. Qmate acts like a runner.

**Kind**: static method of [<code>qunit</code>](#ui5.qunit)  

| Param | Type | Description |
| --- | --- | --- |
| path | <code>String</code> | Relative path to the QUnit/OPA5 html file. |

**Example**  
```js
await ui5.qunit.executeTests("path/to/qunit.html");
```
<a name="ui5.session"></a>

### ui5.session
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.session](#ui5.session)
    * [.login(username, [password], [verify], [timeout])](#ui5.session.login)
    * [.loginFiori(username, [password], [verify])](#ui5.session.loginFiori)
    * [.loginSapCloud(username, [password], [verify])](#ui5.session.loginSapCloud)
    * [.loginCustom(username, [password], usernameFieldSelector, passwordFieldSelector, logonButtonSelector, [verify])](#ui5.session.loginCustom)
    * [.loginCustomViaConfig(username, [password], [verify])](#ui5.session.loginCustomViaConfig)
    * [.logout([verify])](#ui5.session.logout)
    * [.switchUser(username, [password], [authenticator], [wait])](#ui5.session.switchUser)
    * [.expectLogoutText()](#ui5.session.expectLogoutText)

<a name="ui5.session.login"></a>

#### session.login(username, [password], [verify], [timeout])
Login with specific username and password. This function works for both fiori and sap-cloud login.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. |
| [password] | <code>String</code> |  | The password. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the function will check the shell header after logging in. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.session.login("PURCHASER");
```
**Example**  
```js
await ui5.session.login("JOHN_DOE", "abc123!", true);
```
<a name="ui5.session.loginFiori"></a>

#### session.loginFiori(username, [password], [verify])
Login with fioriForm and specific username and password.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. |
| [password] | <code>String</code> |  | The password. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the function will check the shell header after logging in. |

**Example**  
```js
await ui5.session.loginFiori("john", "abc123!");
```
<a name="ui5.session.loginSapCloud"></a>

#### session.loginSapCloud(username, [password], [verify])
Login with sapCloud form and specific username and password.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. |
| [password] | <code>String</code> |  | The password. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the function will check the shell header after logging in. |

**Example**  
```js
await ui5.session.loginSapCloud("john", "abc123!");
```
<a name="ui5.session.loginCustom"></a>

#### session.loginCustom(username, [password], usernameFieldSelector, passwordFieldSelector, logonButtonSelector, [verify])
Login with custom form and specific username and password.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. |
| [password] | <code>String</code> | <code>&quot;super-duper-sensitive-pw&quot;</code> | The password. |
| usernameFieldSelector | <code>String</code> |  | The CSS selector of the username field. |
| passwordFieldSelector | <code>String</code> |  | The CSS selector of the password field. |
| logonButtonSelector | <code>String</code> |  | The CSS selector of the login button. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the function will check the shell header after logging in. |

**Example**  
```js
await ui5.session.loginCustom("JOHN_DOE", "abc123!", "#username", #password, "#logon");
```
<a name="ui5.session.loginCustomViaConfig"></a>

#### session.loginCustomViaConfig(username, [password], [verify])
Login with specific username and password. The selectors will be taken from the config.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. Can be specified in spec or config. If specified in both credentials will be taken from config. |
| [password] | <code>String</code> |  | The password. Can be specified in spec or config. If specified in both credentials will be taken from config. |
| [verify] | <code>Boolean</code> | <code>false</code> | Specifies if the function will check the shell header after logging in. |

**Example**  
```js
// config - SAMPLE 1
      auth: {
        formType: 'plain',
        usernameFieldSelector: "#USERNAME_BLOCK input",
        passwordFieldSelector: "#PASSWORD_BLOCK input",
        logonButtonSelector: "#LOGIN_LINK"
      },
      // spec
      await ui5.session.loginCustomViaConfig("JOHN_DOE", "abc123!");
  
  
      // config - SAMPLE 2
      auth: {
        formType: "plain",
        username: "PURCH_EXT",
        password: "super-duper-sensitive-pw",
        usernameFieldSelector: "#USERNAME_BLOCK input",
        passwordFieldSelector: "#PASSWORD_BLOCK input",
        logonButtonSelector: "#LOGIN_LINK"
      },
      // spec
      await ui5.session.loginCustomViaConfig();
```
<a name="ui5.session.logout"></a>

#### session.logout([verify])
Logs the user out.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [verify] | <code>Boolean</code> | <code>&quot;true&quot;</code> | Specifies if the function will check the logout text after logging out. Set this to false if the system does not show the text after logging out. |

**Example**  
```js
await ui5.session.logout();
```
<a name="ui5.session.switchUser"></a>

#### session.switchUser(username, [password], [authenticator], [wait])
switches the user according to the passed username and password.

**Kind**: static method of [<code>session</code>](#ui5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. |
| [password] | <code>String</code> |  | The password. |
| [authenticator] | <code>Object</code> |  | The login form type. Set to null to use generic login. |
| [wait] | <code>Number</code> | <code>10000</code> | The waiting time between logout and login (ms). |

**Example**  
```js
await ui5.session.switchUser("PURCHASER");
```
**Example**  
```js
const authenticator = ui5.authenticators.fioriForm;
await ui5.session.switchUser("PURCHASER", "super-duper-sensitive-pw", authenticator, 30000);
```
<a name="ui5.session.expectLogoutText"></a>

#### session.expectLogoutText()
Expects the logout text after logout to be "You have been logged off.
This is essential for chaining scripts, so that no static browser sleep in the spec itself is required anymore.

**Kind**: static method of [<code>session</code>](#ui5.session)  
**Example**  
```js
await ui5.session.expectLogoutText();
```
<a name="ui5.table"></a>

### ui5.table
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.table](#ui5.table)
    * [.sortColumnAscending(columnName, tableSelector)](#ui5.table.sortColumnAscending)
    * [.sortColumnDescending(columnName, tableSelector)](#ui5.table.sortColumnDescending)
    * [.clickSettingsButton(tableSelector)](#ui5.table.clickSettingsButton)
    * [.getTotalNumberOfRows(tableSelectorOrId)](#ui5.table.getTotalNumberOfRows) ⇒ <code>Number</code>
    * [.getTotalNumberOfRowsByValues(tableSelectorOrId, values, [index])](#ui5.table.getTotalNumberOfRowsByValues) ⇒ <code>Number</code>
    * [.getSelectorsForRowsByValues(tableSelectorOrId, values)](#ui5.table.getSelectorsForRowsByValues)
    * [.getSelectorForRowByIndex(tableSelectorOrId, index)](#ui5.table.getSelectorForRowByIndex)
    * [.selectRowByIndex(tableSelectorOrId, index)](#ui5.table.selectRowByIndex)
    * [.selectAllRows(tableSelectorOrId)](#ui5.table.selectAllRows)
    * [.deselectRowByIndex(tableSelectorOrId)](#ui5.table.deselectRowByIndex)
    * [.deselectAllRows(tableSelectorOrId)](#ui5.table.deselectAllRows)
    * [.selectRowByValues(tableSelectorOrId, values, [index])](#ui5.table.selectRowByValues)
    * [.openItemByIndex(tableSelectorOrId, index)](#ui5.table.openItemByIndex)
    * [.openItemByValues(tableSelectorOrId, values, [index])](#ui5.table.openItemByValues)

<a name="ui5.table.sortColumnAscending"></a>

#### table.sortColumnAscending(columnName, tableSelector)
Sorts the given column "Ascending".

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| columnName | <code>String</code> | The name of the column to sort. |
| tableSelector | <code>Ui5Selector</code> | The selector describing the table element (in case there are more then one). |

**Example**  
```js
await ui5.table.sortColumnAscending("Supplier");
```
**Example**  
```js
const glAccountItemsTable = {
 "elementProperties": {
    "viewName": "ui.s2p.mm.supplinvoice.manage.s1.view.S1",
    "metadata": "sap.m.Table",
    "id": "*idS2P.MM.MSI.TableGLAccountItems"
 }
};
await ui5.table.sortColumnAscending("Amount", glAccountItemsTable);
```
<a name="ui5.table.sortColumnDescending"></a>

#### table.sortColumnDescending(columnName, tableSelector)
Sorts the given column "Descending".

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| columnName | <code>String</code> | The name of the column to sort. |
| tableSelector | <code>Ui5Selector</code> | The selector describing the table element (in case there are more then one). |

**Example**  
```js
await ui5.table.sortColumnDescending("Supplier");
```
**Example**  
```js
const glAccountItemsTable = {
 "elementProperties": {
    "viewName": "ui.s2p.mm.supplinvoice.manage.s1.view.S1",
    "metadata": "sap.m.Table",
    "id": "*idS2P.MM.MSI.TableGLAccountItems"
 }
};
await ui5.table.sortColumnDescending("Amount", glAccountItemsTable);
```
<a name="ui5.table.clickSettingsButton"></a>

#### table.clickSettingsButton(tableSelector)
Opens the user Settings.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelector | <code>Ui5Selector</code> | The selector describing the table element (in case there are more then one). |

**Example**  
```js
await ui5.table.clickSettingsButton();
```
**Example**  
```js
const glAccountItemsTable = {
 "elementProperties": {
    "viewName": "ui.s2p.mm.supplinvoice.manage.s1.view.S1",
    "metadata": "sap.m.Table",
    "id": "*idS2P.MM.MSI.TableGLAccountItems"
 }
};
await ui5.table.clickSettingsButton(glAccountItemsTable);
```
<a name="ui5.table.getTotalNumberOfRows"></a>

#### table.getTotalNumberOfRows(tableSelectorOrId) ⇒ <code>Number</code>
Returns the total number of rows in the table.

**Kind**: static method of [<code>table</code>](#ui5.table)  
**Returns**: <code>Number</code> - The total number of rows in the table.  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |

**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
  id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
const numberOfRows = await ui5.table.getTotalNumberOfRows(selector);
```
<a name="ui5.table.getTotalNumberOfRowsByValues"></a>

#### table.getTotalNumberOfRowsByValues(tableSelectorOrId, values, [index]) ⇒ <code>Number</code>
Returns the total number of rows in the table that match the given values.

**Kind**: static method of [<code>table</code>](#ui5.table)  
**Returns**: <code>Number</code> - The total number of matching rows in the table.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> |  | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |
| values | <code>String</code> \| <code>Array.&lt;String&gt;</code> |  | The value(s) to match in the table rows. |
| [index] | <code>Number</code> | <code>0</code> | The index of the matching row to consider. |

**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
const numberOfRows = await ui5.table.getTotalNumberOfRowsByValues(selector, ["value1", "value2"]);
const numberOfRows = await ui5.table.getTotalNumberOfRowsByValues(selector, "value");
```
<a name="ui5.table.getSelectorsForRowsByValues"></a>

#### table.getSelectorsForRowsByValues(tableSelectorOrId, values)
Gets the selectors of rows in the table that contain the given values. If multiple values are provided, it only returns the selectors of rows that contain all of them.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |
| values | <code>String</code> \| <code>Array.&lt;String&gt;</code> | The value(s) to match in the table rows. |

**Example**  
```js
const id = "application-ReportingTask-run-component---ReportList--ReportingTable"
await ui5.table.getSelectorsForRowsByValues(id, "February");
```
**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
await ui5.table.getSelectorsForRowsByValues(selector, ["January", "2022"]);
```
<a name="ui5.table.getSelectorForRowByIndex"></a>

#### table.getSelectorForRowByIndex(tableSelectorOrId, index)
Gets the selector of a row in the table by its index.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |
| index | <code>Number</code> | The index of the item to open. |

**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
const rowSelector = await ui5.table.getSelectorForRowByIndex(selector, 0);
```
**Example**  
```js
id = "application-ReportingTask-run-component---ReportList--ReportingTable"
const rowSelector = await ui5.table.getSelectorForRowByIndex(id, 0);
```
<a name="ui5.table.selectRowByIndex"></a>

#### table.selectRowByIndex(tableSelectorOrId, index)
Selects a row in the table by its index.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |
| index | <code>Number</code> | The index of the row to select. |

**Example**  
```js
await ui5.table.selectRowByIndex("application-ReportingTask-run-component---ReportList--ReportingTable", 0);
```
**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
await ui5.table.selectRowByIndex(selector, 0);
```
<a name="ui5.table.selectAllRows"></a>

#### table.selectAllRows(tableSelectorOrId)
Selects all rows in the table.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |

**Example**  
```js
await ui5.table.selectAllRows("application-ReportingTask-run-component---ReportList--ReportingTable");
await ui5.table.selectAllRows(selector);
```
<a name="ui5.table.deselectRowByIndex"></a>

#### table.deselectRowByIndex(tableSelectorOrId)
Deselects a row in the table by its index.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |

**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
  id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
await ui5.table.deselectRowByIndex(selector, 0);
```
**Example**  
```js
const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
await ui5.table.deselectRowByIndex(id, 0);
```
<a name="ui5.table.deselectAllRows"></a>

#### table.deselectAllRows(tableSelectorOrId)
Deselects all rows in the table.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |

**Example**  
```js
await ui5.table.deselectAllRows("application-ReportingTask-run-component---ReportList--ReportingTable");
```
**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
await ui5.table.deselectAllRows(selector);
```
<a name="ui5.table.selectRowByValues"></a>

#### table.selectRowByValues(tableSelectorOrId, values, [index])
Selects a row in the table by matching value(s). If multiple rows match, selects the one at the given global index (across all pages).

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> |  | The selector or ID describing the table. |
| values | <code>String</code> \| <code>Array.&lt;String&gt;</code> |  | The value(s) to match in the table rows. |
| [index] | <code>Number</code> | <code>0</code> | The global index of the matching row to select (across all pages). |

**Example**  
```js
const selector = {
elementProperties: {
 viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
 metadata: "sap.ui.comp.smarttable.SmartTable",
 id: "application-ReportingTask-run-component---ReportList--ReportingTable"
}
};
await ui5.table.selectRowByValues(selector, ["value1", "value2"]);
```
**Example**  
```js
const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
await ui5.table.selectRowByValues(id, "value", 1);
```
<a name="ui5.table.openItemByIndex"></a>

#### table.openItemByIndex(tableSelectorOrId, index)
Opens the item in the table by its index.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Description |
| --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |
| index | <code>Number</code> | The index of the item to open. |

**Example**  
```js
const selector = {
 elementProperties: {
  viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
  metadata: "sap.ui.comp.smarttable.SmartTable",
  id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
await ui5.table.openItemByIndex(selector, 0);
```
**Example**  
```js
const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
await ui5.table.openItemByIndex(id, 0);
```
<a name="ui5.table.openItemByValues"></a>

#### table.openItemByValues(tableSelectorOrId, values, [index])
Opens the item in the table containing the given values. If multiple items match, it opens the index-th item.

**Kind**: static method of [<code>table</code>](#ui5.table)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| tableSelectorOrId | <code>Ui5Selector</code> \| <code>String</code> |  | The selector or ID describing the table (sap.m.Table | sap.ui.comp.smarttable.SmartTable). |
| values | <code>String</code> \| <code>Array.&lt;String&gt;</code> |  | The value(s) to match in the table rows. |
| [index] | <code>Number</code> | <code>0</code> | The index of the matching row to consider. |

**Example**  
```js
const selector = {
 elementProperties: {
   viewName: "gs.fin.runstatutoryreports.s1.view.ReportList",
   metadata: "sap.ui.comp.smarttable.SmartTable",
   id: "application-ReportingTask-run-component---ReportList--ReportingTable"
 }
};
await ui5.table.openItemByValues(selector, ["value1", "value2"]);
```
**Example**  
```js
const id = "application-ReportingTask-run-component---ReportList--ReportingTable";
await ui5.table.openItemByValues(id, "value");
```
<a name="ui5.userInteraction"></a>

### ui5.userInteraction
**Kind**: static class of [<code>ui5</code>](#ui5)  

* [.userInteraction](#ui5.userInteraction)
    * [.click(selector, [index], [timeout])](#ui5.userInteraction.click)
    * [.clickAndRetry(selector, [index], [timeout], [retries], [interval])](#ui5.userInteraction.clickAndRetry)
    * [.doubleClick(selector, [index], [timeout])](#ui5.userInteraction.doubleClick)
    * [.rightClick(selector, [index], [timeout])](#ui5.userInteraction.rightClick)
    * [.clickTab(selector, [index], [timeout])](#ui5.userInteraction.clickTab)
    * [.clickListItem(selector, [index], [timeout])](#ui5.userInteraction.clickListItem)
    * [.check(selector, [index], [timeout])](#ui5.userInteraction.check)
    * [.uncheck(selector, [index], [timeout])](#ui5.userInteraction.uncheck)
    * [.fill(selector, value, [index], [timeout])](#ui5.userInteraction.fill)
    * [.fillAndRetry(selector, value, [index], [timeout], [retries], [interval])](#ui5.userInteraction.fillAndRetry)
    * [.clear(selector, [index], [timeout])](#ui5.userInteraction.clear)
    * [.clearAndRetry(selector, [index], [timeout], [retries], [interval])](#ui5.userInteraction.clearAndRetry)
    * [.clearAndFill(selector, value, [index], [timeout])](#ui5.userInteraction.clearAndFill)
    * [.clearAndFillAndRetry(selector, value, [index], [timeout], [retries], [interval], [verify])](#ui5.userInteraction.clearAndFillAndRetry)
    * [.clearSmartFieldInput(selector, [index], [timeout])](#ui5.userInteraction.clearSmartFieldInput)
    * [.clearAndFillSmartFieldInput(selector, value, [index], [timeout])](#ui5.userInteraction.clearAndFillSmartFieldInput)
    * [.clearAndFillSmartFieldInputAndRetry(selector, value, [index], [timeout], [retries], [interval])](#ui5.userInteraction.clearAndFillSmartFieldInputAndRetry)
    * [.selectBox(selector, value, [index])](#ui5.userInteraction.selectBox)
    * [.selectComboBox(selector, value, [index])](#ui5.userInteraction.selectComboBox)
    * [.selectMultiComboBox(selector, values, [index])](#ui5.userInteraction.selectMultiComboBox)
    * [.clickSelectArrow(selector, [index])](#ui5.userInteraction.clickSelectArrow)
    * [.clickSelectArrowAndRetry(selector, [index], [retries], [interval])](#ui5.userInteraction.clickSelectArrowAndRetry)
    * [.selectFromTab(selector, value, [index], [timeout])](#ui5.userInteraction.selectFromTab)
    * [.mouseOverElement(selector, [index], [timeout])](#ui5.userInteraction.mouseOverElement)
    * [.scrollToElement(selector, [index], [alignment], [timeout])](#ui5.userInteraction.scrollToElement)
    * [.selectAll([selector], [index], [timeout])](#ui5.userInteraction.selectAll)
    * [.openF4Help(selector, [index], [timeout], useF4Key)](#ui5.userInteraction.openF4Help)
    * [.searchFor(selector, [index], [timeout], useEnter)](#ui5.userInteraction.searchFor)
    * [.resetSearch(selector, [index], [timeout])](#ui5.userInteraction.resetSearch)

<a name="ui5.userInteraction.click"></a>

#### userInteraction.click(selector, [index], [timeout])
Clicks on the element with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.click(selector);
```
<a name="ui5.userInteraction.clickAndRetry"></a>

#### userInteraction.clickAndRetry(selector, [index], [timeout], [retries], [interval])
Clicks on the element with the given selector and retries the action in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.userInteraction.clickAndRetry(selector);
```
<a name="ui5.userInteraction.doubleClick"></a>

#### userInteraction.doubleClick(selector, [index], [timeout])
Double Clicks on the passed element.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.doubleClick(selector);
```
<a name="ui5.userInteraction.rightClick"></a>

#### userInteraction.rightClick(selector, [index], [timeout])
Right Clicks on the passed element.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await ui5.userInteraction.rightClick(elem);
```
<a name="ui5.userInteraction.clickTab"></a>

#### userInteraction.clickTab(selector, [index], [timeout])
Clicks on the tab with the given selector and checks if the tab got selected successfully.
The function retries the click for maximal 3 times if the selection of the tab (blue underline) was not successful.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.clickTab(selector);
```
<a name="ui5.userInteraction.clickListItem"></a>

#### userInteraction.clickListItem(selector, [index], [timeout])
Clicks or opens the list item with the given selector (e.g. ColumnListItem, StandardListItem).
In some cases the default click function is not working correctly (clicks an element within the list item).
Therefore we recommend to use this function to open a specific list item.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.clickListItem(selector);
```
<a name="ui5.userInteraction.check"></a>

#### userInteraction.check(selector, [index], [timeout])
Checks the checkbox with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.check(selector);
```
<a name="ui5.userInteraction.uncheck"></a>

#### userInteraction.uncheck(selector, [index], [timeout])
Unchecks the checkbox with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.uncheck(selector);
```
<a name="ui5.userInteraction.fill"></a>

#### userInteraction.fill(selector, value, [index], [timeout])
Fills the input field with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.fill(selector, "My Value");
```
<a name="ui5.userInteraction.fillAndRetry"></a>

#### userInteraction.fillAndRetry(selector, value, [index], [timeout], [retries], [interval])
Fills the input field with the given selector and retries the action in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.userInteraction.fillAndRetry(selector, "My Value");
```
<a name="ui5.userInteraction.clear"></a>

#### userInteraction.clear(selector, [index], [timeout])
Clears the input with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.clear(selector);
```
<a name="ui5.userInteraction.clearAndRetry"></a>

#### userInteraction.clearAndRetry(selector, [index], [timeout], [retries], [interval])
Clears the input with the given selector and retries the action in case of a failure

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.userInteraction.clearAndRetry(selector);
```
<a name="ui5.userInteraction.clearAndFill"></a>

#### userInteraction.clearAndFill(selector, value, [index], [timeout])
Clears the input field with the given selector and fills the given value.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.clearAndFill(selector, "My Value");
```
<a name="ui5.userInteraction.clearAndFillAndRetry"></a>

#### userInteraction.clearAndFillAndRetry(selector, value, [index], [timeout], [retries], [interval], [verify])
Clears the input field with the given selector and fills the given value. Retries the action in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The value to enter. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |
| [verify] | <code>Boolean</code> | <code>true</code> | Specifies if the filled value should be verified. |

**Example**  
```js
await ui5.userInteraction.clearAndFillAndRetry(selector, "My Value");
```
<a name="ui5.userInteraction.clearSmartFieldInput"></a>

#### userInteraction.clearSmartFieldInput(selector, [index], [timeout])
Clears the smart filed with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.clearSmartFieldInput(selector);
```
<a name="ui5.userInteraction.clearAndFillSmartFieldInput"></a>

#### userInteraction.clearAndFillSmartFieldInput(selector, value, [index], [timeout])
Clears the smart filed with the given selector and fills the given value.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The value to enter. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.clearAndFillSmartFieldInput(selector, "My Value");
```
<a name="ui5.userInteraction.clearAndFillSmartFieldInputAndRetry"></a>

#### userInteraction.clearAndFillSmartFieldInputAndRetry(selector, value, [index], [timeout], [retries], [interval])
Clears the smart filed with the given selector and fills the given value and retries the action in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The value to enter. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.userInteraction.clearAndFillSmartFieldInputAndRetry(selector, "My Value");
```
<a name="ui5.userInteraction.selectBox"></a>

#### userInteraction.selectBox(selector, value, [index])
Selects the passed value of the Select box.
Please note that the function will only work for the default select Box.
In special cases, please use the clickSelectArrow function.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The value to select. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
await ui5.userInteraction.selectBox(selector, "Germany");
```
<a name="ui5.userInteraction.selectComboBox"></a>

#### userInteraction.selectComboBox(selector, value, [index])
Selects the passed value from the ComboBox with the given selector.
Please note that the function will only work for the default ComboBox.
In special cases you need to use the 'clickSelectArrow' function.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The value to select. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
await ui5.userInteraction.selectComboBox(selector, "Germany");
```
<a name="ui5.userInteraction.selectMultiComboBox"></a>

#### userInteraction.selectMultiComboBox(selector, values, [index])
Selects the passed values of the MultiComboBox with the given selector.
Please note that the function will only work for the default MultiComboBox.
In special cases, please use the clickSelectArrow function.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| values | <code>Array</code> |  | The values to select. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
await ui5.userInteraction.selectMultiComboBox(selector, ["Option 1", "Option 2"]);
```
<a name="ui5.userInteraction.clickSelectArrow"></a>

#### userInteraction.clickSelectArrow(selector, [index])
Clicks the arrow icon at the passed selector (select box).

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |

**Example**  
```js
await ui5.userInteraction.clickSelectArrow(selector);
```
<a name="ui5.userInteraction.clickSelectArrowAndRetry"></a>

#### userInteraction.clickSelectArrowAndRetry(selector, [index], [retries], [interval])
Clicks the arrow icon at the passed selector (select box), and retries in case it fails.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
await ui5.userInteraction.clickSelectArrowAndRetry(selector);
```
<a name="ui5.userInteraction.selectFromTab"></a>

#### userInteraction.selectFromTab(selector, value, [index], [timeout])
Selects the passed value on the tab with the given selector and checks if the tab got selected successfully.
The function retries the click for maximal 3 times if the selection of the tab (blue underline) was not successful.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| value | <code>String</code> |  | The value to select. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.selectFromTab(selector);
```
<a name="ui5.userInteraction.mouseOverElement"></a>

#### userInteraction.mouseOverElement(selector, [index], [timeout])
Moves the cursor/focus to the element with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.mouseOverElement(selector);
```
<a name="ui5.userInteraction.scrollToElement"></a>

#### userInteraction.scrollToElement(selector, [index], [alignment], [timeout])
Scrolls the element with the given selector into view.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [alignment] | <code>String</code> \| <code>Object</code> | <code>&quot;center&quot;</code> | The alignment option for scrolling.   Can be one of: "start", "center", "end", "nearest", or an object with properties:   - block: Vertical alignment ("start", "center", "end", "nearest").   - inline: Horizontal alignment ("start", "center", "end", "nearest"). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
// Scroll to element with center alignment.
await nonUi5.userInteraction.scrollToElement(selector, 0, "center");
```
**Example**  
```js
// Scroll to element with custom alignment.
const alignment = {
  block: "start",
  inline: "center"
};
await nonUi5.userInteraction.scrollToElement(selector, 0, alignment);
```
<a name="ui5.userInteraction.selectAll"></a>

#### userInteraction.selectAll([selector], [index], [timeout])
Performs "select all" (ctrl + a) at the element with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [selector] | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector, in case there are more than one elements visible at the same time. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.selectAll(selector);
```
<a name="ui5.userInteraction.openF4Help"></a>

#### userInteraction.openF4Help(selector, [index], [timeout], useF4Key)
Opens the F4-help of the element with the given selector.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| useF4Key | <code>Boolean</code> |  | Specifies if the help is opened by pressing the F4-key or via the button. The default value is true (triggered by pressing the F4-key). Set "useF4Key" to false, to trigger the search by clicking the button. |

**Example**  
```js
await ui5.userInteraction.openF4Help(selector, 0, 30000, false);
```
<a name="ui5.userInteraction.searchFor"></a>

#### userInteraction.searchFor(selector, [index], [timeout], useEnter)
Searches for the passed value and executes the search.
In case that the search is already filled, it will reset the field first.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| useEnter | <code>Boolean</code> |  | Specifies if the search is triggered by pressing the Enter-key or via the search button. The default value is true (triggered by pressing the Enter-key). Set "useEnter" to false, to trigger the search by clicking the search button. |

**Example**  
```js
await ui5.userInteraction.searchFor(selector, "My Value", 0, 30000, false);
```
<a name="ui5.userInteraction.resetSearch"></a>

#### userInteraction.resetSearch(selector, [index], [timeout])
Resets the search field.

**Kind**: static method of [<code>userInteraction</code>](#ui5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the selector (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await ui5.userInteraction.resetSearch(selector);
```
<a name="nonUi5"></a>

## nonUi5
Global namespace for non UI5 modules.

**Kind**: global constant  

* [nonUi5](#nonUi5)
    * [.assertion](#nonUi5.assertion)
        * [.expectAttributeToBe(elementOrSelector, compareValue, [attribute])](#nonUi5.assertion.expectAttributeToBe)
        * [.expectAttributeToContain(elementOrSelector, compareValue, [attribute])](#nonUi5.assertion.expectAttributeToContain)
        * [.expectValueToBe(elementOrSelector, compareValue)](#nonUi5.assertion.expectValueToBe)
        * [.expectCssPropertyValueToBe(elementOrSelector, cssProperty, compareValue)](#nonUi5.assertion.expectCssPropertyValueToBe)
        * [.expectTextToBe(elementOrSelector, compareValue)](#nonUi5.assertion.expectTextToBe)
        * [.expectToBeVisible(elementOrSelector)](#nonUi5.assertion.expectToBeVisible)
        * [.expectToBeNotVisible(elementOrSelector, [timeout])](#nonUi5.assertion.expectToBeNotVisible)
    * [.element](#nonUi5.element)
        * [.waitForAll(selector, [timeout])](#nonUi5.element.waitForAll)
        * [.waitToBePresent(selector, [timeout])](#nonUi5.element.waitToBePresent)
        * [.waitToBeVisible(selector, [timeout])](#nonUi5.element.waitToBeVisible)
        * [.waitToBeClickable(selector, [timeout])](#nonUi5.element.waitToBeClickable)
        * [.getAllDisplayed(selector, [timeout])](#nonUi5.element.getAllDisplayed) ⇒ <code>Array.&lt;Object&gt;</code>
        * [.getAll(selector, [timeout])](#nonUi5.element.getAll)
        * [.getByCss(selector, [index], [timeout], [includeHidden])](#nonUi5.element.getByCss) ⇒ <code>Object</code>
        * [.getByCssContainingText(selector, [text], [index], [timeout], [includeHidden], [strict])](#nonUi5.element.getByCssContainingText) ⇒ <code>Object</code>
        * [.getById(id, [timeout], [includeHidden])](#nonUi5.element.getById) ⇒ <code>Object</code>
        * [.getByClass(elemClass, [index], [timeout], [includeHidden])](#nonUi5.element.getByClass) ⇒ <code>Object</code>
        * [.getByName(name, [index], [timeout], [includeHidden])](#nonUi5.element.getByName) ⇒ <code>Object</code>
        * [.getByXPath(xpath, [index], [timeout], [includeHidden])](#nonUi5.element.getByXPath) ⇒ <code>Object</code>
        * [.getByChild(elementSelector, childSelector, [index], [timeout], [includeHidden])](#nonUi5.element.getByChild) ⇒ <code>Object</code>
        * [.getByParent(elementSelector, parentSelector, [index], [timeout], [includeHidden])](#nonUi5.element.getByParent) ⇒ <code>Object</code>
        * [.isVisible(element, [strict])](#nonUi5.element.isVisible) ⇒ <code>Boolean</code>
        * [.isPresent(elem)](#nonUi5.element.isPresent) ⇒ <code>Boolean</code>
        * [.isEnabled(elem)](#nonUi5.element.isEnabled) ⇒ <code>Boolean</code>
        * [.isPresentByCss(css, [index], [timeout])](#nonUi5.element.isPresentByCss) ⇒ <code>boolean</code>
        * [.isPresentByXPath(xpath, [index], [timeout])](#nonUi5.element.isPresentByXPath) ⇒ <code>boolean</code>
        * [.isSelected(elem)](#nonUi5.element.isSelected) ⇒ <code>boolean</code>
        * [.getAttributeValue(elem, [attribute])](#nonUi5.element.getAttributeValue) ⇒ <code>String</code>
        * [.getValue(elem)](#nonUi5.element.getValue) ⇒ <code>String</code>
        * [.getCssPropertyValue(elementOrSelector, cssProperty)](#nonUi5.element.getCssPropertyValue) ⇒ <code>String</code>
        * [.setInnerHTML(elem)](#nonUi5.element.setInnerHTML) ⇒ <code>String</code>
        * [.highlight(elem, [duration], [color])](#nonUi5.element.highlight)
    * [.navigation](#nonUi5.navigation)
        * [.navigateToApplication(relativeReference, [refresh])](#nonUi5.navigation.navigateToApplication)
    * [.session](#nonUi5.session)
        * [.loginSapNetWeaver(username, password, [clickContinue], [iframeCssSelector])](#nonUi5.session.loginSapNetWeaver)
    * [.userInteraction](#nonUi5.userInteraction)
        * [.click(elementOrSelector, [timeout])](#nonUi5.userInteraction.click)
        * [.clickAndRetry(elementOrSelector, [timeout], [retries], [interval])](#nonUi5.userInteraction.clickAndRetry)
        * [.doubleClick(elementOrSelector, [timeout])](#nonUi5.userInteraction.doubleClick)
        * [.rightClick(elementOrSelector, [timeout])](#nonUi5.userInteraction.rightClick)
        * [.check(elementOrSelector)](#nonUi5.userInteraction.check)
        * [.uncheck(elementOrSelector)](#nonUi5.userInteraction.uncheck)
        * [.fill(elementOrSelector, value)](#nonUi5.userInteraction.fill)
        * [.fillAndRetry(elementOrSelector, value, [retries], [interval])](#nonUi5.userInteraction.fillAndRetry)
        * [.clear(elementOrSelector)](#nonUi5.userInteraction.clear)
        * [.clearAndRetry(elementOrSelector, [retries], [interval])](#nonUi5.userInteraction.clearAndRetry)
        * [.clearAndFill(elementOrSelector, value)](#nonUi5.userInteraction.clearAndFill)
        * [.clearAndFillAndRetry(elementOrSelector, value, [retries], [interval], [verify])](#nonUi5.userInteraction.clearAndFillAndRetry)
        * [.mouseOverElement(elementOrSelector, [xOffset], [yOffset])](#nonUi5.userInteraction.mouseOverElement)
        * [.scrollToElement(elem, [alignment])](#nonUi5.userInteraction.scrollToElement)
        * [.dragAndDrop(elementOrSelector, targetElem)](#nonUi5.userInteraction.dragAndDrop)
        * [.moveCursorAndClick(elementOrSelector)](#nonUi5.userInteraction.moveCursorAndClick)
        * [.clickElementInSvg(elementOrSelector, innerSelector)](#nonUi5.userInteraction.clickElementInSvg)

<a name="nonUi5.assertion"></a>

### nonUi5.assertion
**Kind**: static class of [<code>nonUi5</code>](#nonUi5)  

* [.assertion](#nonUi5.assertion)
    * [.expectAttributeToBe(elementOrSelector, compareValue, [attribute])](#nonUi5.assertion.expectAttributeToBe)
    * [.expectAttributeToContain(elementOrSelector, compareValue, [attribute])](#nonUi5.assertion.expectAttributeToContain)
    * [.expectValueToBe(elementOrSelector, compareValue)](#nonUi5.assertion.expectValueToBe)
    * [.expectCssPropertyValueToBe(elementOrSelector, cssProperty, compareValue)](#nonUi5.assertion.expectCssPropertyValueToBe)
    * [.expectTextToBe(elementOrSelector, compareValue)](#nonUi5.assertion.expectTextToBe)
    * [.expectToBeVisible(elementOrSelector)](#nonUi5.assertion.expectToBeVisible)
    * [.expectToBeNotVisible(elementOrSelector, [timeout])](#nonUi5.assertion.expectToBeNotVisible)

<a name="nonUi5.assertion.expectAttributeToBe"></a>

#### assertion.expectAttributeToBe(elementOrSelector, compareValue, [attribute])
Expects the attributes value of the passed element to be the compare value.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| compareValue | <code>String</code> | The compare value. |
| [attribute] | <code>String</code> | The attribute to compare. If not passed, it will compare the inner HTML content of the element. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectAttributeToBe(element, "Save");
```
**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectAttributeToBe(element, "Save", "title");
```
<a name="nonUi5.assertion.expectAttributeToContain"></a>

#### assertion.expectAttributeToContain(elementOrSelector, compareValue, [attribute])
Expects the attributes value of the passed element to contain the compare value.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| compareValue | <code>String</code> | The compare value. |
| [attribute] | <code>String</code> | The attribute to compare. If not passed, it will compare the inner HTML content of the element. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectAttributeToContain(element, "Save", "title");
```
<a name="nonUi5.assertion.expectValueToBe"></a>

#### assertion.expectValueToBe(elementOrSelector, compareValue)
Expects the attributes value of the passed element to be the compare value.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| compareValue | <code>String</code> | The compare value. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectValueToBe(element, "Save");
```
<a name="nonUi5.assertion.expectCssPropertyValueToBe"></a>

#### assertion.expectCssPropertyValueToBe(elementOrSelector, cssProperty, compareValue)
Expects the CSS property value of the passed element to be the compare value.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| cssProperty | <code>String</code> | The CSS property of the element to compare with. |
| compareValue | <code>String</code> | The compare value. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectCssPropertyValueToBe(element, "color", "rgb(255, 0, 0)");
```
<a name="nonUi5.assertion.expectTextToBe"></a>

#### assertion.expectTextToBe(elementOrSelector, compareValue)
Expects the text of the passed element to be the compare value.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| compareValue | <code>String</code> | The compare value. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectTextToBe(element, "Save");
```
<a name="nonUi5.assertion.expectToBeVisible"></a>

#### assertion.expectToBeVisible(elementOrSelector)
Expects that the element is visible to the user.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectToBeVisible(elem);
```
<a name="nonUi5.assertion.expectToBeNotVisible"></a>

#### assertion.expectToBeNotVisible(elementOrSelector, [timeout])
Expects that the element is not visible to the user.

**Kind**: static method of [<code>assertion</code>](#nonUi5.assertion)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). Recommendation is to lower the timeout since the element is not expected to show up. |

**Example**  
```js
const element = await nonUi5.element.getById("button01");
await nonUi5.assertion.expectToBeNotVisible(element, 5000);
```
<a name="nonUi5.element"></a>

### nonUi5.element
**Kind**: static class of [<code>nonUi5</code>](#nonUi5)  

* [.element](#nonUi5.element)
    * [.waitForAll(selector, [timeout])](#nonUi5.element.waitForAll)
    * [.waitToBePresent(selector, [timeout])](#nonUi5.element.waitToBePresent)
    * [.waitToBeVisible(selector, [timeout])](#nonUi5.element.waitToBeVisible)
    * [.waitToBeClickable(selector, [timeout])](#nonUi5.element.waitToBeClickable)
    * [.getAllDisplayed(selector, [timeout])](#nonUi5.element.getAllDisplayed) ⇒ <code>Array.&lt;Object&gt;</code>
    * [.getAll(selector, [timeout])](#nonUi5.element.getAll)
    * [.getByCss(selector, [index], [timeout], [includeHidden])](#nonUi5.element.getByCss) ⇒ <code>Object</code>
    * [.getByCssContainingText(selector, [text], [index], [timeout], [includeHidden], [strict])](#nonUi5.element.getByCssContainingText) ⇒ <code>Object</code>
    * [.getById(id, [timeout], [includeHidden])](#nonUi5.element.getById) ⇒ <code>Object</code>
    * [.getByClass(elemClass, [index], [timeout], [includeHidden])](#nonUi5.element.getByClass) ⇒ <code>Object</code>
    * [.getByName(name, [index], [timeout], [includeHidden])](#nonUi5.element.getByName) ⇒ <code>Object</code>
    * [.getByXPath(xpath, [index], [timeout], [includeHidden])](#nonUi5.element.getByXPath) ⇒ <code>Object</code>
    * [.getByChild(elementSelector, childSelector, [index], [timeout], [includeHidden])](#nonUi5.element.getByChild) ⇒ <code>Object</code>
    * [.getByParent(elementSelector, parentSelector, [index], [timeout], [includeHidden])](#nonUi5.element.getByParent) ⇒ <code>Object</code>
    * [.isVisible(element, [strict])](#nonUi5.element.isVisible) ⇒ <code>Boolean</code>
    * [.isPresent(elem)](#nonUi5.element.isPresent) ⇒ <code>Boolean</code>
    * [.isEnabled(elem)](#nonUi5.element.isEnabled) ⇒ <code>Boolean</code>
    * [.isPresentByCss(css, [index], [timeout])](#nonUi5.element.isPresentByCss) ⇒ <code>boolean</code>
    * [.isPresentByXPath(xpath, [index], [timeout])](#nonUi5.element.isPresentByXPath) ⇒ <code>boolean</code>
    * [.isSelected(elem)](#nonUi5.element.isSelected) ⇒ <code>boolean</code>
    * [.getAttributeValue(elem, [attribute])](#nonUi5.element.getAttributeValue) ⇒ <code>String</code>
    * [.getValue(elem)](#nonUi5.element.getValue) ⇒ <code>String</code>
    * [.getCssPropertyValue(elementOrSelector, cssProperty)](#nonUi5.element.getCssPropertyValue) ⇒ <code>String</code>
    * [.setInnerHTML(elem)](#nonUi5.element.setInnerHTML) ⇒ <code>String</code>
    * [.highlight(elem, [duration], [color])](#nonUi5.element.highlight)

<a name="nonUi5.element.waitForAll"></a>

#### element.waitForAll(selector, [timeout])
Waits until all elements with the given selector are rendered. Will fail if no element is found.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.waitForAll(".inputField");
```
<a name="nonUi5.element.waitToBePresent"></a>

#### element.waitToBePresent(selector, [timeout])
Waits until the element with the given selector is present.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.waitToBePresent(".input01");
```
**Example**  
```js
await nonUi5.element.waitToBePresent("#button12");
```
**Example**  
```js
await nonUi5.element.waitToBePresent("p:first-child");
```
<a name="nonUi5.element.waitToBeVisible"></a>

#### element.waitToBeVisible(selector, [timeout])
Waits until the element with the given selector is visible.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.waitToBeVisible(".input01");
```
**Example**  
```js
await nonUi5.element.waitToBeVisible("#button12");
```
**Example**  
```js
await nonUi5.element.waitToBeVisible("p:first-child");
```
<a name="nonUi5.element.waitToBeClickable"></a>

#### element.waitToBeClickable(selector, [timeout])
Waits until the element with the given selector is clickable.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.waitToBeClickable(".input01");
```
**Example**  
```js
await nonUi5.element.waitToBeClickable("#button12");
```
**Example**  
```js
await nonUi5.element.waitToBeClickable("p:first-child");
```
<a name="nonUi5.element.getAllDisplayed"></a>

#### element.getAllDisplayed(selector, [timeout]) ⇒ <code>Array.&lt;Object&gt;</code>
Gets all visible elements with the passed selector.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Array.&lt;Object&gt;</code> - The array of elements.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.getAllDisplayed(".inputField");
```
<a name="nonUi5.element.getAll"></a>

#### element.getAll(selector, [timeout])
Returns all elements found by the given selector despite visible or not.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const hiddenElements = await nonUi5.element.getAll(".sapUiInvisibleText");
const isPresent = await nonUi5.element.isPresent(hiddenElements[0]);
await common.assertion.expectTrue(isPresent);
```
<a name="nonUi5.element.getByCss"></a>

#### element.getByCss(selector, [index], [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets the element with the given CSS selector.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |

**Example**  
```js
const elem = await nonUi5.element.getByCss(".button01");
```
<a name="nonUi5.element.getByCssContainingText"></a>

#### element.getByCssContainingText(selector, [text], [index], [timeout], [includeHidden], [strict]) ⇒ <code>Object</code>
Gets the element with the given CSS selector containing the given text value.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [text] | <code>String</code> | <code>&quot;&quot;</code> | The containing text value of the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |
| [strict] | <code>Boolean</code> | <code>false</code> | Specifies if the values match should be exact |

**Example**  
```js
const elem = await nonUi5.element.getByCssContainingText(".input01", "Jack Jackson");
```
<a name="nonUi5.element.getById"></a>

#### element.getById(id, [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets the element with the given ID.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| id | <code>String</code> |  | The id of the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if the function will check for the elements visibility. |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
```
<a name="nonUi5.element.getByClass"></a>

#### element.getByClass(elemClass, [index], [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets the element with the given class.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elemClass | <code>String</code> |  | The class describing the element |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |

**Example**  
```js
const elem = await nonUi5.element.getByClass("button01");
const elem = await nonUi5.element.getByClass("sapMIBar sapMTB sapMTBNewFlex sapContrastPlus");
```
<a name="nonUi5.element.getByName"></a>

#### element.getByName(name, [index], [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets the element with the given name.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| name | <code>String</code> |  | The name attribute of the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |

**Example**  
```js
const elem = await nonUi5.element.getByName(".button01");
```
<a name="nonUi5.element.getByXPath"></a>

#### element.getByXPath(xpath, [index], [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets the element with the given XPath.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| xpath | <code>String</code> |  | The XPath describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |

**Example**  
```js
const elem = await nonUi5.element.getByXPath("//ul/li/a");
```
<a name="nonUi5.element.getByChild"></a>

#### element.getByChild(elementSelector, childSelector, [index], [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets an element by its selector and child selector. Can be used when multiple elements have the same properties.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementSelector | <code>String</code> |  | The CSS selector describing the element. |
| childSelector | <code>String</code> |  | The CSS selector describing the child element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |

**Example**  
```js
const elem = await nonUi5.element.getByChild(".form01", ".input01");
```
<a name="nonUi5.element.getByParent"></a>

#### element.getByParent(elementSelector, parentSelector, [index], [timeout], [includeHidden]) ⇒ <code>Object</code>
Gets an element by its selector and parent selector. Can be used when multiple elements have the same properties.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Object</code> - The found element.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementSelector | <code>String</code> |  | The CSS selector describing the element. |
| parentSelector | <code>String</code> |  | The CSS selector describing the parent element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [includeHidden] | <code>Boolean</code> | <code>false</code> | Specifies if hidden elements are also considered. By default it checks only for visible ones. |

**Example**  
```js
const elem = await nonUi5.element.getByParent(".form01", ".input01");
```
<a name="nonUi5.element.isVisible"></a>

#### element.isVisible(element, [strict]) ⇒ <code>Boolean</code>
Returns a boolean if the element is visible to the user.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| element | <code>Object</code> |  | The element. |
| [strict] | <code>Boolean</code> | <code>true</code> | If strict mode is enabled it will only return "true" if the element is visible on the page and within the viewport. If disabled, it will be sufficient if the element is visible on the page but not inside the current viewport. |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.element.isVisible(elem);
```
<a name="nonUi5.element.isPresent"></a>

#### element.isPresent(elem) ⇒ <code>Boolean</code>
Returns a boolean if the element is present at the DOM or not. It might be hidden.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Boolean</code> - Returns true or false.  

| Param | Type | Description |
| --- | --- | --- |
| elem | <code>Object</code> | The element. |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.element.isPresent(elem);
```
<a name="nonUi5.element.isEnabled"></a>

#### element.isEnabled(elem) ⇒ <code>Boolean</code>
Returns a boolean if the element is enabled or not.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>Boolean</code> - Returns true or false.  

| Param | Type | Description |
| --- | --- | --- |
| elem | <code>Element</code> | The element. |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.element.isEnabled(elem);
```
<a name="nonUi5.element.isPresentByCss"></a>

#### element.isPresentByCss(css, [index], [timeout]) ⇒ <code>boolean</code>
Returns a boolean if the element is present at the DOM or not.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| css | <code>String</code> |  | The CSS selector describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.isPresentByCss(".button01");
```
<a name="nonUi5.element.isPresentByXPath"></a>

#### element.isPresentByXPath(xpath, [index], [timeout]) ⇒ <code>boolean</code>
Returns a boolean if the element is present at the DOM or not.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| xpath | <code>String</code> |  | The XPath describing the element. |
| [index] | <code>Number</code> | <code>0</code> | The index of the element (in case there are more than one elements visible at the same time). |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await nonUi5.element.isPresentByXPath(".//*[text()='Create']");
```
<a name="nonUi5.element.isSelected"></a>

#### element.isSelected(elem) ⇒ <code>boolean</code>
Returns a boolean if the element (e.g. checkbox) is selected.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Description |
| --- | --- | --- |
| elem | <code>Object</code> | The element. |

**Example**  
```js
const elem = await nonUi5.element.getById("elem01");
const isSelected = await nonUi5.element.isSelected(elem);
```
<a name="nonUi5.element.getAttributeValue"></a>

#### element.getAttributeValue(elem, [attribute]) ⇒ <code>String</code>
Returns the attributes value of the passed element.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>String</code> - The attributes value of the element.  

| Param | Type | Description |
| --- | --- | --- |
| elem | <code>Object</code> | The element. |
| [attribute] | <code>String</code> | The attribute of the element. Leave empty to return the inner HTML value of the element. |

**Example**  
```js
const elem = await nonUi5.element.getById("elem01");
const text = await nonUi5.element.getAttributeValue(elem, "text");
```
**Example**  
```js
const elem = await nonUi5.element.getById("elem02");
const innerHTML = await nonUi5.element.getAttributeValue(elem);
```
<a name="nonUi5.element.getValue"></a>

#### element.getValue(elem) ⇒ <code>String</code>
Returns the value of the passed element.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>String</code> - The value of the element.  

| Param | Type | Description |
| --- | --- | --- |
| elem | <code>Object</code> | The element. |

**Example**  
```js
const elem = await nonUi5.element.getById("elem02");
const innerHTML = await nonUi5.element.getValue(elem);
```
<a name="nonUi5.element.getCssPropertyValue"></a>

#### element.getCssPropertyValue(elementOrSelector, cssProperty) ⇒ <code>String</code>
Returns the value of the passed CSS property of the element.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>String</code> - The value of the CSS property.  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| cssProperty | <code>String</code> | The CSS property of the element to get value. |

**Example**  
```js
const elem = await nonUi5.element.getById("elem01");
const color = await nonUi5.element.getCssPropertyValue(elem, "color");
```
<a name="nonUi5.element.setInnerHTML"></a>

#### element.setInnerHTML(elem) ⇒ <code>String</code>
Sets the innerHTML value of the given element.
CAUTION: Only use this if filling the value in the normal way is not working and if it is unavoidable. Keep in mind, that a user is not able to perform such actions.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  
**Returns**: <code>String</code> - The value to set.  

| Param | Type | Description |
| --- | --- | --- |
| elem | <code>Object</code> | The element. |

**Example**  
```js
const elem = await nonUi5.element.getById("text-editor");
await nonUi5.element.setInnerHTML(elem, "Hello World!");
```
<a name="nonUi5.element.highlight"></a>

#### element.highlight(elem, [duration], [color])
Highlights the passed element.

**Kind**: static method of [<code>element</code>](#nonUi5.element)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elem | <code>Object</code> |  | The element. |
| [duration] | <code>Integer</code> | <code>2000</code> | The duration of the highlighting (ms). |
| [color] | <code>String</code> | <code>&quot;red&quot;</code> | The color of the highlighting (CSS value). |

**Example**  
```js
const elem = await nonUi5.element.getById("text01");
await nonUi5.element.highlight(elem);
```
**Example**  
```js
const elem = await nonUi5.element.getById("text01");
await nonUi5.element.highlight(elem, 3000, "green");
```
<a name="nonUi5.navigation"></a>

### nonUi5.navigation
**Kind**: static class of [<code>nonUi5</code>](#nonUi5)  
<a name="nonUi5.navigation.navigateToApplication"></a>

#### navigation.navigateToApplication(relativeReference, [refresh])
Navigates to the application via the passed relative reference. The path will be added to the baseUrl maintained in the config.

**Kind**: static method of [<code>navigation</code>](#nonUi5.navigation)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| relativeReference | <code>String</code> |  | Relative reference of an application (path, query and fragment) |
| [refresh] | <code>Boolean</code> | <code>true</code> | Refresh the page after navigation. |

**Example**  
```js
await nonUi5.navigation.navigateToApplication("categories");
```
<a name="nonUi5.session"></a>

### nonUi5.session
**Kind**: static class of [<code>nonUi5</code>](#nonUi5)  
<a name="nonUi5.session.loginSapNetWeaver"></a>

#### session.loginSapNetWeaver(username, password, [clickContinue], [iframeCssSelector])
Login for SAP NetWebGUI form and specific username and password.

**Kind**: static method of [<code>session</code>](#nonUi5.session)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| username | <code>String</code> |  | The username. |
| password | <code>String</code> |  | The password. |
| [clickContinue] | <code>Boolean</code> | <code>true</code> | Specifies if the function will press continue if applicable. |
| [iframeCssSelector] | <code>String</code> | <code>&quot;iframe&quot;</code> | The specific iframe selector the login form is contained. |

**Example**  
```js
await nonUi5.session.loginSapNetWeaver("john", "abc123!");
```
<a name="nonUi5.userInteraction"></a>

### nonUi5.userInteraction
**Kind**: static class of [<code>nonUi5</code>](#nonUi5)  

* [.userInteraction](#nonUi5.userInteraction)
    * [.click(elementOrSelector, [timeout])](#nonUi5.userInteraction.click)
    * [.clickAndRetry(elementOrSelector, [timeout], [retries], [interval])](#nonUi5.userInteraction.clickAndRetry)
    * [.doubleClick(elementOrSelector, [timeout])](#nonUi5.userInteraction.doubleClick)
    * [.rightClick(elementOrSelector, [timeout])](#nonUi5.userInteraction.rightClick)
    * [.check(elementOrSelector)](#nonUi5.userInteraction.check)
    * [.uncheck(elementOrSelector)](#nonUi5.userInteraction.uncheck)
    * [.fill(elementOrSelector, value)](#nonUi5.userInteraction.fill)
    * [.fillAndRetry(elementOrSelector, value, [retries], [interval])](#nonUi5.userInteraction.fillAndRetry)
    * [.clear(elementOrSelector)](#nonUi5.userInteraction.clear)
    * [.clearAndRetry(elementOrSelector, [retries], [interval])](#nonUi5.userInteraction.clearAndRetry)
    * [.clearAndFill(elementOrSelector, value)](#nonUi5.userInteraction.clearAndFill)
    * [.clearAndFillAndRetry(elementOrSelector, value, [retries], [interval], [verify])](#nonUi5.userInteraction.clearAndFillAndRetry)
    * [.mouseOverElement(elementOrSelector, [xOffset], [yOffset])](#nonUi5.userInteraction.mouseOverElement)
    * [.scrollToElement(elem, [alignment])](#nonUi5.userInteraction.scrollToElement)
    * [.dragAndDrop(elementOrSelector, targetElem)](#nonUi5.userInteraction.dragAndDrop)
    * [.moveCursorAndClick(elementOrSelector)](#nonUi5.userInteraction.moveCursorAndClick)
    * [.clickElementInSvg(elementOrSelector, innerSelector)](#nonUi5.userInteraction.clickElementInSvg)

<a name="nonUi5.userInteraction.click"></a>

#### userInteraction.click(elementOrSelector, [timeout])
Clicks on the passed element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.userInteraction.click(elem);
```
<a name="nonUi5.userInteraction.clickAndRetry"></a>

#### userInteraction.clickAndRetry(elementOrSelector, [timeout], [retries], [interval])
Clicks on the passed element, retries in case it fails.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.userInteraction.clickAndRetry(elem);
```
<a name="nonUi5.userInteraction.doubleClick"></a>

#### userInteraction.doubleClick(elementOrSelector, [timeout])
Double Clicks on the passed element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.userInteraction.doubleClick(elem);
```
<a name="nonUi5.userInteraction.rightClick"></a>

#### userInteraction.rightClick(elementOrSelector, [timeout])
Right Clicks on the passed element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
const elem = await nonUi5.element.getById("button01");
await nonUi5.userInteraction.rightClick(elem);
```
<a name="nonUi5.userInteraction.check"></a>

#### userInteraction.check(elementOrSelector)
Checks the given checkbox.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |

**Example**  
```js
await nonUi5.userInteraction.check(selector);
```
<a name="nonUi5.userInteraction.uncheck"></a>

#### userInteraction.uncheck(elementOrSelector)
Unchecks the given checkbox.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |

**Example**  
```js
await nonUi5.userInteraction.uncheck(selector);
```
<a name="nonUi5.userInteraction.fill"></a>

#### userInteraction.fill(elementOrSelector, value)
Fills the given value into the passed input.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| value | <code>String</code> \| <code>Number</code> | The value to enter. |

**Example**  
```js
const elem = await nonUi5.element.getById("input01");
await nonUi5.userInteraction.fill(elem, "Service 01");
```
<a name="nonUi5.userInteraction.fillAndRetry"></a>

#### userInteraction.fillAndRetry(elementOrSelector, value, [retries], [interval])
Fills the given value into the passed input, retries in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| value | <code>String</code> \| <code>Number</code> |  | The value to enter. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
const elem = await nonUi5.element.getById("input01");
await nonUi5.userInteraction.fillAndRetry(elem, "Service 01");
```
<a name="nonUi5.userInteraction.clear"></a>

#### userInteraction.clear(elementOrSelector)
Clears the passed input element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |

**Example**  
```js
const elem = await nonUi5.element.getById("input01");
await nonUi5.userInteraction.clear(elem);
```
<a name="nonUi5.userInteraction.clearAndRetry"></a>

#### userInteraction.clearAndRetry(elementOrSelector, [retries], [interval])
Clears the passed input element, retries in case of a failure.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |

**Example**  
```js
const elem = await nonUi5.element.getById("input01", 10000);
await nonUi5.userInteraction.clearAndRetry(elem);
```
<a name="nonUi5.userInteraction.clearAndFill"></a>

#### userInteraction.clearAndFill(elementOrSelector, value)
Clears and fills the passed input element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| value | <code>String</code> \| <code>Number</code> | The value to enter in. |

**Example**  
```js
const elem = await nonUi5.element.getById("input01");
await nonUi5.userInteraction.clearAndFill(elem, "Service 01");
```
<a name="nonUi5.userInteraction.clearAndFillAndRetry"></a>

#### userInteraction.clearAndFillAndRetry(elementOrSelector, value, [retries], [interval], [verify])
Clears and fills the passed input, retries in case it fails.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element or CSS selector describing the element. |
| value | <code>String</code> \| <code>Number</code> |  | The value to enter in. |
| [retries] | <code>Number</code> | <code>3</code> | The number of retries, can be set in config for all functions under params stepsRetries. |
| [interval] | <code>Number</code> | <code>5000</code> | The delay between the retries (ms). Can be set in config for all functions under params.stepRetriesIntervals. |
| [verify] | <code>Boolean</code> | <code>true</code> | Specifies if the filled value should be verified. |

**Example**  
```js
const elem = await nonUi5.element.getById("input01");
await nonUi5.userInteraction.clearAndFillAndRetry(elem, "Service 01");
```
<a name="nonUi5.userInteraction.mouseOverElement"></a>

#### userInteraction.mouseOverElement(elementOrSelector, [xOffset], [yOffset])
Moves the cursor/focus to the passed element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| [xOffset] | <code>Number</code> | X offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element. |
| [yOffset] | <code>Number</code> | Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element. |

**Example**  
```js
const elem = await nonUi5.element.getById("dropdown42");
await nonUi5.userInteraction.mouseOverElement(elem);
```
<a name="nonUi5.userInteraction.scrollToElement"></a>

#### userInteraction.scrollToElement(elem, [alignment])
Scrolls an element into view.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elem | <code>Element</code> |  | The target element to scroll to. |
| [alignment] | <code>String</code> \| <code>Object</code> | <code>&quot;center&quot;</code> | The alignment option for scrolling.   Can be one of: "start", "center", "end", "nearest", or an object with properties:   - block: Vertical alignment ("start", "center", "end", "nearest").   - inline: Horizontal alignment ("start", "center", "end", "nearest"). |

**Example**  
```js
// Scroll to element with center alignment.
const elem = await nonUi5.element.getById("footer01");
await nonUi5.userInteraction.scrollToElement(elem, "center");
```
**Example**  
```js
// Scroll to element with custom alignment.
const elem = await nonUi5.element.getById("footer01");
const alignment = {
  block: "start",
  inline: "center"
};
await nonUi5.userInteraction.scrollToElement(elem, alignment);
```
<a name="nonUi5.userInteraction.dragAndDrop"></a>

#### userInteraction.dragAndDrop(elementOrSelector, targetElem)
Drags and drops the given element to the given target element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |
| targetElem | <code>Object</code> | The target element to drop the element. |

**Example**  
```js
const elem = await nonUi5.element.getById("drag01");
```
**Example**  
```js
const targetElem = await nonUi5.element.getById("drop02");
await nonUi5.userInteraction.dragAndDrop(elem, targetElem);
```
<a name="nonUi5.userInteraction.moveCursorAndClick"></a>

#### userInteraction.moveCursorAndClick(elementOrSelector)
Moves the cursor to the target element and clicks on it. Can be used for charts.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element or CSS selector describing the element. |

**Example**  
```js
const elem = await nonUi5.element.getById("chartPartToClick");
await nonUi5.userInteraction.moveCursorAndClick(elem);
```
<a name="nonUi5.userInteraction.clickElementInSvg"></a>

#### userInteraction.clickElementInSvg(elementOrSelector, innerSelector)
Clicks on an inner element within a SVG element.

**Kind**: static method of [<code>userInteraction</code>](#nonUi5.userInteraction)  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Object</code> \| <code>string</code> | The SVG element or CSS selector describing the element. |
| innerSelector | <code>String</code> | The CSS selector describing the inner element to be clicked. |

**Example**  
```js
const svgElem = await nonUi5.element.getByCss("svg");
const innerSelector = "circle:nth-child(6)";
await nonUi5.userInteraction.clickElementInSvg(svgElem, innerSelector);
```
<a name="service"></a>

## service
Global namespace for service modules.

**Kind**: global constant  

* [service](#service)
    * [.odata](#service.odata)
        * [.init(url, username, password, [loggingEnabled], [params], [authType], [headers])](#service.odata.init) ⇒ <code>Object</code>
        * [.get(srv, entitySet, keys, [raw], [headers], [queryParams])](#service.odata.get) ⇒ <code>Promise</code>
        * [.getEntitySet(srv, entitySet, [filterString], [selectionFields], [queryParams])](#service.odata.getEntitySet) ⇒ <code>Promise</code>
        * [.post(srv, entitySet, payload, [raw], [headers], [queryParams])](#service.odata.post) ⇒ <code>Promise</code>
        * [.merge(srv, entitySet, payload, [headers])](#service.odata.merge) ⇒ <code>Promise</code>
        * [.patch(srv, entitySet, payload, [headers])](#service.odata.patch) ⇒ <code>Promise</code>
        * [.delete(srv, entitySet, options, [headers])](#service.odata.delete) ⇒ <code>Promise</code>
        * [.callFunctionImport(srv, functionImportName, options)](#service.odata.callFunctionImport) ⇒ <code>Promise</code>
        * [.isFeatureToggleActivated(srv, featureName)](#service.odata.isFeatureToggleActivated) ⇒ <code>Promise</code>
        * [.getOutputManagementPdfStream(outputConf, url, username, password)](#service.odata.getOutputManagementPdfStream)
        * [.readPdfFromDirectUrl(url, [username], [password], [isSaml])](#service.odata.readPdfFromDirectUrl)
    * [.rest](#service.rest)
        * [.init([customConfig])](#service.rest.init) ⇒ <code>Object</code>
        * [.get(uri, [config])](#service.rest.get) ⇒ <code>Object</code>
        * [.post(uri, payload, [config])](#service.rest.post) ⇒ <code>Object</code>
        * [.delete(uri, [config])](#service.rest.delete) ⇒ <code>Object</code>
        * [.patch(uri, payload, [config])](#service.rest.patch) ⇒ <code>Object</code>
        * [.put(uri, payload, [config])](#service.rest.put) ⇒ <code>Object</code>

<a name="service.odata"></a>

### service.odata
**Kind**: static class of [<code>service</code>](#service)  

* [.odata](#service.odata)
    * [.init(url, username, password, [loggingEnabled], [params], [authType], [headers])](#service.odata.init) ⇒ <code>Object</code>
    * [.get(srv, entitySet, keys, [raw], [headers], [queryParams])](#service.odata.get) ⇒ <code>Promise</code>
    * [.getEntitySet(srv, entitySet, [filterString], [selectionFields], [queryParams])](#service.odata.getEntitySet) ⇒ <code>Promise</code>
    * [.post(srv, entitySet, payload, [raw], [headers], [queryParams])](#service.odata.post) ⇒ <code>Promise</code>
    * [.merge(srv, entitySet, payload, [headers])](#service.odata.merge) ⇒ <code>Promise</code>
    * [.patch(srv, entitySet, payload, [headers])](#service.odata.patch) ⇒ <code>Promise</code>
    * [.delete(srv, entitySet, options, [headers])](#service.odata.delete) ⇒ <code>Promise</code>
    * [.callFunctionImport(srv, functionImportName, options)](#service.odata.callFunctionImport) ⇒ <code>Promise</code>
    * [.isFeatureToggleActivated(srv, featureName)](#service.odata.isFeatureToggleActivated) ⇒ <code>Promise</code>
    * [.getOutputManagementPdfStream(outputConf, url, username, password)](#service.odata.getOutputManagementPdfStream)
    * [.readPdfFromDirectUrl(url, [username], [password], [isSaml])](#service.odata.readPdfFromDirectUrl)

<a name="service.odata.init"></a>

#### odata.init(url, username, password, [loggingEnabled], [params], [authType], [headers]) ⇒ <code>Object</code>
Initializes the OData Service.
XCSRF-Token will be automatically fetched and stored in the service instance.
Cookies will also automatically assembled and stored in the service instance.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Object</code> - The initialized service object.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| url | <code>String</code> |  | The base url of the service. |
| username | <code>String</code> |  | The username to authenticate the service. |
| password | <code>String</code> |  | The password of the username. |
| [loggingEnabled] | <code>Boolean</code> | <code>false</code> | The boolean param to control whether user wants to see logs during build run. |
| [params] | <code>Object</code> | <code>{}</code> | JSON object with key-value pairs of parameter names and corresponding values. By default we send {  "client": "715",  "documentation": ["heading", "quickinfo"],  "language": "EN" } These can be overridden by sending params as JSON object with additional params as shown in example. |
| [authType] | <code>String</code> |  | authentication type, in case you want to override the default SAML authentication. Set this to "basic", to use basic authentication for communication users for whom SAML login doesn't work. Or "none" for no authentication. |
| [headers] | <code>Object</code> |  | JSON object with key-value pairs of optional headers. |

**Example**  
```js
const url = "<urlToSystem>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
const params = {
 "saml2": "disabled",
 "language": "de"
}
const srv = await service.odata.init(url, user, password, false, params);
```
**Example**  
```js
const base64Credentials = Buffer.from(`${user}:${password}`).toString("base64");
const authHeaders = {
  "Authorization": `Basic ${base64Credentials}`,
  "DwC-Tenant": tenant
};

const srv = await service.odata.init(url, user, password, true, params, "headers", authHeaders);
```
<a name="service.odata.get"></a>

#### odata.get(srv, entitySet, keys, [raw], [headers], [queryParams]) ⇒ <code>Promise</code>
Sends a GET request to retrieve data from the specified OData entity set.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| srv | <code>Object</code> |  | An instance of the service. |
| entitySet | <code>String</code> |  | The entity set from which data is to be retrieved. |
| keys | <code>Object</code> |  | The required keys for the GET request. |
| [raw] | <code>Boolean</code> | <code>false</code> | Specifies whether the response should include all header contents. |
| [headers] | <code>Object</code> |  | Optional headers to be included in the request. |
| [queryParams] | <code>Object</code> |  | JSON object of key value pairs of custom query parameters. |

**Example**  
```js
const url = "<baseUrl>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
const srv = await service.odata.init(url, user, password);
const keys = {
  PurchaseOrder: "4100000000"
};
const queryParams = {
 "$top" : 5,
 "$skip" : 10,
};
const headers = {
  'X-Custom-Header': 'foobar'
}
const res = await service.odata.get(srv, "A_PurchaseOrder", keys, false, headers, queryParams);
```
<a name="service.odata.getEntitySet"></a>

#### odata.getEntitySet(srv, entitySet, [filterString], [selectionFields], [queryParams]) ⇒ <code>Promise</code>
GET's the EntitySet collection.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Description |
| --- | --- | --- |
| srv | <code>Object</code> | Instance of the service |
| entitySet | <code>String</code> | The entitySet you want to GET from. |
| [filterString] | <code>String</code> | The filters to be applied on get query |
| [selectionFields] | <code>String</code> | comma separated list of fields to be selected |
| [queryParams] | <code>Object</code> | JSON object of key value pairs of custom query parameters. |

**Example**  
```js
const url = "<baseUrl>/sap/opu/odata/sap/API_PURCHASEORDER_PROCESS_SRV/";
srv = await service.odata.init(url, user, password);

let filterString = "Status eq '01'";
let res = await service.odata.getEntitySet(srv, "A_PurchaseOrder", filterString);

let select = "CentralPurchaseContract,PurchasingProcessingStatus" ;
let res = await service.odata.getEntitySet(srv, "A_PurchaseOrder", filterString, select);

let queryParams = {
 "$top" : 5,
 "$skip" : 10,
};
let res = await service.odata.getEntitySet(srv, "A_PurchaseOrder", filterString, select, queryParams);
```
<a name="service.odata.post"></a>

#### odata.post(srv, entitySet, payload, [raw], [headers], [queryParams]) ⇒ <code>Promise</code>
Sends a POST request to retrieve data from the specified OData entity set for the given payload.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| srv | <code>Object</code> |  | Instance of the service |
| entitySet | <code>String</code> |  | The entitySet you want to POST against. |
| payload | <code>Object</code> |  | The payload of the POST request. |
| [raw] | <code>Boolean</code> | <code>false</code> | Specifies whether the response should include all header contents. |
| [headers] | <code>Object</code> |  | Optional headers to be included in the request. |
| [queryParams] | <code>Object</code> |  | JSON object of key value pairs of custom query parameters. |

**Example**  
```js
const payload = {
 "PurchaseOrder": "4500007108",
 "DraftUUID": "00000000-0000-0000-0000-000000000000",
 "IsActiveEntity": "true"
};
const res = await service.odata.post(srv, "A_PurchaseOrder", payload);
```
<a name="service.odata.merge"></a>

#### odata.merge(srv, entitySet, payload, [headers]) ⇒ <code>Promise</code>
@description Sends a MERGE request to merge data from the specified OData entity set for the given payload.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Description |
| --- | --- | --- |
| srv | <code>Object</code> | Instance of the service |
| entitySet | <code>String</code> | The entitySet you want to MERGE in. |
| payload | <code>Object</code> | The payload of the MERGE request. |
| [headers] | <code>Object</code> | Optional headers to be included in the request. |

**Example**  
```js
const res = await service.odata.merge(srv, "A_PurchaseOrderScheduleLine", {
 "PurchasingDocument": "4500007108",
 "PurchasingDocumentItem": "10",
 "ScheduleLine": "1",
 "ScheduleLineDeliveryDate": new Date()
};
```
<a name="service.odata.patch"></a>

#### odata.patch(srv, entitySet, payload, [headers]) ⇒ <code>Promise</code>
@description Sends a PATCH request to patch data from the specified OData entity set for the given payload.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Description |
| --- | --- | --- |
| srv | <code>Object</code> | Instance of the service |
| entitySet | <code>String</code> | The entitySet you want to PATCH in. |
| payload | <code>Object</code> | The payload of the PATCH request. |
| [headers] | <code>Object</code> | Optional headers to be included in the request. |

**Example**  
```js
const res = await service.odata.patch(srv, "ContractAccountPartner", {
 "ContractAccount": "",
 "BusinessPartner": "",
 "DraftUUID": "42010aef-80aa-1fd0-8ec3-a11a9c56c3d3",
 "IsActiveEntity": "false",
 "CACompanyCodeGroup": "3910",
 "CAStandardCompanyCode": "3910"
};
```
<a name="service.odata.delete"></a>

#### odata.delete(srv, entitySet, options, [headers]) ⇒ <code>Promise</code>
Sends a DELETE request to the specified OData entity set.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Description |
| --- | --- | --- |
| srv | <code>Object</code> | Instance of the service. |
| entitySet | <code>String</code> | The entitySet you want to DELETE. |
| options | <code>Object</code> | The options for the DELETE request. |
| [headers] | <code>Object</code> | Optional headers to be included in the request. |

**Example**  
```js
const options = {
 "PurchaseOrder": "",
 "DraftUUID": draftUUID,
 "IsActiveEntity": false
};
const res = await service.odata.delete(srv, "C_PurchaseOrderTP", options);
```
<a name="service.odata.callFunctionImport"></a>

#### odata.callFunctionImport(srv, functionImportName, options) ⇒ <code>Promise</code>
Sends a function import request to the OData service instance.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to the response data.  

| Param | Type | Description |
| --- | --- | --- |
| srv | <code>Object</code> | Instance of the service. |
| functionImportName | <code>String</code> | Name of Function Import. |
| options | <code>Object</code> | Parameters for function import. |

**Example**  
```js
const options = {
 CentralRequestForQuotation : "7500000026",
 Supplier : "100006"
};
const res = await service.odata.callFunctionImport(srv, "Cancel", options);
```
<a name="service.odata.isFeatureToggleActivated"></a>

#### odata.isFeatureToggleActivated(srv, featureName) ⇒ <code>Promise</code>
Checks if a feature toggle is switched on or off.

**Kind**: static method of [<code>odata</code>](#service.odata)  
**Returns**: <code>Promise</code> - A Promise that resolves to a bool value.  

| Param | Type | Description |
| --- | --- | --- |
| srv | <code>Object</code> | Instance of the service |
| featureName | <code>String</code> | The name of the feature you want know the status of. |

**Example**  
```js
const url = browser.params.systemUrl + "/sap/opu/odata/SAP/CA_FM_FEATURE_TOGGLE_STATUS_SRV/";
const srv = await service.odata.init(url, user, password);
let isFeatureActive = await service.odata.isFeatureToggleActivated(srv, "MM_PUR_PO_BATCHES_IN_MANAGE_PO");
```
<a name="service.odata.getOutputManagementPdfStream"></a>

#### odata.getOutputManagementPdfStream(outputConf, url, username, password)
returns a stream of output management pdf file.

**Kind**: static method of [<code>odata</code>](#service.odata)  

| Param | Type | Description |
| --- | --- | --- |
| outputConf | <code>Object</code> | Configuration for the output management pdf. |
| url | <code>String</code> | system url |
| username | <code>String</code> | username for login |
| password | <code>String</code> | password for login |

**Example**  
```js
const outputConf =
 ApplObjectType: "REQUEST_FOR_QUOTATION",
 ApplObjectId: "7000002653",
 ItemId: "1"
};
const pdfStream = await service.odata.getOutputManagementPdfStream(outputConf, url, user, password);
```
<a name="service.odata.readPdfFromDirectUrl"></a>

#### odata.readPdfFromDirectUrl(url, [username], [password], [isSaml])
returns a stream of pdf file which is part of attachment.

**Kind**: static method of [<code>odata</code>](#service.odata)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| url | <code>String</code> |  | system url |
| [username] | <code>String</code> |  | username for login |
| [password] | <code>String</code> |  | password for login |
| [isSaml] | <code>Boolean</code> | <code>false</code> | use SAML login if true |

**Example**  
```js
const url = "https://domain.com/getPdfFile";
const pdfStream = await service.odata.readPdfFromDirectUrl(url, "username", "Password");
```
<a name="service.rest"></a>

### service.rest
**Kind**: static class of [<code>service</code>](#service)  

* [.rest](#service.rest)
    * [.init([customConfig])](#service.rest.init) ⇒ <code>Object</code>
    * [.get(uri, [config])](#service.rest.get) ⇒ <code>Object</code>
    * [.post(uri, payload, [config])](#service.rest.post) ⇒ <code>Object</code>
    * [.delete(uri, [config])](#service.rest.delete) ⇒ <code>Object</code>
    * [.patch(uri, payload, [config])](#service.rest.patch) ⇒ <code>Object</code>
    * [.put(uri, payload, [config])](#service.rest.put) ⇒ <code>Object</code>

<a name="service.rest.init"></a>

#### rest.init([customConfig]) ⇒ <code>Object</code>
Returns an axios instance for custom axios handling.

**Kind**: static method of [<code>rest</code>](#service.rest)  
**Returns**: <code>Object</code> - The axios instance.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [customConfig] | <code>Object</code> | <code>{}</code> | Custom config for axios. If not specified axios defaults will be taken. |

**Example**  
```js
const customConfig = {
      baseURL: 'https://some-domain.com/api/',
      timeout: 1000,
      headers: {
        'X-Custom-Header': 'foobar'
      }
const axios = service.rest.init(customConfig);
```
<a name="service.rest.get"></a>

#### rest.get(uri, [config]) ⇒ <code>Object</code>
makes a GET request.

**Kind**: static method of [<code>rest</code>](#service.rest)  
**Returns**: <code>Object</code> - The response of the GET request.  

| Param | Type | Description |
| --- | --- | --- |
| uri | <code>String</code> | The uri to the data source you want to GET. |
| [config] | <code>Object</code> | The config options for the request. |

**Example**  
```js
const uri = https://api.predic8.de/shop/products/";
let res = await service.rest.get(uri);
common.assertion.expectEqual(res.data.title, "qmate-service");
```
<a name="service.rest.post"></a>

#### rest.post(uri, payload, [config]) ⇒ <code>Object</code>
makes a POST request.

**Kind**: static method of [<code>rest</code>](#service.rest)  
**Returns**: <code>Object</code> - The response of the POST request.  

| Param | Type | Description |
| --- | --- | --- |
| uri | <code>String</code> | The uri to the data source you want to POST against. |
| payload | <code>Object</code> | The data you want to POST against your entity set. |
| [config] | <code>Object</code> | The config options for the request. |

**Example**  
```js
const payload = {
          id: 99,
          title: "qmate-service",
          author: "marvin"
        };
        const config = {
          headers: {
            "X-CSRF-TOKEN": "<CSRF TOKEN>",
            "Cookie": "<COOKIE>",
            "Content-Type": "application/json"
          }
        };
        let res = await service.rest.post(`${browser.config.baseUrl}/posts/99`, payload, config);
```
<a name="service.rest.delete"></a>

#### rest.delete(uri, [config]) ⇒ <code>Object</code>
makes a DELETE request.

**Kind**: static method of [<code>rest</code>](#service.rest)  
**Returns**: <code>Object</code> - The response of the DELETE request.  

| Param | Type | Description |
| --- | --- | --- |
| uri | <code>String</code> | The uri to the data source you want to DELETE. |
| [config] | <code>Object</code> | The config options for the request. |

**Example**  
```js
const config = {
          auth: {
            "username": "<username>",
            "password": "<password>"
          }
        };
        let res = await service.rest.delete(`${browser.config.baseUrl}/posts/99`, config);
```
<a name="service.rest.patch"></a>

#### rest.patch(uri, payload, [config]) ⇒ <code>Object</code>
makes a PATCH request.

**Kind**: static method of [<code>rest</code>](#service.rest)  
**Returns**: <code>Object</code> - The response of the PATCH request.  

| Param | Type | Description |
| --- | --- | --- |
| uri | <code>String</code> | The uri to the data source you want to PATCH. |
| payload | <code>Object</code> | The data to be used for updating the entity. |
| [config] | <code>Object</code> | The config options for the request. |

**Example**  
```js
const config = {
          auth: {
            "username": "<username>",
            "password": "<password>"
          }
        };
        const payload = {
          "title": "patched-qmate-service",
          "author": "qmate-tester"
        },
        let res = await service.rest.patch(`${browser.config.baseUrl}/posts/99`, payload, config);
```
<a name="service.rest.put"></a>

#### rest.put(uri, payload, [config]) ⇒ <code>Object</code>
makes a PUT request.

**Kind**: static method of [<code>rest</code>](#service.rest)  
**Returns**: <code>Object</code> - The response of the PUT request.  

| Param | Type | Description |
| --- | --- | --- |
| uri | <code>String</code> | The uri to the data source you want to PUT. |
| payload | <code>Object</code> | The data to be used for updating the entity. |
| [config] | <code>Object</code> | The config options for the request. |

**Example**  
```js
const config = {
          auth: {
            "username": "<username>",
            "password": "<password>"
          }
        }
        const payload = {
          "id": 99,
          "title": "put-qmate-service",
          "author": "qmate-tester"
        },
        let res = await service.rest.put(`${browser.config.baseUrl}/posts/99`, payload, config);
```
<a name="mobile"></a>

## mobile
Global namespace for mobile modules.

**Kind**: global constant  

* [mobile](#mobile)
    * [.android](#mobile.android)
        * [.pressKeyByName(keyName)](#mobile.android.pressKeyByName) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.pressKeyByCode(keyCode)](#mobile.android.pressKeyByCode) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.device](#mobile.device)
        * [.isAppInstalled(appPackageOrBundleId)](#mobile.device.isAppInstalled) ⇒ <code>boolean</code>
        * [.installApp(appPath)](#mobile.device.installApp) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.switchToContext([targetContext], [timeout])](#mobile.device.switchToContext) ⇒ <code>Promise.&lt;boolean&gt;</code>
        * [.getTargetContextIfAvailable([targetContext], [timeout])](#mobile.device.getTargetContextIfAvailable) ⇒ <code>Promise.&lt;(string\|null)&gt;</code>
        * [.closeApplication()](#mobile.device.closeApplication) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.queryAppState(appPackageOrBundleId)](#mobile.device.queryAppState) ⇒ <code>Promise.&lt;number&gt;</code>
        * [.launchApp(appPackageOrBundleId)](#mobile.device.launchApp) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.switchToLandscapeOrientation()](#mobile.device.switchToLandscapeOrientation) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.switchToPortraitOrientation()](#mobile.device.switchToPortraitOrientation) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.getCurrentOrientation()](#mobile.device.getCurrentOrientation) ⇒ <code>Promise.&lt;Orientation&gt;</code>
        * [.hideKeyboard(strategy, key, keyCode, [timeout])](#mobile.device.hideKeyboard) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.isKeyboardVisible()](#mobile.device.isKeyboardVisible) ⇒ <code>Promise.&lt;boolean&gt;</code>
        * [.isPlatformSupported()](#mobile.device.isPlatformSupported) ⇒ <code>Promise.&lt;boolean&gt;</code>
    * [.element](#mobile.element)
        * [.isVisible(element, [strict])](#mobile.element.isVisible) ⇒ <code>boolean</code>
        * [.isPresent(element)](#mobile.element.isPresent) ⇒ <code>boolean</code>
        * [.waitToBePresent(selector, [timeout])](#mobile.element.waitToBePresent) ⇒ <code>boolean</code>
        * [.waitToBeVisible(selector, [timeout])](#mobile.element.waitToBeVisible) ⇒ <code>boolean</code>
        * [.waitToBeClickable(selector, [timeout])](#mobile.element.waitToBeClickable) ⇒ <code>boolean</code>
        * [.isSelected(elementOrSelector)](#mobile.element.isSelected) ⇒ <code>boolean</code>
        * [.waitToBeEnabled(selector, [timeout])](#mobile.element.waitToBeEnabled) ⇒ <code>boolean</code>
    * [.gestures](#mobile.gestures)
        * [.swipe(startX, startY, endX, endY, [duration])](#mobile.gestures.swipe) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.tap(coordX, coordY)](#mobile.gestures.tap) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.ios](#mobile.ios)
    * [.userInteraction](#mobile.userInteraction)
        * [.tap(elementOrSelector, [timeout])](#mobile.userInteraction.tap)
        * [.check(elementOrSelector, [timeout])](#mobile.userInteraction.check)
        * [.uncheck(elementOrSelector, [timeout])](#mobile.userInteraction.uncheck)
        * [.doubleTap(elementOrSelector, [timeout])](#mobile.userInteraction.doubleTap) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.fill(elementOrSelector, value, [timeout])](#mobile.userInteraction.fill) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.clearAndFill(elementOrSelector, value, [timeout])](#mobile.userInteraction.clearAndFill) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.clear(elementOrSelector, [timeout])](#mobile.userInteraction.clear) ⇒ <code>Promise.&lt;void&gt;</code>

<a name="mobile.android"></a>

### mobile.android
**Kind**: static class of [<code>mobile</code>](#mobile)  

* [.android](#mobile.android)
    * [.pressKeyByName(keyName)](#mobile.android.pressKeyByName) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.pressKeyByCode(keyCode)](#mobile.android.pressKeyByCode) ⇒ <code>Promise.&lt;void&gt;</code>

<a name="mobile.android.pressKeyByName"></a>

#### android.pressKeyByName(keyName) ⇒ <code>Promise.&lt;void&gt;</code>
Simulate pressing a hardware key on the android device (e.g., back button, home button, etc.),

**Kind**: static method of [<code>android</code>](#mobile.android)  

| Param | Type | Description |
| --- | --- | --- |
| keyName | <code>string</code> | The name of the key (e.g., "back", "home", "volumeUp", etc.) |

**Example**  
```js
await mobile.android.pressKeyByName("back");
await mobile.android.pressKeyByName("home");
```
<a name="mobile.android.pressKeyByCode"></a>

#### android.pressKeyByCode(keyCode) ⇒ <code>Promise.&lt;void&gt;</code>
Simulate pressing a hardware key on the android device (e.g., back button, home button, etc.),

**Kind**: static method of [<code>android</code>](#mobile.android)  
**See**: https://developer.android.com/reference/android/view/KeyEvent  

| Param | Type | Description |
| --- | --- | --- |
| keyCode | <code>string</code> | The code of the key (e.g., 4 (back), 3 (home) , etc.) |

**Example**  
```js
await mobile.android.pressKeyByCode(4);
```
<a name="mobile.device"></a>

### mobile.device
**Kind**: static class of [<code>mobile</code>](#mobile)  

* [.device](#mobile.device)
    * [.isAppInstalled(appPackageOrBundleId)](#mobile.device.isAppInstalled) ⇒ <code>boolean</code>
    * [.installApp(appPath)](#mobile.device.installApp) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.switchToContext([targetContext], [timeout])](#mobile.device.switchToContext) ⇒ <code>Promise.&lt;boolean&gt;</code>
    * [.getTargetContextIfAvailable([targetContext], [timeout])](#mobile.device.getTargetContextIfAvailable) ⇒ <code>Promise.&lt;(string\|null)&gt;</code>
    * [.closeApplication()](#mobile.device.closeApplication) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.queryAppState(appPackageOrBundleId)](#mobile.device.queryAppState) ⇒ <code>Promise.&lt;number&gt;</code>
    * [.launchApp(appPackageOrBundleId)](#mobile.device.launchApp) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.switchToLandscapeOrientation()](#mobile.device.switchToLandscapeOrientation) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.switchToPortraitOrientation()](#mobile.device.switchToPortraitOrientation) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.getCurrentOrientation()](#mobile.device.getCurrentOrientation) ⇒ <code>Promise.&lt;Orientation&gt;</code>
    * [.hideKeyboard(strategy, key, keyCode, [timeout])](#mobile.device.hideKeyboard) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.isKeyboardVisible()](#mobile.device.isKeyboardVisible) ⇒ <code>Promise.&lt;boolean&gt;</code>
    * [.isPlatformSupported()](#mobile.device.isPlatformSupported) ⇒ <code>Promise.&lt;boolean&gt;</code>

<a name="mobile.device.isAppInstalled"></a>

#### device.isAppInstalled(appPackageOrBundleId) ⇒ <code>boolean</code>
Check if the application identified by its Package name/Bundle ID is installed on the device.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>boolean</code> - - Returns `true` if specified app package/bundled installed in the device, or `false`.  

| Param | Type | Description |
| --- | --- | --- |
| appPackageOrBundleId | <code>string</code> | Android package Name, or iOS bundle Id. |

**Example**  
```js
await mobile.device.isAppInstalled("com.google.android.apps.maps");
await mobile.device.isAppInstalled("com.apple.AppStore")
```
<a name="mobile.device.installApp"></a>

#### device.installApp(appPath) ⇒ <code>Promise.&lt;void&gt;</code>
Install the appropriate app based on the platform the test is being executed on.

**Kind**: static method of [<code>device</code>](#mobile.device)  

| Param | Type | Description |
| --- | --- | --- |
| appPath | <code>string</code> | Path of the app(.apk, .ipa) |

**Example**  
```js
await mobile.device.installApp("/path/to/your/app.apk");
await mobile.device.installApp("/path/to/your/app.ipa");
```
<a name="mobile.device.switchToContext"></a>

#### device.switchToContext([targetContext], [timeout]) ⇒ <code>Promise.&lt;boolean&gt;</code>
Switch to the specified( WEBVIEW | NATIVE_APP ) context if available.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;boolean&gt;</code> - Returns `true` if the context is successfully switched, otherwise `false`.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [targetContext] | <code>string</code> | <code>&quot;&#x27;WEBVIEW&#x27;&quot;</code> | The name of the target context. |
| [timeout] | <code>number</code> | <code>5000</code> | Maximum time to wait for the web context to appear, milliseconds. |

**Example**  
```js
await mobile.device.switchToContext();
await mobile.device.switchToContext("NATIVE_APP", 1000);
```
<a name="mobile.device.getTargetContextIfAvailable"></a>

#### device.getTargetContextIfAvailable([targetContext], [timeout]) ⇒ <code>Promise.&lt;(string\|null)&gt;</code>
Returns the specified target context if available within a given timeout.

This method retrieves the list of available contexts and determines if a context
that matches the `targetContext` string is present. If the target context is found,
it returns the context name; otherwise, it returns `null`.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;(string\|null)&gt;</code> - The name of the target context if found, or `null` if
  the context is not available within the timeout.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [targetContext] | <code>string</code> | <code>&quot;&#x27;WEBVIEW&#x27;&quot;</code> | The name of the target context to check for.   Common examples are `WEBVIEW` or `NATIVE_APP`. |
| [timeout] | <code>number</code> | <code>5000</code> | The maximum time, in milliseconds, to wait for the target   context to become available. |

**Example**  
```js
const context = await getTargetContextIfAvailable("WEBVIEW", 10000);
const context = await getTargetContextIfAvailable("NATIVE_APP", 10000);
```
<a name="mobile.device.closeApplication"></a>

#### device.closeApplication() ⇒ <code>Promise.&lt;void&gt;</code>
Close the currently active mobile application.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Example**  
```js
await mobile.device.closeApplication();
```
<a name="mobile.device.queryAppState"></a>

#### device.queryAppState(appPackageOrBundleId) ⇒ <code>Promise.&lt;number&gt;</code>
Queries the state of the application (e.g., running, background, not installed) on the mobile device(Android or iOS).

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;number&gt;</code> - - The app state:
 0 - Not running,
 1 - Not installed,
 2 - Running in the background (not suspended),
 3 - Running in the background (suspended),
 4 - Running in the foreground.  

| Param | Type | Description |
| --- | --- | --- |
| appPackageOrBundleId | <code>string</code> | Package name (Android) or bundle ID (iOS) of the application. |

**Example**  
```js
await mobile.device.queryAppState("com.google.android.apps.maps");
await mobile.device.queryAppState("com.apple.AppStore");
```
<a name="mobile.device.launchApp"></a>

#### device.launchApp(appPackageOrBundleId) ⇒ <code>Promise.&lt;void&gt;</code>
Launches the app for both iOS and Android with a parameterized app identifier.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;void&gt;</code> - Resolves when the app is successfully launched.  

| Param | Type | Description |
| --- | --- | --- |
| appPackageOrBundleId | <code>string</code> | The Android package name or iOS bundle ID of the application. |

**Example**  
```js
await mobile.device.launchApp("com.google.android.apps.maps");
await mobile.device.launchApp("com.apple.AppStore");
```
<a name="mobile.device.switchToLandscapeOrientation"></a>

#### device.switchToLandscapeOrientation() ⇒ <code>Promise.&lt;void&gt;</code>
Switches the device orientation to landscape mode.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;void&gt;</code> - Resolves when the orientation is successfully switched.  
**Example**  
```js
await mobile.device.switchToLandscapeOrientation();
```
<a name="mobile.device.switchToPortraitOrientation"></a>

#### device.switchToPortraitOrientation() ⇒ <code>Promise.&lt;void&gt;</code>
Switches the device orientation to portrait mode.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;void&gt;</code> - Resolves when the orientation is successfully switched.  
**Example**  
```js
await mobile.device.switchToPortraitOrientation();
```
<a name="mobile.device.getCurrentOrientation"></a>

#### device.getCurrentOrientation() ⇒ <code>Promise.&lt;Orientation&gt;</code>
Returns the device current orientation (PORTRAIT or LANDSCAPE)

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;Orientation&gt;</code> - The current device orientation.  
**Example**  
```js
await mobile.device.getCurrentOrientation();
```
<a name="mobile.device.hideKeyboard"></a>

#### device.hideKeyboard(strategy, key, keyCode, [timeout]) ⇒ <code>Promise.&lt;void&gt;</code>
Hides the keyboard on both Android and iOS using specific strategies with timeout.

**Kind**: static method of [<code>device</code>](#mobile.device)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| strategy | <code>string</code> |  | Strategy to use for hiding the keyboard ('pressKey', 'tapOutside', 'swipeDown'). |
| key | <code>string</code> |  | Key to press if using the 'pressKey' strategy (e.g., 'Done', 'Enter'). |
| keyCode | <code>number</code> |  | Key code for Android (optional). |
| [timeout] | <code>number</code> | <code>5000</code> | Timeout in milliseconds for retrying to hide the keyboard. |

**Example**  
```js
await mobile.device.hideKeyboard();
await mobile.device.hideKeyboard('tapOutside');
await mobile.device.hideKeyboard('swipeDown');
//Android only, Sends a specific key code, like 66 for "Enter."
await mobile.device.hideKeyboard('pressKey', undefined, 66);
await mobile.device.hideKeyboard('pressKey', 'Done');
```
<a name="mobile.device.isKeyboardVisible"></a>

#### device.isKeyboardVisible() ⇒ <code>Promise.&lt;boolean&gt;</code>
Checks if the keyboard is visible or not on the mobile device.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;boolean&gt;</code> - Returns `true` if the keyboard is visible on the mobile view.  
**Example**  
```js
await mobile.device.isKeyboardVisible();
```
<a name="mobile.device.isPlatformSupported"></a>

#### device.isPlatformSupported() ⇒ <code>Promise.&lt;boolean&gt;</code>
Determine if the current platform is supported, if the current device platform is either `Android` or `iOS`.

**Kind**: static method of [<code>device</code>](#mobile.device)  
**Returns**: <code>Promise.&lt;boolean&gt;</code> - If neither Android nor iOS is detected (e.g., Windows, Linux, or web), the condition evaluates to false  
**Example**  
```js
await mobile.device.isPlatformSupported();
```
<a name="mobile.element"></a>

### mobile.element
**Kind**: static class of [<code>mobile</code>](#mobile)  

* [.element](#mobile.element)
    * [.isVisible(element, [strict])](#mobile.element.isVisible) ⇒ <code>boolean</code>
    * [.isPresent(element)](#mobile.element.isPresent) ⇒ <code>boolean</code>
    * [.waitToBePresent(selector, [timeout])](#mobile.element.waitToBePresent) ⇒ <code>boolean</code>
    * [.waitToBeVisible(selector, [timeout])](#mobile.element.waitToBeVisible) ⇒ <code>boolean</code>
    * [.waitToBeClickable(selector, [timeout])](#mobile.element.waitToBeClickable) ⇒ <code>boolean</code>
    * [.isSelected(elementOrSelector)](#mobile.element.isSelected) ⇒ <code>boolean</code>
    * [.waitToBeEnabled(selector, [timeout])](#mobile.element.waitToBeEnabled) ⇒ <code>boolean</code>

<a name="mobile.element.isVisible"></a>

#### element.isVisible(element, [strict]) ⇒ <code>boolean</code>
Returns a boolean if the mobile element is visible to the user.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| element | <code>Element</code> |  | The Mobile Ui element. |
| [strict] | <code>boolean</code> | <code>true</code> | If strict mode is enabled it will only return "true" if the element is visible on the mobile view and within the viewport. If "false", it will be sufficient if the element is visible on the view but not inside the current viewport. |

**Example**  
```js
await mobile.element.isVisible(elem);
```
<a name="mobile.element.isPresent"></a>

#### element.isPresent(element) ⇒ <code>boolean</code>
Returns a boolean if the element is present at the DOM or not. It might be hidden.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Description |
| --- | --- | --- |
| element | <code>Element</code> | The element. |

**Example**  
```js
await mobile.element.isPresent(elem);
```
<a name="mobile.element.waitToBePresent"></a>

#### element.waitToBePresent(selector, [timeout]) ⇒ <code>boolean</code>
Waits until the element with the given selector is present.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.element.waitToBePresent(".input01");
await mobile.element.waitToBePresent("#button12");
await mobile.element.waitToBePresent("p:first-child");
```
<a name="mobile.element.waitToBeVisible"></a>

#### element.waitToBeVisible(selector, [timeout]) ⇒ <code>boolean</code>
Waits until the element with the given selector is visible.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.element.waitToBeVisible(".input01");
await mobile.element.waitToBeVisible("#button12");
await mobile.element.waitToBeVisible("p:first-child");
```
<a name="mobile.element.waitToBeClickable"></a>

#### element.waitToBeClickable(selector, [timeout]) ⇒ <code>boolean</code>
Waits until the element with the given selector is clickable.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.element.waitToBeClickable(".input01");
await mobile.element.waitToBeClickable("#button12");
await mobile.element.waitToBeClickable("p:first-child");
```
<a name="mobile.element.isSelected"></a>

#### element.isSelected(elementOrSelector) ⇒ <code>boolean</code>
Returns a boolean if the element (e.g. checkbox) is selected.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Description |
| --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> | The element. |

**Example**  
```js
const isSelected = await mobile.element.isSelected(elem);
```
<a name="mobile.element.waitToBeEnabled"></a>

#### element.waitToBeEnabled(selector, [timeout]) ⇒ <code>boolean</code>
Waits until the element with the given selector is present.

**Kind**: static method of [<code>element</code>](#mobile.element)  
**Returns**: <code>boolean</code> - Returns true or false.  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| selector | <code>Object</code> |  | The CSS selector describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.element.waitToBeEnabled(".input01");
await mobile.element.waitToBeEnabled("#button12");
await mobile.element.waitToBeEnabled("p:first-child");
```
<a name="mobile.gestures"></a>

### mobile.gestures
**Kind**: static class of [<code>mobile</code>](#mobile)  

* [.gestures](#mobile.gestures)
    * [.swipe(startX, startY, endX, endY, [duration])](#mobile.gestures.swipe) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.tap(coordX, coordY)](#mobile.gestures.tap) ⇒ <code>Promise.&lt;void&gt;</code>

<a name="mobile.gestures.swipe"></a>

#### gestures.swipe(startX, startY, endX, endY, [duration]) ⇒ <code>Promise.&lt;void&gt;</code>
Swipe from one point to another on the screen,
Ensure that the provided coordinates are within the bounds of the screen to avoid unexpected behavior.

**Kind**: static method of [<code>gestures</code>](#mobile.gestures)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| startX | <code>number</code> |  | The starting X coordinate of the swipe |
| startY | <code>number</code> |  | The starting Y coordinate of the swipe |
| endX | <code>number</code> |  | The ending X coordinate of the swipe |
| endY | <code>number</code> |  | The ending Y coordinate of the swipe |
| [duration] | <code>number</code> | <code>1000</code> | The duration of the swipe in milliseconds (optional, default is 1000ms) |

**Example**  
```js
// Swipes from left to right across the screen horizontally (useful for image carousels or galleries).
await mobile.gestures.swipe(100, 800, 800, 800);
// Swipes from bottom to top vertically to scroll down a list.
await mobile.gestures.swipe(300, 1000, 300, 400);
// Swipes from the top down to refresh content on a mobile app (common for pull-to-refresh).
await mobile.gestures.swipe(400, 200, 400, 800);
```
<a name="mobile.gestures.tap"></a>

#### gestures.tap(coordX, coordY) ⇒ <code>Promise.&lt;void&gt;</code>
Executes a tap at the given screen coordinates,
Ensure that the provided coordinates are within the bounds of the screen to avoid unexpected behavior.

**Kind**: static method of [<code>gestures</code>](#mobile.gestures)  

| Param | Type | Description |
| --- | --- | --- |
| coordX | <code>number</code> | The horizontal screen coordinate for the tap. |
| coordY | <code>number</code> | The vertical screen coordinate for the tap. |

**Example**  
```js
await mobile.gestures.tap(100, 800);
```
<a name="mobile.ios"></a>

### mobile.ios
**Kind**: static class of [<code>mobile</code>](#mobile)  
<a name="mobile.userInteraction"></a>

### mobile.userInteraction
**Kind**: static class of [<code>mobile</code>](#mobile)  

* [.userInteraction](#mobile.userInteraction)
    * [.tap(elementOrSelector, [timeout])](#mobile.userInteraction.tap)
    * [.check(elementOrSelector, [timeout])](#mobile.userInteraction.check)
    * [.uncheck(elementOrSelector, [timeout])](#mobile.userInteraction.uncheck)
    * [.doubleTap(elementOrSelector, [timeout])](#mobile.userInteraction.doubleTap) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.fill(elementOrSelector, value, [timeout])](#mobile.userInteraction.fill) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.clearAndFill(elementOrSelector, value, [timeout])](#mobile.userInteraction.clearAndFill) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.clear(elementOrSelector, [timeout])](#mobile.userInteraction.clear) ⇒ <code>Promise.&lt;void&gt;</code>

<a name="mobile.userInteraction.tap"></a>

#### userInteraction.tap(elementOrSelector, [timeout])
Tap's on the mobile element.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| [timeout] | <code>Number</code> | <code>30000</code> | The timeout to wait(ms) |

**Example**  
```js
await mobile.userInteraction.tap(elem);
await mobile.userInteraction.tap(elem, 20000);
```
<a name="mobile.userInteraction.check"></a>

#### userInteraction.check(elementOrSelector, [timeout])
Checks the given checkbox.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait(ms) |

**Example**  
```js
await mobile.userInteraction.check(element);
await mobile.userInteraction.check(element, 20000);
```
<a name="mobile.userInteraction.uncheck"></a>

#### userInteraction.uncheck(elementOrSelector, [timeout])
Unchecks the given checkbox.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait(ms) |

**Example**  
```js
await mobile.userInteraction.uncheck(elementOrSelector);
await mobile.userInteraction.uncheck(elementOrSelector, 20000);
```
<a name="mobile.userInteraction.doubleTap"></a>

#### userInteraction.doubleTap(elementOrSelector, [timeout]) ⇒ <code>Promise.&lt;void&gt;</code>
Double Tap's on the mobile element.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait(ms) |

**Example**  
```js
await mobile.userInteraction.doubleTap(elem);
await mobile.userInteraction.doubleTap(elem, 2000);
```
<a name="mobile.userInteraction.fill"></a>

#### userInteraction.fill(elementOrSelector, value, [timeout]) ⇒ <code>Promise.&lt;void&gt;</code>
Enter a string value into a mobile input field.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| value | <code>string</code> |  | The string value to be entered. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.userInteraction.fill(element);
await mobile.userInteraction.fill(element, 2000);
```
<a name="mobile.userInteraction.clearAndFill"></a>

#### userInteraction.clearAndFill(elementOrSelector, value, [timeout]) ⇒ <code>Promise.&lt;void&gt;</code>
Enter a string into the mobile input field; it will clear the box before submission.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| value | <code>string</code> |  | The string value to be entered. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.userInteraction.clearAndFill(element);
await mobile.userInteraction.clearAndFill(element, 2000);
```
<a name="mobile.userInteraction.clear"></a>

#### userInteraction.clear(elementOrSelector, [timeout]) ⇒ <code>Promise.&lt;void&gt;</code>
Clear a string value into a mobile input field.

**Kind**: static method of [<code>userInteraction</code>](#mobile.userInteraction)  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| elementOrSelector | <code>Element</code> \| <code>string</code> |  | The element (e.g., accessibility ID, XPath) selectors describing the element. |
| [timeout] | <code>number</code> | <code>30000</code> | The timeout to wait (ms). |

**Example**  
```js
await mobile.userInteraction.clear(element);
await mobile.userInteraction.clear(element, 2000);
```
<a name="flp"></a>

## flp
Global namespace for Fiori Launchpad (FLP) modules.

**Kind**: global constant  

* [flp](#flp)
    * [.userLocks](#flp.userLocks)
        * [.getNumberOfLockEntries(user, password, [technicalUserId])](#flp.userLocks.getNumberOfLockEntries) ⇒ <code>Promise.&lt;Number&gt;</code>
        * [.deleteExistingLockEntries(user, password, [technicalUserId])](#flp.userLocks.deleteExistingLockEntries)
    * [.userSettings](#flp.userSettings)
        * [.setLanguageFromUserSettings(user, password)](#flp.userSettings.setLanguageFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.setDateFormatFromUserSettings(user, password)](#flp.userSettings.setDateFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.setTimeFormatFromUserSettings(user, password)](#flp.userSettings.setTimeFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.setTimeZoneFromUserSettings(user, password)](#flp.userSettings.setTimeZoneFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.setNumberFormatFromUserSettings(user, password)](#flp.userSettings.setNumberFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.setS4UserSettings(user, password)](#flp.userSettings.setS4UserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
        * [.getLanguageFromUserSettings(user, password)](#flp.userSettings.getLanguageFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
        * [.getDateFormatFromUserSettings(user, password)](#flp.userSettings.getDateFormatFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
        * [.getTimeFormatFromUserSettings(user, password)](#flp.userSettings.getTimeFormatFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
        * [.getTimeZoneFromUserSettings(user, password)](#flp.userSettings.getTimeZoneFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
        * [.getNumberFormatFromUserSettings(user, password)](#flp.userSettings.getNumberFormatFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>

<a name="flp.userLocks"></a>

### flp.userLocks
**Kind**: static class of [<code>flp</code>](#flp)  

* [.userLocks](#flp.userLocks)
    * [.getNumberOfLockEntries(user, password, [technicalUserId])](#flp.userLocks.getNumberOfLockEntries) ⇒ <code>Promise.&lt;Number&gt;</code>
    * [.deleteExistingLockEntries(user, password, [technicalUserId])](#flp.userLocks.deleteExistingLockEntries)

<a name="flp.userLocks.getNumberOfLockEntries"></a>

#### userLocks.getNumberOfLockEntries(user, password, [technicalUserId]) ⇒ <code>Promise.&lt;Number&gt;</code>
Gets the number of lock entries for the given user.

**Kind**: static method of [<code>userLocks</code>](#flp.userLocks)  
**Returns**: <code>Promise.&lt;Number&gt;</code> - The number of lock entries.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The user name. |
| password | <code>String</code> | The password. |
| [technicalUserId] | <code>String</code> | The technical user ID. |

**Example**  
```js
const lockCount = await flp.userLocks.getNumberOfLockEntries("user", "password");
```
<a name="flp.userLocks.deleteExistingLockEntries"></a>

#### userLocks.deleteExistingLockEntries(user, password, [technicalUserId])
Deletes the existing lock entries for the given user.

**Kind**: static method of [<code>userLocks</code>](#flp.userLocks)  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The user name. |
| password | <code>String</code> | The password. |
| [technicalUserId] | <code>String</code> | The technical user ID. |

**Example**  
```js
await flp.userLocks.deleteExistingLockEntries("user", "password");
```
<a name="flp.userSettings"></a>

### flp.userSettings
**Kind**: static class of [<code>flp</code>](#flp)  

* [.userSettings](#flp.userSettings)
    * [.setLanguageFromUserSettings(user, password)](#flp.userSettings.setLanguageFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.setDateFormatFromUserSettings(user, password)](#flp.userSettings.setDateFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.setTimeFormatFromUserSettings(user, password)](#flp.userSettings.setTimeFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.setTimeZoneFromUserSettings(user, password)](#flp.userSettings.setTimeZoneFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.setNumberFormatFromUserSettings(user, password)](#flp.userSettings.setNumberFormatFromUserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.setS4UserSettings(user, password)](#flp.userSettings.setS4UserSettings) ⇒ <code>Promise.&lt;void&gt;</code>
    * [.getLanguageFromUserSettings(user, password)](#flp.userSettings.getLanguageFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
    * [.getDateFormatFromUserSettings(user, password)](#flp.userSettings.getDateFormatFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
    * [.getTimeFormatFromUserSettings(user, password)](#flp.userSettings.getTimeFormatFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
    * [.getTimeZoneFromUserSettings(user, password)](#flp.userSettings.getTimeZoneFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>
    * [.getNumberFormatFromUserSettings(user, password)](#flp.userSettings.getNumberFormatFromUserSettings) ⇒ <code>Promise.&lt;String&gt;</code>

<a name="flp.userSettings.setLanguageFromUserSettings"></a>

#### userSettings.setLanguageFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
Sets the environment variable 'USER_SETTINGS_LANG_KEY' language from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the language has been set.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
await flp.userSettings.setLanguageFromUserSettings("user", "password");
```
<a name="flp.userSettings.setDateFormatFromUserSettings"></a>

#### userSettings.setDateFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
Sets the environment variable 'USER_SETTINGS_DATE_FORMAT' date format from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the date format has been set.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
await flp.userSettings.setDateFormatFromUserSettings("user", "password");
```
<a name="flp.userSettings.setTimeFormatFromUserSettings"></a>

#### userSettings.setTimeFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
Sets the environment variable 'USER_SETTINGS_DATE_FORMAT' time format from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the time format has been set.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
await flp.userSettings.setTimeFormatFromUserSettings("user", "password");
```
<a name="flp.userSettings.setTimeZoneFromUserSettings"></a>

#### userSettings.setTimeZoneFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
Sets the environment variable 'USER_SETTINGS_TIME_ZONE' time zone from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the time zone has been set.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
await flp.userSettings.setTimeZoneFromUserSettings("user", "password");
```
<a name="flp.userSettings.setNumberFormatFromUserSettings"></a>

#### userSettings.setNumberFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
Sets the environment variable 'USER_SETTINGS_NUMBER_FORMAT' number format from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the number format has been set.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
await flp.userSettings.setNumberFormatFromUserSettings("user", "password");
```
<a name="flp.userSettings.setS4UserSettings"></a>

#### userSettings.setS4UserSettings(user, password) ⇒ <code>Promise.&lt;void&gt;</code>
Sets the user settings for S4.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;void&gt;</code> - A promise that resolves when the user settings have been set.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
await flp.userSettings.setS4UserSettings("user", "password");
```
<a name="flp.userSettings.getLanguageFromUserSettings"></a>

#### userSettings.getLanguageFromUserSettings(user, password) ⇒ <code>Promise.&lt;String&gt;</code>
Gets the language from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;String&gt;</code> - The language from user settings.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
const language = await flp.userSettings.getLanguageFromUserSettings("user", "password");
```
<a name="flp.userSettings.getDateFormatFromUserSettings"></a>

#### userSettings.getDateFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;String&gt;</code>
Gets the date format from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;String&gt;</code> - The date format from user settings.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
const dateFormat = await flp.userSettings.getDateFormatFromUserSettings("user", "password");
```
<a name="flp.userSettings.getTimeFormatFromUserSettings"></a>

#### userSettings.getTimeFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;String&gt;</code>
Gets the time format from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;String&gt;</code> - The time format from user settings.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
const timeFormat = await flp.userSettings.getTimeFormatFromUserSettings("user", "password");
```
<a name="flp.userSettings.getTimeZoneFromUserSettings"></a>

#### userSettings.getTimeZoneFromUserSettings(user, password) ⇒ <code>Promise.&lt;String&gt;</code>
Gets the time zone from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;String&gt;</code> - The time zone from user settings.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
const timeZone = await flp.userSettings.getTimeZoneFromUserSettings("user", "password");
```
<a name="flp.userSettings.getNumberFormatFromUserSettings"></a>

#### userSettings.getNumberFormatFromUserSettings(user, password) ⇒ <code>Promise.&lt;String&gt;</code>
Gets the number format from user settings.

**Kind**: static method of [<code>userSettings</code>](#flp.userSettings)  
**Returns**: <code>Promise.&lt;String&gt;</code> - The number format from user settings.  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>String</code> | The username for authentication. |
| password | <code>String</code> | The password for authentication. |

**Example**  
```js
const numberFormat = await flp.userSettings.getNumberFormatFromUserSettings("user", "password");
```