@sap_oss/wdio-qmate-service
Version:
[](https://api.reuse.software/info/github.com/SAP/wdio-qmate-service)[](http
1,913 lines (1,912 loc) • 162 kB
JSON
{
"common": {
"assertion": {
"expectEqual": {
"type": "sync",
"description": "Expects the passed values to be equal.",
"arguments": [
{
"name": "value1",
"type": "any",
"default": null
},
{
"name": "value2",
"type": "any",
"default": null
}
]
},
"expectUnequal": {
"type": "sync",
"description": "Expects the passed values to be unequal.",
"arguments": [
{
"name": "value1",
"type": "any",
"default": null
},
{
"name": "value2",
"type": "any",
"default": null
}
]
},
"expectTrue": {
"type": "sync",
"description": "Expects the passed value to be true.",
"arguments": [
{
"name": "value",
"type": "any",
"default": null
}
]
},
"expectFalse": {
"type": "sync",
"description": "Expects the passed value to be false.",
"arguments": [
{
"name": "value",
"type": "boolean",
"default": null
}
]
},
"expectDefined": {
"type": "sync",
"description": "Expects the passed values is defined.",
"arguments": [
{
"name": "value",
"type": "any",
"default": null
}
]
},
"expectUndefined": {
"type": "sync",
"description": "Expects the passed values is undefined.",
"arguments": [
{
"name": "value",
"type": "any",
"default": null
}
]
},
"expectUrlToBe": {
"type": "async",
"description": "Expects the url to be the passed value.",
"arguments": []
},
"expectToContain": {
"type": "async",
"description": "Expects the first passed value to contain the second passed value, after normalizing whitespace.",
"arguments": [
{
"name": "value1",
"type": "string",
"default": null
},
{
"name": "value2",
"type": "string",
"default": null
}
]
}
},
"date": {
"getToday": {
"type": "async",
"description": "Returns the current day in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"getTomorrow": {
"type": "async",
"description": "Returns tomorrows date in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"getNextMonth": {
"type": "async",
"description": "Returns the current day one month later in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"getPreviousMonth": {
"type": "async",
"description": "Returns the current day one month before in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"getNextYear": {
"type": "async",
"description": "Returns the current day one year later in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"getPreviousYear": {
"type": "async",
"description": "Returns the current day one year before in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"getSpecific": {
"type": "async",
"description": "Returns a specific date in the given format.",
"arguments": [
{
"name": "date",
"type": "string",
"default": null
},
{
"name": "format",
"type": "string",
"default": "\"object\""
}
],
"returnType": "string"
},
"calculate": {
"type": "async",
"description": "Calculates the date based on the input parameter and returns it in the given format.",
"arguments": [
{
"name": "date",
"type": "string",
"default": "\"today\""
},
{
"name": "format",
"type": "string",
"default": "\"object\""
}
]
},
"getCurrentDateAndTime": {
"type": "sync",
"description": "Returns the current date and time in the given format.",
"arguments": [
{
"name": "format",
"type": "string",
"default": "\"object\""
}
]
},
"calculateWithTime": {
"type": "sync",
"description": "Calculates the date and time based on the input parameter and returns it in the given format.",
"arguments": [
{
"name": "date",
"type": "string",
"default": "\"today\""
},
{
"name": "time",
"type": "string",
"default": null
},
{
"name": "format",
"type": "string",
"default": "\"object\""
}
]
}
},
"navigation": {
"navigateToUrl": {
"type": "async",
"description": "Navigates to the passed url.",
"arguments": [
{
"name": "url",
"type": "string",
"default": null
}
]
},
"navigateToUrlAndRetry": {
"type": "async",
"description": "Navigates to the passed url and retries the function in case of a failure.",
"arguments": [
{
"name": "url",
"type": "string",
"default": null
},
{
"name": "retries",
"type": "integer",
"default": "3"
},
{
"name": "interval",
"type": "integer",
"default": "5000"
}
]
}
},
"userInteraction": {
"fillActive": {
"type": "async",
"description": "Fills the active input with the given value.",
"arguments": [
{
"name": "value",
"type": "string",
"default": null
}
]
},
"fillActiveAndRetry": {
"type": "async",
"description": "Enters the given value to the active input field and retries the action in case it fails.",
"arguments": [
{
"name": "value",
"type": "string",
"default": null
},
{
"name": "retries",
"type": "number",
"default": 3
},
{
"name": "interval",
"type": "number",
"default": 5000
}
]
},
"clearAndFillActive": {
"type": "async",
"description": "Clears and fills the active input.",
"arguments": [
{
"name": "value",
"type": "string",
"default": null
}
]
},
"clearAndFillActiveAndRetry": {
"type": "async",
"description": "CClears and fills the active input. Retries the action in case of a failure.",
"arguments": [
{
"name": "value",
"type": "string",
"default": null
},
{
"name": "retries",
"type": "number",
"default": 3
},
{
"name": "interval",
"type": "number",
"default": 5000
}
]
},
"pressKey": {
"type": "async",
"description": "Performs the specified keypress. Possible values: <a href=\"https://w3c.github.io/webdriver/#keyboard-actions\" target=\"_blank\">WebDriver Keyboard Actions</a>",
"arguments": [
{
"name": "keys",
"type": "string",
"default": null
}
]
},
"pressEnter": {
"type": "async",
"description": "Performs the Enter keypress.",
"arguments": []
},
"pressTab": {
"type": "async",
"description": "Performs the Tab keypress.",
"arguments": []
},
"pressF4": {
"type": "async",
"description": "Performs the F4 keypress.",
"arguments": []
},
"pressBackspace": {
"type": "async",
"description": "Performs the Backspace keypress.",
"arguments": []
},
"pressEscape": {
"type": "async",
"description": "Performs the Escape keypress.",
"arguments": []
},
"pressArrowLeft": {
"type": "async",
"description": "Performs the Arrow Left keypress.",
"arguments": []
},
"pressArrowRight": {
"type": "async",
"description": "Performs the Arrow Right keypress.",
"arguments": []
}
}
},
"flp": {
"userLocks": {
"getNumberOfLockEntries": {
"type": "async",
"description": "Gets the number of lock entries for the given user.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
},
{
"name": "technicalUserId",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"deleteExistingLockEntries": {
"type": "async",
"description": "Deletes the existing lock entries for the given user.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
},
{
"name": "technicalUserId",
"type": "string",
"default": null
}
]
},
"getLockCount": {
"type": "sync",
"description": "Gets the number of locks for the user on the same session.",
"arguments": [
{
"name": "sessions",
"type": "array",
"default": null
}
],
"returnType": "number"
}
},
"userSettings": {
"setLanguageFromUserSettings": {
"type": "async",
"description": "Sets the environment variable 'USER_SETTINGS_LANG_KEY' language from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"setDateFormatFromUserSettings": {
"type": "async",
"description": "Sets the environment variable 'USER_SETTINGS_DATE_FORMAT' date format from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"setTimeFormatFromUserSettings": {
"type": "async",
"description": "Sets the environment variable 'USER_SETTINGS_DATE_FORMAT' time format from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"setTimeZoneFromUserSettings": {
"type": "async",
"description": "Sets the environment variable 'USER_SETTINGS_TIME_ZONE' time zone from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"setNumberFormatFromUserSettings": {
"type": "async",
"description": "Sets the environment variable 'USER_SETTINGS_NUMBER_FORMAT' number format from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"setS4UserSettings": {
"type": "async",
"description": "Sets the user settings for S4.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"getLanguageFromUserSettings": {
"type": "async",
"description": "Gets the language from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"getDateFormatFromUserSettings": {
"type": "async",
"description": "Gets the date format from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"getTimeFormatFromUserSettings": {
"type": "async",
"description": "Gets the time format from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"getTimeZoneFromUserSettings": {
"type": "async",
"description": "Gets the time zone from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"getNumberFormatFromUserSettings": {
"type": "async",
"description": "Gets the number format from user settings.",
"arguments": [
{
"name": "user",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
}
],
"returnType": "promise"
}
}
},
"mobile": {
"android": {
"pressKeyByName": {
"type": "async",
"description": "Simulate pressing a hardware key on the android device (e.g., back button, home button, etc.),",
"arguments": [
{
"name": "keyName",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"pressKeyByCode": {
"type": "async",
"description": "Simulate pressing a hardware key on the android device (e.g., back button, home button, etc.),",
"arguments": [
{
"name": "keyCode",
"type": "string",
"default": null
}
],
"returnType": "promise"
}
},
"device": {
"isAppInstalled": {
"type": "async",
"description": "Check if the application identified by its Package name/Bundle ID is installed on the device.",
"arguments": [
{
"name": "appPackageOrBundleId",
"type": "string",
"default": null
}
],
"returnType": "boolean"
},
"installApp": {
"type": "async",
"description": "Install the appropriate app based on the platform the test is being executed on.",
"arguments": [
{
"name": "appPath",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"switchToContext": {
"type": "async",
"description": "Switch to the specified( WEBVIEW | NATIVE_APP ) context if available.",
"arguments": [
{
"name": "targetContext",
"type": "string",
"default": "'WEBVIEW'"
},
{
"name": "timeout",
"type": "number",
"default": 5000
}
],
"returnType": "promise"
},
"getTargetContextIfAvailable": {
"type": "async",
"description": "Returns the specified target context if available within a given timeout.\n\nThis method retrieves the list of available contexts and determines if a context\nthat matches the `targetContext` string is present. If the target context is found,\nit returns the context name; otherwise, it returns `null`.",
"arguments": [
{
"name": "targetContext",
"type": "string",
"default": "'WEBVIEW'"
},
{
"name": "timeout",
"type": "number",
"default": 5000
}
],
"returnType": "promise"
},
"closeApplication": {
"type": "async",
"description": "Close the currently active mobile application.",
"arguments": [],
"returnType": "promise"
},
"queryAppState": {
"type": "async",
"description": "Queries the state of the application (e.g., running, background, not installed) on the mobile device(Android or iOS).",
"arguments": [
{
"name": "appPackageOrBundleId",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"launchApp": {
"type": "async",
"description": "Launches the app for both iOS and Android with a parameterized app identifier.",
"arguments": [
{
"name": "appPackageOrBundleId",
"type": "string",
"default": null
}
],
"returnType": "promise"
},
"switchToLandscapeOrientation": {
"type": "async",
"description": "Switches the device orientation to landscape mode.",
"arguments": [],
"returnType": "promise"
},
"switchToPortraitOrientation": {
"type": "async",
"description": "Switches the device orientation to portrait mode.",
"arguments": [],
"returnType": "promise"
},
"getCurrentOrientation": {
"type": "async",
"description": "Returns the device current orientation (PORTRAIT or LANDSCAPE)",
"arguments": [],
"returnType": "promise"
},
"hideKeyboard": {
"type": "async",
"description": "Hides the keyboard on both Android and iOS using specific strategies with timeout.",
"arguments": [
{
"name": "strategy",
"type": "string",
"default": null
},
{
"name": "key",
"type": "string",
"default": null
},
{
"name": "keyCode",
"type": "number",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 5000
}
],
"returnType": "promise"
},
"isKeyboardVisible": {
"type": "async",
"description": "Checks if the keyboard is visible or not on the mobile device.",
"arguments": [],
"returnType": "promise"
},
"isPlatformSupported": {
"type": "async",
"description": "Determine if the current platform is supported, if the current device platform is either `Android` or `iOS`.",
"arguments": [],
"returnType": "promise"
}
},
"element": {
"isVisible": {
"type": "async",
"description": "Returns a boolean if the mobile element is visible to the user.",
"arguments": [
{
"name": "element",
"type": "element",
"default": null
},
{
"name": "strict",
"type": "boolean",
"default": true
}
],
"returnType": "boolean"
},
"isPresent": {
"type": "async",
"description": "Returns a boolean if the element is present at the DOM or not. It might be hidden.",
"arguments": [
{
"name": "element",
"type": "element",
"default": null
}
],
"returnType": "boolean"
},
"waitToBePresent": {
"type": "async",
"description": "Waits until the element with the given selector is present.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "boolean"
},
"waitToBeVisible": {
"type": "async",
"description": "Waits until the element with the given selector is visible.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "boolean"
},
"waitToBeClickable": {
"type": "async",
"description": "Waits until the element with the given selector is clickable.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "boolean"
},
"isSelected": {
"type": "async",
"description": "Returns a boolean if the element (e.g. checkbox) is selected.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
}
],
"returnType": "boolean"
},
"waitToBeEnabled": {
"type": "async",
"description": "Waits until the element with the given selector is present.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "boolean"
}
},
"gestures": {
"swipe": {
"type": "async",
"description": "Swipe from one point to another on the screen,\nEnsure that the provided coordinates are within the bounds of the screen to avoid unexpected behavior.",
"arguments": [
{
"name": "startX",
"type": "number",
"default": null
},
{
"name": "startY",
"type": "number",
"default": null
},
{
"name": "endX",
"type": "number",
"default": null
},
{
"name": "endY",
"type": "number",
"default": null
},
{
"name": "duration",
"type": "number",
"default": 1000
}
],
"returnType": "promise"
},
"tap": {
"type": "async",
"description": "Executes a tap at the given screen coordinates,\nEnsure that the provided coordinates are within the bounds of the screen to avoid unexpected behavior.",
"arguments": [
{
"name": "coordX",
"type": "number",
"default": null
},
{
"name": "coordY",
"type": "number",
"default": null
}
],
"returnType": "promise"
}
},
"ios": {},
"userInteraction": {
"tap": {
"type": "async",
"description": "Tap's on the mobile element.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"check": {
"type": "async",
"description": "Checks the given checkbox.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"uncheck": {
"type": "async",
"description": "Unchecks the given checkbox.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"doubleTap": {
"type": "async",
"description": "Double Tap's on the mobile element.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "promise"
},
"fill": {
"type": "async",
"description": "Enter a string value into a mobile input field.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "value",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "promise"
},
"clearAndFill": {
"type": "async",
"description": "Enter a string into the mobile input field; it will clear the box before submission.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "value",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "promise"
},
"clear": {
"type": "async",
"description": "Clear a string value into a mobile input field.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "promise"
}
}
},
"nonUi5": {
"assertion": {
"expectAttributeToBe": {
"type": "async",
"description": "Expects the attributes value of the passed element to be the compare value.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "compareValue",
"type": "string",
"default": null
},
{
"name": "attribute",
"type": "string",
"default": null
}
]
},
"expectAttributeToContain": {
"type": "async",
"description": "Expects the attributes value of the passed element to contain the compare value.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "compareValue",
"type": "string",
"default": null
},
{
"name": "attribute",
"type": "string",
"default": null
}
]
},
"expectValueToBe": {
"type": "async",
"description": "Expects the attributes value of the passed element to be the compare value.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "compareValue",
"type": "string",
"default": null
}
]
},
"expectCssPropertyValueToBe": {
"type": "async",
"description": "Expects the CSS property value of the passed element to be the compare value.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "cssProperty",
"type": "string",
"default": null
},
{
"name": "compareValue",
"type": "string",
"default": null
}
]
},
"expectTextToBe": {
"type": "async",
"description": "Expects the text of the passed element to be the compare value.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "compareValue",
"type": "string",
"default": null
}
]
},
"expectToBeVisible": {
"type": "async",
"description": "Expects that the element is visible to the user.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
}
]
},
"expectToBeNotVisible": {
"type": "async",
"description": "Expects that the element is not visible to the user.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
}
},
"element": {
"waitForAll": {
"type": "async",
"description": "Waits until all elements with the given selector are rendered. Will fail if no element is found.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"waitToBePresent": {
"type": "async",
"description": "Waits until the element with the given selector is present.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"waitToBeVisible": {
"type": "async",
"description": "Waits until the element with the given selector is visible.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"waitToBeClickable": {
"type": "async",
"description": "Waits until the element with the given selector is clickable.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"getAllDisplayed": {
"type": "async",
"description": "Gets all visible elements with the passed selector.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "array"
},
"getAll": {
"type": "async",
"description": "Returns all elements found by the given selector despite visible or not.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"getByCss": {
"type": "async",
"description": "Gets the element with the given CSS selector.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getByCssContainingText": {
"type": "async",
"description": "Gets the element with the given CSS selector containing the given text value.",
"arguments": [
{
"name": "selector",
"type": "object",
"default": null
},
{
"name": "text",
"type": "string",
"default": "\"\""
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
},
{
"name": "strict",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getById": {
"type": "async",
"description": "Gets the element with the given ID.",
"arguments": [
{
"name": "id",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getByClass": {
"type": "async",
"description": "Gets the element with the given class.",
"arguments": [
{
"name": "elemClass",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getByName": {
"type": "async",
"description": "Gets the element with the given name.",
"arguments": [
{
"name": "name",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getByXPath": {
"type": "async",
"description": "Gets the element with the given XPath.",
"arguments": [
{
"name": "xpath",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getByChild": {
"type": "async",
"description": "Gets an element by its selector and child selector. Can be used when multiple elements have the same properties.",
"arguments": [
{
"name": "elementSelector",
"type": "string",
"default": null
},
{
"name": "childSelector",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"getByParent": {
"type": "async",
"description": "Gets an element by its selector and parent selector. Can be used when multiple elements have the same properties.",
"arguments": [
{
"name": "elementSelector",
"type": "string",
"default": null
},
{
"name": "parentSelector",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "includeHidden",
"type": "boolean",
"default": true
}
],
"returnType": "object"
},
"isVisible": {
"type": "async",
"description": "Returns a boolean if the element is visible to the user.",
"arguments": [
{
"name": "element",
"type": "object",
"default": null
},
{
"name": "strict",
"type": "boolean",
"default": true
}
],
"returnType": "boolean"
},
"isPresent": {
"type": "async",
"description": "Returns a boolean if the element is present at the DOM or not. It might be hidden.",
"arguments": [
{
"name": "elem",
"type": "object",
"default": null
}
],
"returnType": "boolean"
},
"isEnabled": {
"type": "async",
"description": "Returns a boolean if the element is enabled or not.",
"arguments": [
{
"name": "elem",
"type": "element",
"default": null
}
],
"returnType": "boolean"
},
"isPresentByCss": {
"type": "async",
"description": "Returns a boolean if the element is present at the DOM or not.",
"arguments": [
{
"name": "css",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "boolean"
},
"isPresentByXPath": {
"type": "async",
"description": "Returns a boolean if the element is present at the DOM or not.",
"arguments": [
{
"name": "xpath",
"type": "string",
"default": null
},
{
"name": "index",
"type": "number",
"default": 0
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
],
"returnType": "boolean"
},
"isSelected": {
"type": "async",
"description": "Returns a boolean if the element (e.g. checkbox) is selected.",
"arguments": [
{
"name": "elem",
"type": "object",
"default": null
}
],
"returnType": "boolean"
},
"getAttributeValue": {
"type": "async",
"description": "Returns the attributes value of the passed element.",
"arguments": [
{
"name": "elem",
"type": "object",
"default": null
},
{
"name": "attribute",
"type": "string",
"default": null
}
],
"returnType": "string"
},
"getValue": {
"type": "async",
"description": "Returns the value of the passed element.",
"arguments": [
{
"name": "elem",
"type": "object",
"default": null
}
],
"returnType": "string"
},
"getCssPropertyValue": {
"type": "async",
"description": "Returns the value of the passed CSS property of the element.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "cssProperty",
"type": "string",
"default": null
}
],
"returnType": "string"
},
"setInnerHTML": {
"type": "async",
"description": "Sets the innerHTML value of the given element.\nCAUTION: 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.",
"arguments": [
{
"name": "elem",
"type": "object",
"default": null
}
],
"returnType": "string"
},
"highlight": {
"type": "async",
"description": "Highlights the passed element.",
"arguments": [
{
"name": "elem",
"type": "object",
"default": null
},
{
"name": "duration",
"type": "integer",
"default": "2000"
},
{
"name": "color",
"type": "string",
"default": "\"red\""
}
]
}
},
"navigation": {
"navigateToApplication": {
"type": "async",
"description": "Navigates to the application via the passed relative reference. The path will be added to the baseUrl maintained in the config.",
"arguments": [
{
"name": "relativeReference",
"type": "string",
"default": null
},
{
"name": "refresh",
"type": "boolean",
"default": true
}
]
}
},
"session": {
"loginSapNetWeaver": {
"type": "async",
"description": "Login for SAP NetWebGUI form and specific username and password.",
"arguments": [
{
"name": "username",
"type": "string",
"default": null
},
{
"name": "password",
"type": "string",
"default": null
},
{
"name": "clickContinue",
"type": "boolean",
"default": true
},
{
"name": "iframeCssSelector",
"type": "string",
"default": "\"iframe\""
}
]
}
},
"userInteraction": {
"click": {
"type": "async",
"description": "Clicks on the passed element.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"clickAndRetry": {
"type": "async",
"description": "Clicks on the passed element, retries in case it fails.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
},
{
"name": "retries",
"type": "number",
"default": 3
},
{
"name": "interval",
"type": "number",
"default": 5000
}
]
},
"doubleClick": {
"type": "async",
"description": "Double Clicks on the passed element.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"rightClick": {
"type": "async",
"description": "Right Clicks on the passed element.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "timeout",
"type": "number",
"default": 30000
}
]
},
"check": {
"type": "async",
"description": "Checks the given checkbox.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
}
]
},
"uncheck": {
"type": "async",
"description": "Unchecks the given checkbox.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
}
]
},
"fill": {
"type": "async",
"description": "Fills the given value into the passed input.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "value",
"type": "string",
"default": null
}
]
},
"fillAndRetry": {
"type": "async",
"description": "Fills the given value into the passed input, retries in case of a failure.",
"arguments": [
{
"name": "elementOrSelector",
"type": "string",
"default": null
},
{
"name": "value",
"type": "string",
"default": null
},
{
"name": "retries",
"type": "number",
"default": 3
},
{
"name": "interval",