Skip to content

OI-1023 Command exceptions should be documented #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/ox_modules/module-mob/commands/getBrowserLogs.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/**
* @function getBrowserLogs
* @summary Collects browser logs from the mobile device.
* @description Supports only for Android
* @return {Object[]} A list of logs.
* @for android, ios, hybrid, web
* @example <caption>[javascript] Usage example</caption>
Expand Down
1 change: 1 addition & 0 deletions src/ox_modules/module-mob/commands/getDeviceLogs.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/**
* @function getDeviceLogs
* @summary Collects logs from the mobile device.
* @description Supports only for Android
* @return {Object[]} A list of logs.
* @for android, ios, hybrid, web
* @example <caption>[javascript] Usage example</caption>
Expand Down
1 change: 1 addition & 0 deletions src/ox_modules/module-mob/commands/smsGetText.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* @summary Gets SMS text on Android phone.
* @description `SMSPopup` application must be installed and running on the device to use this command.
* https://github.com/oxygenhq/android-smspopup/releases
* Supports only for Android
* @function smsGetText
* @param {Number=} timeout - Time in milliseconds to wait for sms popup. Default is 60 seconds.
* @return {String} - SMS text.
Expand Down
4 changes: 4 additions & 0 deletions src/ox_modules/module-web.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ export default class WebModule extends WebDriverModule {
/**
* @function init
* @summary Initializes new Selenium session.
* @description
* Record HAR only for chrome
* Collect browser logs only for chrome
* Don't run maximizeWindow and setTimeout commands for MicrosoftEdge
* @param {String=} caps - Desired capabilities. If not specified capabilities will be taken from suite definition.
* @param {String=} seleniumUrl - Remote server URL (default: http://localhost:4444/wd/hub).
*/
Expand Down
1 change: 1 addition & 0 deletions src/ox_modules/module-web/commands/fileBrowse.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* @summary Uploads a local file
* @description Can crush driver
* @function fileBrowse
* @param {String|Element} locator - Locator for a `input type=file` element.
* @param {String} filepath - Path to a local file.
Expand Down
1 change: 1 addition & 0 deletions src/ox_modules/module-web/commands/getBrowserLogs.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/**
* @function getBrowserLogs
* @summary Collects logs from the browser console.
* @description Collect browser logs only for chrome
* @return {Object[]} An array of browser console logs.
* @for chrome
* @example <caption>[javascript] Usage example</caption>
Expand Down
1 change: 1 addition & 0 deletions src/ox_modules/module-web/commands/getXMLPageSource.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* @summary Gets the source of the currently active window which displays `text/xml` page.
* @description Support only chrome and ie
* @function getXMLPageSource
* @return {String} The XML page source.
* @example <caption>[javascript] Usage example</caption>
Expand Down
1 change: 1 addition & 0 deletions src/ox_modules/module-web/commands/pointJS.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* @summary Points the mouse cursor over the specified element.
* @description This method is similar to `web.point`, however it simulates the action using
* JavaScript instead of using WebDriver's functionality which doesn't work in all cases.
* Don't support IE < 9
* @function pointJS
* @param {String|Element} locator - An element locator.
* @param {Number=} timeout - Timeout in milliseconds. Default is 60 seconds.
Expand Down