From c5db7268913269bea6adb98ef114e0a75e0c8cc3 Mon Sep 17 00:00:00 2001 From: Laolu Benson Date: Mon, 9 Jan 2023 00:36:36 +0000 Subject: [PATCH] build: create XML documentation file on build and copy it to both binary output directories closes #441 --- src/Appium.Net/Appium.Net.csproj | 23 +- src/Appium.Net/Appium.Net.xml | 6495 ------------------------------ src/Appium.Net/NOTICE.txt | 1 - 3 files changed, 18 insertions(+), 6501 deletions(-) delete mode 100644 src/Appium.Net/Appium.Net.xml delete mode 100644 src/Appium.Net/NOTICE.txt diff --git a/src/Appium.Net/Appium.Net.csproj b/src/Appium.Net/Appium.Net.csproj index a77c3b6bc..7ed10b4af 100644 --- a/src/Appium.Net/Appium.Net.csproj +++ b/src/Appium.Net/Appium.Net.csproj @@ -26,15 +26,28 @@ LICENSE.txt + + true + + + + 8.0 + + + + 1701;1702;1591 + + - Appium.Net.xml + 1701;1702;1591 - - Appium.Net.xml + + + 1701;1702;1591 - - 8.0 + + 1701;1702;1591 diff --git a/src/Appium.Net/Appium.Net.xml b/src/Appium.Net/Appium.Net.xml deleted file mode 100644 index 4bde4c9b1..000000000 --- a/src/Appium.Net/Appium.Net.xml +++ /dev/null @@ -1,6495 +0,0 @@ - - - - Appium.Net - - - - - Initializes a new instance of the AndroidDriver class - - An object which executes commands for the driver. - An object containing the Appium options. - - - - Initializes a new instance of the AndroidDriver class using Appium options - - An object containing the Appium options of the browser. - - - - Initializes a new instance of the AndroidDriver class using Appium options and command timeout - - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the AndroidDriver class using the AppiumServiceBuilder instance and Appium options - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - - - - Initializes a new instance of the AndroidDriver class using the AppiumServiceBuilder instance, Appium options and command timeout - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the AndroidDriver class using the specified remote address and Appium options - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - - - - Initializes a new instance of the AndroidDriver class using the specified Appium local service and Appium options - - the specified Appium local service - An object containing the Appium options of the browser. - - - - Initializes a new instance of the AndroidDriver class using the specified remote address, Appium options, and command timeout. - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the AndroidDriver class using the specified Appium local service, Appium options, and command timeout. - - the specified Appium local service - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Open the notifications - - - - - Retrieve visibility and bounds information of the status and navigation bars - - A dictionary whose string keys are named statusBarnavigationBar - - - - Retrieve display density(dpi) of the Android device - - Retrieve display density(dpi) of the Android device - - - This method locks a device. - - - - Check if the device is locked - - true if device is locked, false otherwise - - - This method unlocks a device. - - - - Get test-coverage data - - a string containing the intent. - a string containing the path. - a base64 string containing the data - - - - Sets the content to the clipboard - - - - - - - Get the content of the clipboard. - - - Android supports plaintext only - The content of the clipboard as base64-encoded string or an empty string if the clipboard is empty - - - - Sets text to the clipboard - - - For Android only - A user visible label for the clipboard content. - - - - Get the plaintext content of the clipboard. - - Android supports plaintext only - The string content of the clipboard or an empty string if the clipboard is empty - - - - Sets the url string to the clipboard - - - - - - Gets the url string from the clipboard - - The url string content of the clipboard or an empty string if the clipboard is empty - - - - Sets the image to the clipboard - - - - - - Gets the image from the clipboard - - The image content of the clipboard as base64-encoded string or null if there is no image on the clipboard - - - - Initializes a new instance of the AndroidElement class. - - Driver in use. - ID of the element. - - - - The video bit rate for the video, in megabits per second. - The default value is 4000000 (4 Mb/s) for Android API level below 27 - and 20000000 (20 Mb/s) for API level 27 and above. - You can increase the bit rate to improve video quality, - but doing so results in larger movie files. - - The actual bit rate (Mb/s). - self instance for chaining. - - - - The video size of the generated media file. The format is WIDTHxHEIGHT. - The default value is the device's native display resolution (if supported), - 1280x720 if not. For best results, - use a size supported by your device's Advanced Video Coding (AVC) encoder. - - The actual video size: WIDTHxHEIGHT. - self instance for chaining. - - - - Makes the recorder to display an additional information on the video overlay, - such as a timestamp, that is helpful in videos captured to illustrate bugs. - This option is only supported since API level 27 (Android P). - - self instance for chaining. - - - - The maximum recording time.The default and maximum value is 180 seconds (3 minutes). - Setting values greater than this or less than zero will cause an exception. The minimum - time resolution unit is one second. - - Since Appium 1.8.2 the time limit can be up to 1800 seconds (30 minutes). - Appium will automatically try to merge the 3-minutes chunks recorded - by the screenrecord utility, however, this requires FFMPEG utility - to be installed and available in PATH on the server machine. If the utility is not - present then the most recent screen recording chunk is going to be returned as the result. - - The actual time limit of the recorded video. - self instance for chaining. - - - - getAction() value: the key has been pressed down. - (0x00000000) - - - - - getAction() value: multiple duplicate key events have occurred in a row, or a complex string is being delivered. If the key code is not {#link Keycode_UNKNOWN then the {#link getRepeatCount() method returns the number of times the given key code should be executed. Otherwise, if the key code is Keycode_UNKNOWN, then this is a sequence of characters as returned by getCharacters(). - (0x00000002) - - - - - getAction() value: the key has been released. - (0x00000001) - - - - - When associated with up key events, this indicates that the key press has been canceled. Typically this is used with virtual touch screen keys, where the user can slide from the virtual key area on to the display: in that case, the application will receive a canceled up event and should not perform the action normally associated with the key. Note that for this to work, the application can not perform an action for a key until it receives an up or the long press timeout has expired. - (0x00000020) - - - - - Set when a key event has FLAG_CANCELED set because a long press action was executed while it was down. - (0x00000100) - - - - - This mask is used for compatibility, to identify enter keys that are coming from an IME whose enter key has been auto-labelled "next" or "done". This allows TextView to dispatch these as normal enter keys for old applications, but still do the appropriate action when receiving them. - (0x00000010) - - - - - Set when a key event has been synthesized to implement default behavior for an event that the application did not handle. Fallback key events are generated by unhandled trackball motions (to emulate a directional keypad) and by certain unhandled key presses that are declared in the key map (such as special function numeric keypad keys when numlock is off). - (0x00000400) - - - - - This mask is set if an event was known to come from a trusted part of the system. That is, the event is known to come from the user, and could not have been spoofed by a third party component. - (0x00000008) - - - - - This mask is set if we don't want the key event to cause us to leave touch mode. - (0x00000004) - - - - - This flag is set for the first key repeat that occurs after the long press timeout. - (0x00000080) - - - - - This mask is set if the key event was generated by a software keyboard. - (0x00000002) - - - - - Set for ACTION_UP when this event's key code is still being tracked from its initial down. That is, somebody requested that tracking started on the key down and a long press has not caused the tracking to be canceled. - (0x00000200) - - - - - This key event was generated by a virtual (on-screen) hard key area. Typically this is an area of the touchscreen, outside of the regular display, dedicated to "hardware" buttons. - (0x00000040) - - - - - This constant was deprecated in API level 20. - This flag will never be set by the system since the system consumes all wake keys itself. - This mask is set if the device woke because of this key event. - (0x00000001) - - - - - Key code constant: '0' key. - (0x00000007) - - - - - Key code constant: '1' key. - (0x00000008) - - - - - Key code constant: '11' key. - (0x000000e3) - - - - - Key code constant: '12' key. - (0x000000e4) - - - - - Key code constant: '2' key. - (0x00000009) - - - - - Key code constant: '3' key. - (0x0000000a) - - - - - Key code constant: 3D Mode key. Toggles the display between 2D and 3D mode. - (0x000000ce) - - - - - Key code constant: '4' key. - (0x0000000b) - - - - - Key code constant: '5' key. - (0x0000000c) - - - - - Key code constant: '6' key. - (0x0000000d) - - - - - Key code constant: '7' key. - (0x0000000e) - - - - - Key code constant: '8' key. - (0x0000000f) - - - - - Key code constant: '9' key. - (0x00000010) - - - - - Key code constant: 'A' key. - (0x0000001d) - - - - - Key code constant: Left Alt modifier key. - (0x00000039) - - - - - Key code constant: Right Alt modifier key. - (0x0000003a) - - - - - Key code constant: ''' (apostrophe) key. - (0x0000004b) - - - - - Key code constant: App switch key. Should bring up the application switcher dialog. - (0x000000bb) - - - - - Key code constant: Assist key. Launches the global assist activity. Not delivered to applications. - (0x000000db) - - - - - Key code constant: '@' key. - (0x0000004d) - - - - - Key code constant: A/V Receiver input key. On TV remotes, switches the input mode on an external A/V Receiver. - (0x000000b6) - - - - - Key code constant: A/V Receiver power key. On TV remotes, toggles the power on an external A/V Receiver. - (0x000000b5) - - - - - Key code constant: 'B' key. - (0x0000001e) - - - - - Key code constant: Back key. - (0x00000004) - - - - - Key code constant: '\' key. - (0x00000049) - - - - - Key code constant: Bookmark key. On some TV remotes, bookmarks content or web pages. - (0x000000ae) - - - - - Key code constant: Break / Pause key. - (0x00000079) - - - - - Key code constant: Brightness Down key. Adjusts the screen brightness down. - (0x000000dc) - - - - - Key code constant: Brightness Up key. Adjusts the screen brightness up. - (0x000000dd) - - - - - Key code constant: Generic Game Pad Button #1. - (0x000000bc) - - - - - Key code constant: Generic Game Pad Button #10. - (0x000000c5) - - - - - Key code constant: Generic Game Pad Button #11. - (0x000000c6) - - - - - Key code constant: Generic Game Pad Button #12. - (0x000000c7) - - - - - Key code constant: Generic Game Pad Button #13. - (0x000000c8) - - - - - Key code constant: Generic Game Pad Button #14. - (0x000000c9) - - - - - Key code constant: Generic Game Pad Button #15. - (0x000000ca) - - - - - Key code constant: Generic Game Pad Button #16. - (0x000000cb) - - - - - Key code constant: Generic Game Pad Button #2. - (0x000000bd) - - - - - Key code constant: Generic Game Pad Button #3. - (0x000000be) - - - - - Key code constant: Generic Game Pad Button #4. - (0x000000bf) - - - - - Key code constant: Generic Game Pad Button #5. - (0x000000c0) - - - - - Key code constant: Generic Game Pad Button #6. - (0x000000c1) - - - - - Key code constant: Generic Game Pad Button #7. - (0x000000c2) - - - - - Key code constant: Generic Game Pad Button #8. - (0x000000c3) - - - - - Key code constant: Generic Game Pad Button #9. - (0x000000c4) - - - - - Key code constant: A Button key. On a game controller, the A button should be either the button labeled A or the first button on the bottom row of controller buttons. - (0x00000060) - - - - - Key code constant: B Button key. On a game controller, the B button should be either the button labeled B or the second button on the bottom row of controller buttons. - (0x00000061) - - - - - Key code constant: C Button key. On a game controller, the C button should be either the button labeled C or the third button on the bottom row of controller buttons. - (0x00000062) - - - - - Key code constant: L1 Button key. On a game controller, the L1 button should be either the button labeled L1 (or L) or the top left trigger button. - (0x00000066) - - - - - Key code constant: L2 Button key. On a game controller, the L2 button should be either the button labeled L2 or the bottom left trigger button. - (0x00000068) - - - - - Key code constant: Mode Button key. On a game controller, the button labeled Mode. - (0x0000006e) - - - - - Key code constant: R1 Button key. On a game controller, the R1 button should be either the button labeled R1 (or R) or the top right trigger button. - (0x00000067) - - - - - Key code constant: R2 Button key. On a game controller, the R2 button should be either the button labeled R2 or the bottom right trigger button. - (0x00000069) - - - - - Key code constant: Select Button key. On a game controller, the button labeled Select. - (0x0000006d) - - - - - Key code constant: Start Button key. On a game controller, the button labeled Start. - (0x0000006c) - - - - - Key code constant: Left Thumb Button key. On a game controller, the left thumb button indicates that the left (or only) joystick is pressed. - (0x0000006a) - - - - - Key code constant: Right Thumb Button key. On a game controller, the right thumb button indicates that the right joystick is pressed. - (0x0000006b) - - - - - - Key code constant: Y Button key. On a game controller, the Y button should be either the button labeled Y or the second button on the upper row of controller buttons. - (0x00000064) - - - - - Key code constant: Z Button key. On a game controller, the Z button should be either the button labeled Z or the third button on the upper row of controller buttons. - (0x00000065) - - - - - Key code constant: 'C' key. - (0x0000001f) - - - - - Key code constant: Calculator special function key. Used to launch a calculator application. - (0x000000d2) - - - - - Key code constant: Calendar special function key. Used to launch a calendar application. - (0x000000d0) - - - - - Key code constant: Call key. - (0x00000005) - - - - - Key code constant: Camera key. Used to launch a camera application or take pictures. - (0x0000001b) - - - - - Key code constant: Caps Lock key. - (0x00000073) - - - - - Key code constant: Toggle captions key. Switches the mode for closed-captioning text, for example during television shows. - (0x000000af) - - - - - Key code constant: Channel down key. On TV remotes, decrements the television channel. - (0x000000a7) - - - - - Key code constant: Channel up key. On TV remotes, increments the television channel. - (0x000000a6) - - - - - Key code constant: Clear key. - (0x0000001c) - - - - - Key code constant: ',' key. - (0x00000037) - - - - - Key code constant: Contacts special function key. Used to launch an address book application. - (0x000000cf) - - - - - Key code constant: Left Control modifier key. - (0x00000071) - - - - - Key code constant: Right Control modifier key. - (0x00000072) - - - - - Key code constant: 'D' key. - (0x00000020) - - - - - Key code constant: Backspace key. Deletes characters before the insertion popublic static readonly int , unlike Keycode_FORWARD_DEL. - (0x00000043) - - - - - Key code constant: Directional Pad Center key. May also be synthesized from trackball motions. - (0x00000017) - - - - - Key code constant: Directional Pad Down key. May also be synthesized from trackball motions. - (0x00000014) - - - - - Key code constant: Directional Pad Left key. May also be synthesized from trackball motions. - (0x00000015) - - - - - Key code constant: Directional Pad Right key. May also be synthesized from trackball motions. - (0x00000016) - - - - - Key code constant: Directional Pad Up key. May also be synthesized from trackball motions. - (0x00000013) - - - - - Key code constant: DVR key. On some TV remotes, switches to a DVR mode for recorded shows. - (0x000000ad) - - - - - Key code constant: 'E' key. - (0x00000021) - - - - - Key code constant: Japanese alphanumeric key. - (0x000000d4) - - - - - Key code constant: End Call key. - (0x00000006) - - - - - Key code constant: Enter key. - (0x00000042) - - - - - Key code constant: Envelope special function key. Used to launch a mail application. - (0x00000041) - - - - - Key code constant: '=' key. - (0x00000046) - - - - - Key code constant: Escape key. - (0x0000006f) - - - - - Key code constant: Explorer special function key. Used to launch a browser application. - (0x00000040) - - - - - Key code constant: 'F' key. - (0x00000022) - - - - - Key code constant: F1 key. - (0x00000083) - - - - - Key code constant: F10 key. - (0x0000008c) - - - - - Key code constant: F11 key. - (0x0000008d) - - - - - Key code constant: F12 key. - (0x0000008e) - - - - - Key code constant: F2 key. - (0x00000084) - - - - - Key code constant: F3 key. - (0x00000085) - - - - - Key code constant: F4 key. - (0x00000086) - - - - - Key code constant: F5 key. - (0x00000087) - - - - - Key code constant: F6 key. - (0x00000088) - - - - - Key code constant: F7 key. - (0x00000089) - - - - - Key code constant: F8 key. - (0x0000008a) - - - - - - Key code constant: Camera Focus key. Used to focus the camera. - (0x00000050) - - - - - Key code constant: Forward key. Navigates forward in the history stack. Complement of Keycode_BACK. - (0x0000007d) - - - - - Key code constant: Forward Delete key. Deletes characters ahead of the insertion popublic static readonly int , unlike Keycode_DEL. - (0x00000070) - - - - - Key code constant: Function modifier key. - (0x00000077) - - - - - Key code constant: 'G' key. - (0x00000023) - - - - - Key code constant: '`' (backtick) key. - (0x00000044) - - - - - Key code constant: Guide key. On TV remotes, shows a programming guide. - (0x000000ac) - - - - - Key code constant: 'H' key. - (0x00000024) - - - - - Key code constant: Headset Hook key. Used to hang up calls and stop media. - (0x0000004f) - - - - - Key code constant: Help key. - (0x00000103) - - - - - Key code constant: Japanese conversion key. - (0x000000d6) - - - - - Key code constant: Home key. This key is handled by the framework and is never delivered to applications. - (0x00000003) - - - - - Key code constant: 'I' key. - (0x00000025) - - - - - Key code constant: Info key. Common on TV remotes to show additional information related to what is currently being viewed. - (0x000000a5) - - - - - Key code constant: Insert key. Toggles insert / overwrite edit mode. - (0x0000007c) - - - - - Key code constant: 'J' key. - (0x00000026) - - - - - Key code constant: 'K' key. - (0x00000027) - - - - - Key code constant: Japanese kana key. - (0x000000da) - - - - - Key code constant: Japanese katakana / hiragana key. - (0x000000d7) - - - - - Key code constant: 'L' key. - (0x00000028) - - - - - Key code constant: Language Switch key. Toggles the current input language such as switching between English and Japanese on a QWERTY keyboard. On some devices, the same function may be performed by pressing Shift+Spacebar. - (0x000000cc) - - - - - Key code constant: Last Channel key. Goes to the last viewed channel. - (0x000000e5) - - - - - Key code constant: '[' key. - (0x00000047) - - - - - Key code constant: 'M' key. - (0x00000029) - - - - - Key code constant: Manner Mode key. Toggles silent or vibrate mode on and off to make the device behave more politely in certain settings such as on a crowded train. On some devices, the key may only operate when long-pressed. - (0x000000cd) - - - - - Key code constant: Audio Track key. Switches the audio tracks. - (0x000000de) - - - - - Key code constant: Close media key. May be used to close a CD tray, for example. - (0x00000080) - - - - - Key code constant: Eject media key. May be used to eject a CD tray, for example. - (0x00000081) - - - - - Key code constant: Fast Forward media key. - (0x0000005a) - - - - - Key code constant: Play Next media key. - (0x00000057) - - - - - Key code constant: Pause media key. - (0x0000007f) - - - - - Key code constant: Play media key. - (0x0000007e) - - - - - Key code constant: Play/Pause media key. - (0x00000055) - - - - - Key code constant: Play Previous media key. - (0x00000058) - - - - - Key code constant: Record media key. - (0x00000082) - - - - - Key code constant: Rewind media key. - (0x00000059) - - - - - Key code constant: Stop media key. - (0x00000056) - - - - - Key code constant: Media Top Menu key. Goes to the top of media menu. - (0x000000e2) - - - - - Key code constant: Menu key. - (0x00000052) - - - - - Key code constant: Left Meta modifier key. - (0x00000075) - - - - - Key code constant: Right Meta modifier key. - (0x00000076) - - - - - Key code constant: '-'. - (0x00000045) - - - - - Key code constant: End Movement key. Used for scrolling or moving the cursor around to the end of a line or to the bottom of a list. - (0x0000007b) - - - - - Key code constant: Home Movement key. Used for scrolling or moving the cursor around to the start of a line or to the top of a list. - (0x0000007a) - - - - - Key code constant: Japanese non-conversion key. - (0x000000d5) - - - - - Key code constant: Music special function key. Used to launch a music player application. - (0x000000d1) - - - - - Key code constant: Mute key. Mutes the microphone, unlike Keycode_VOLUME_MUTE. - (0x0000005b) - - - - - Key code constant: 'N' key. - (0x0000002a) - - - - - Key code constant: Notification key. - (0x00000053) - - - - - - Key code constant: Numeric keypad '0' key. - (0x00000090) - - - - - Key code constant: Numeric keypad '1' key. - (0x00000091) - - - - - Key code constant: Numeric keypad '2' key. - (0x00000092) - - - - - Key code constant: Numeric keypad '3' key. - (0x00000093) - - - - - Key code constant: Numeric keypad '4' key. - (0x00000094) - - - - - Key code constant: Numeric keypad '5' key. - (0x00000095) - - - - - Key code constant: Numeric keypad '6' key. - (0x00000096) - - - - - Key code constant: Numeric keypad '7' key. - (0x00000097) - - - - - Key code constant: Numeric keypad '8' key. - (0x00000098) - - - - - Key code constant: Numeric keypad '9' key. - (0x00000099) - - - - - Key code constant: Numeric keypad '+' key (for addition). - (0x0000009d) - - - - - Key code constant: Numeric keypad ',' key (for decimals or digit grouping). - (0x0000009f) - - - - - Key code constant: Numeric keypad '/' key (for division). - (0x0000009a) - - - - - Key code constant: Numeric keypad '.' key (for decimals or digit grouping). - (0x0000009e) - - - - - Key code constant: Numeric keypad Enter key. - (0x000000a0) - - - - - Key code constant: Numeric keypad '=' key. - (0x000000a1) - - - - - Key code constant: Numeric keypad '(' key. - (0x000000a2) - - - - - Key code constant: Numeric keypad '*' key (for multiplication). - (0x0000009b) - - - - - Key code constant: Numeric keypad ')' key. - (0x000000a3) - - - - - - Key code constant: Num Lock key. This is the Num Lock key; it is different from Keycode_NUM. This key alters the behavior of other keys on the numeric keypad. - (0x0000008f) - - - - - Key code constant: 'O' key. - (0x0000002b) - - - - - Key code constant: 'P' key. - (0x0000002c) - - - - - Key code constant: Page Down key. - (0x0000005d) - - - - - Key code constant: Page Up key. - (0x0000005c) - - - - - Key code constant: Pairing key. Initiates peripheral pairing mode. Useful for pairing remote control devices or game controllers, especially if no other input mode is available. - (0x000000e1) - - - - - Key code constant: '.' key. - (0x00000038) - - - - - Key code constant: Picture Symbols modifier key. Used to switch symbol sets (Emoji, Kao-moji). - (0x0000005e) - - - - - Key code constant: '+' key. - (0x00000051) - - - - - Key code constant: '#' key. - (0x00000012) - - - - - Key code constant: Power key. - (0x0000001a) - - - - - Key code constant: Blue "programmable" key. On TV remotes, acts as a contextual/programmable key. - (0x000000ba) - - - - - Key code constant: Green "programmable" key. On TV remotes, actsas a contextual/programmable key. - (0x000000b8) - - - - - Key code constant: Red "programmable" key. On TV remotes, acts as a contextual/programmable key. - (0x000000b7) - - - - - Key code constant: Yellow "programmable" key. On TV remotes, acts as a contextual/programmable key. - (0x000000b9) - - - - - Key code constant: 'Q' key. - (0x0000002d) - - - - - Key code constant: 'R' key. - (0x0000002e) - - - - - Key code constant: ']' key. - (0x00000048) - - - - - Key code constant: Japanese Ro key. - (0x000000d9) - - - - - Key code constant: 'S' key. - (0x0000002f) - - - - - Key code constant: Scroll Lock key. - (0x00000074) - - - - - Key code constant: Search key. - (0x00000054) - - - - - Key code constant: ';' key. - (0x0000004a) - - - - - Key code constant: Settings key. Starts the system settings activity. - (0x000000b0) - - - - - Key code constant: Left Shift modifier key. - (0x0000003b) - - - - - Key code constant: Right Shift modifier key. - (0x0000003c) - - - - - Key code constant: '/' key. - (0x0000004c) - - - - - Key code constant: Sleep key. Puts the device to sleep. Behaves somewhat like Keycode_POWER but it has no effect if the device is already asleep. - (0x000000df) - - - - - Key code constant: Soft Left key. Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom left of the display. - (0x00000001) - - - - - Key code constant: Soft Right key. Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom right of the display. - (0x00000002) - - - - - Key code constant: Space key. - (0x0000003e) - - - - - Key code constant: '*' key. - (0x00000011) - - - - - Key code constant: Set-top-box input key. On TV remotes, switches the input mode on an external Set-top-box. - (0x000000b4) - - - - - Key code constant: Set-top-box power key. On TV remotes, toggles the power on an external Set-top-box. - (0x000000b3) - - - - - Key code constant: Switch Charset modifier key. Used to switch character sets (Kanji, Katakana). - (0x0000005f) - - - - - Key code constant: Symbol modifier key. Used to enter alternate symbols. - (0x0000003f) - - - - - Key code constant: System Request / Prpublic static readonly int Screen key. - (0x00000078) - - - - - Key code constant: 'T' key. - (0x00000030) - - - - - Key code constant: Tab key. - (0x0000003d) - - - - - Key code constant: TV key. On TV remotes, switches to viewing live TV. - (0x0000000aa) - - - - - Key code constant: Antenna/Cable key. Toggles broadcast input source between antenna and cable. - (0x000000f2) - - - - - Key code constant: Audio description key. Toggles audio description off / on. - (0x000000fc) - - - - - Key code constant: Audio description mixing volume down key. Lessen audio description volume as compared with normal audio volume. - (0x000000fe) - - - - - Key code constant: Audio description mixing volume up key. Louden audio description volume as compared with normal audio volume. - (0x000000fd) - - - - - Key code constant: Contents menu key. Goes to the title list. Corresponds to Contents Menu (0x0B) of CEC User Control Code - (0x00000100) - - - - - Key code constant: TV data service key. Displays data services like weather, sports. - (0x000000e6) - - - - - Key code constant: TV input key. On TV remotes, switches the input on a television screen. - (0x000000b2) - - - - - Key code constant: Component #1 key. Switches to component video input #1. - (0x000000f9) - - - - - Key code constant: Component #2 key. Switches to component video input #2. - (0x000000fa) - - - - - Key code constant: Composite #1 key. Switches to composite video input #1. - (0x000000f7) - - - - - Key code constant: Composite #2 key. Switches to composite video input #2. - (0x000000f8) - - - - - Key code constant: HDMI #1 key. Switches to HDMI input #1. - (0x000000f3) - - - - - Key code constant: HDMI #2 key. Switches to HDMI input #2. - (0x000000f4) - - - - - Key code constant: HDMI #3 key. Switches to HDMI input #3. - (0x000000f5) - - - - - Key code constant: HDMI #4 key. Switches to HDMI input #4. - (0x000000f6) - - - - - Key code constant: VGA #1 key. Switches to VGA (analog RGB) input #1. - (0x000000fb) - - - - - Key code constant: Media context menu key. Goes to the context menu of media contents. Corresponds to Media Context-sensitive Menu (0x11) of CEC User Control Code. - (0x00000101) - - - - - Key code constant: Toggle Network key. Toggles selecting broacast services. - (0x000000f1) - - - - - Key code constant: Number entry key. Initiates to enter multi-digit channel nubmber when each digit key is assigned for selecting separate channel. Corresponds to Number Entry Mode (0x1D) of CEC User Control Code. - (0x000000ea) - - - - - Key code constant: TV power key. On TV remotes, toggles the power on a television screen. - (0x000000b1) - - - - - Key code constant: Radio key. Toggles TV service / Radio service. - (0x000000e8) - - - - - Key code constant: Satellite key. Switches to digital satellite broadcast service. - (0x000000ed) - - - - - Key code constant: BS key. Switches to BS digital satellite broadcasting service available in Japan. - (0x000000ee) - - - - - Key code constant: CS key. Switches to CS digital satellite broadcasting service available in Japan. - (0x000000ef) - - - - - Key code constant: BS/CS key. Toggles between BS and CS digital satellite services. - (0x000000f0) - - - - - Key code constant: Teletext key. Displays Teletext service. - (0x000000e9) - - - - - Key code constant: Analog Terrestrial key. Switches to analog terrestrial broadcast service. - (0x000000eb) - - - - - Key code constant: Digital Terrestrial key. Switches to digital terrestrial broadcast service. - (0x000000ec) - - - - - Key code constant: Timer programming key. Goes to the timer recording menu. Corresponds to Timer Programming (0x54) of CEC User Control Code. - (0x00000102) - - - - - Key code constant: Zoom mode key. Changes Zoom mode (Normal, Full, Zoom, Wide-zoom, etc.) - (0x000000ff) - - - - - Key code constant: 'U' key. - (0x00000031) - - - - - Key code constant: Unknown key code. - (0x00000000) - - - - - Key code constant: 'V' key. - (0x00000032) - - - - - Key code constant: Voice Assist key. Launches the global voice assist activity. Not delivered to applications. - (0x000000e7) - - - - - Key code constant: Volume Down key. Adjusts the speaker volume down. - (0x00000019) - - - - - Key code constant: Volume Mute key. Mutes the speaker, unlike Keycode_MUTE. This key should normally be implemented as a toggle such that the first press mutes the speaker and the second press restores the original volume. - (0x000000a4) - - - - - Key code constant: Volume Up key. Adjusts the speaker volume up. - (0x00000018) - - - - - Key code constant: 'W' key. - (0x00000033) - - - - - Key code constant: Wakeup key. Wakes up the device. Behaves somewhat like Keycode_POWER but it has no effect if the device is already awake. - (0x000000e0) - - - - - Key code constant: Window key. On TV remotes, toggles picture-in-picture mode or other windowing functions. - (0x000000ab) - - - - - Key code constant: 'X' key. - (0x00000034) - - - - - Key code constant: 'Y' key. - (0x00000035) - - - - - Key code constant: Japanese Yen key. - (0x000000d8) - - - - - Key code constant: 'Z' key. - (0x00000036) - - - - - Key code constant: Japanese full-width / half-width key. - (0x000000d3) - - - - - Key code constant: Zoom in key. - (0x000000a8) - - - - - Key code constant: Zoom out key. - (0x000000a9) - - - - - This constant was deprecated in API level 3. - There are now more than MAX_KEYCODE keycodes. Use getMaxKeyCode() instead. - (0x00000054) - - - - - This mask is used to check whether the left ALT meta key is pressed. - See Also - isAltPressed() - getMetaState() - Keycode_ALT_LEFT - (0x00000010) - - - - - This mask is a combination of META_ALT_ON, META_ALT_LEFT_ON and META_ALT_RIGHT_ON. - (0x00000032) - - - - - This mask is used to check whether one of the ALT meta keys is pressed. - See Also - isAltPressed() - getMetaState() - Keycode_ALT_LEFT - Keycode_ALT_RIGHT - (0x00000002) - - - - - This mask is used to check whether the right the ALT meta key is pressed. - See Also - isAltPressed() - getMetaState() - Keycode_ALT_RIGHT - (0x00000020) - - - - - This mask is used to check whether the CAPS LOCK meta key is on. - See Also - isCapsLockOn() - getMetaState() - Keycode_CAPS_LOCK - (0x00100000) - - - - - This mask is used to check whether the left CTRL meta key is pressed. - See Also - isCtrlPressed() - getMetaState() - Keycode_CTRL_LEFT - (0x00002000) - - - - - This mask is a combination of META_CTRL_ON, META_CTRL_LEFT_ON and META_CTRL_RIGHT_ON. - (0x00007000) - - - - - This mask is used to check whether one of the CTRL meta keys is pressed. - See Also - isCtrlPressed() - getMetaState() - Keycode_CTRL_LEFT - Keycode_CTRL_RIGHT - (0x00001000) - - - - - This mask is used to check whether the right CTRL meta key is pressed. - See Also - isCtrlPressed() - getMetaState() - Keycode_CTRL_RIGHT - (0x00004000) - - - - - This mask is used to check whether the FUNCTION meta key is pressed. - See Also - isFunctionPressed() - getMetaState() - (0x00000008) - - - - - This mask is used to check whether the left META meta key is pressed. - See Also - isMetaPressed() - getMetaState() - Keycode_META_LEFT - (0x00020000) - - - - - This mask is a combination of META_META_ON, META_META_LEFT_ON and META_META_RIGHT_ON. - (0x00070000) - - - - - This mask is used to check whether one of the META meta keys is pressed. - See Also - isMetaPressed() - getMetaState() - Keycode_META_LEFT - Keycode_META_RIGHT - (0x00010000) - - - - - This mask is used to check whether the right META meta key is pressed. - See Also - isMetaPressed() - getMetaState() - Keycode_META_RIGHT - (0x00040000) - - - - - This mask is used to check whether the NUM LOCK meta key is on. - See Also - isNumLockOn() - getMetaState() - Keycode_NUM_LOCK - (0x00200000) - - - - - This mask is used to check whether the SCROLL LOCK meta key is on. - See Also - isScrollLockOn() - getMetaState() - Keycode_SCROLL_LOCK - (0x00400000) - - - - - This mask is used to check whether the left SHIFT meta key is pressed. - See Also - isShiftPressed() - getMetaState() - Keycode_SHIFT_LEFT - (0x00000040) - - - - - This mask is a combination of META_SHIFT_ON, META_SHIFT_LEFT_ON and META_SHIFT_RIGHT_ON. - (0x000000c1) - - - - - This mask is used to check whether one of the SHIFT meta keys is pressed. - See Also - isShiftPressed() - getMetaState() - Keycode_SHIFT_LEFT - Keycode_SHIFT_RIGHT - (0x00000001) - - - - - This mask is used to check whether the right SHIFT meta key is pressed. - See Also - isShiftPressed() - getMetaState() - Keycode_SHIFT_RIGHT - (0x00000080) - - - - - This mask is used to check whether the SYM meta key is pressed. - See Also - isSymPressed() - getMetaState() - (0x00000004) - - - - - Connection Type as described in the JSON Wire Protocol - - - - - Get/set the Connection Type - - Connection Type of device - Thrown when object return was not able to be converted to a ConnectionType Enum - - - - Returns the information of the system state which is supported to read e.g. cpu, memory, network - - The package name of the application - The type of system state which you want to read, use - or call to find a list of the supported performance data types. - - A table like list of the performance data, The first index of the table represents the type of data. - The remaining index represent the values of the data. - in case of battery info : [[power], [23]] - in case of memory info : - [[totalPrivateDirty, nativePrivateDirty, dalvikPrivateDirty, eglPrivateDirty, glPrivateDirty, - totalPss, nativePss, dalvikPss, eglPss, glPss, nativeHeapAllocatedSize, nativeHeapSize], - [18360, 8296, 6132, null, null, 42588, 8406, 7024, null, null, 26519, 10344]] - in case of network info : - [[bucketStart, activeTime, rxBytes, rxPackets, txBytes, txPackets, operations, bucketDuration,], - [1478091600000, null, 1099075, 610947, 928, 114362, 769, 0, 3600000], - [1478095200000, null, 1306300, 405997, 509, 46359, 370, 0, 3600000]] - in case of network info : - [[st, activeTime, rb, rp, tb, tp, op, bucketDuration], - [1478088000, null, null, 32115296, 34291, 2956805, 25705, 0, 3600], - [1478091600, null, null, 2714683, 11821, 1420564, 12650, 0, 3600], - [1478095200, null, null, 10079213, 19962, 2487705, 20015, 0, 3600], - [1478098800, null, null, 4444433, 10227, 1430356, 10493, 0, 3600]] - in case of cpu info : [[user, kernel], [0.9, 1.3]] - - - - - Returns the information of the system state which is supported to read e.g. cpu, memory, network - - The package name of the application - The type of system state which you want to read, use - or call to find a list of the supported performance data types. - The number of attempts to read data in the event of a data read failure (optional). Value must be greater than 0. - - A table like list of the performance data, The first index of the table represents the type of data. - The remaining index represent the values of the data. - in case of battery info : [[power], [23]] - in case of memory info : - [[totalPrivateDirty, nativePrivateDirty, dalvikPrivateDirty, eglPrivateDirty, glPrivateDirty, - totalPss, nativePss, dalvikPss, eglPss, glPss, nativeHeapAllocatedSize, nativeHeapSize], - [18360, 8296, 6132, null, null, 42588, 8406, 7024, null, null, 26519, 10344]] - in case of network info : - [[bucketStart, activeTime, rxBytes, rxPackets, txBytes, txPackets, operations, bucketDuration,], - [1478091600000, null, 1099075, 610947, 928, 114362, 769, 0, 3600000], - [1478095200000, null, 1306300, 405997, 509, 46359, 370, 0, 3600000]] - in case of network info : - [[st, activeTime, rb, rp, tb, tp, op, bucketDuration], - [1478088000, null, null, 32115296, 34291, 2956805, 25705, 0, 3600], - [1478091600, null, null, 2714683, 11821, 1420564, 12650, 0, 3600], - [1478095200, null, null, 10079213, 19962, 2487705, 20015, 0, 3600], - [1478098800, null, null, 4444433, 10227, 1430356, 10493, 0, 3600]] - in case of cpu info : [[user, kernel], [0.9, 1.3]] - - - - - Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery - - - - - Set a setting for this test session It's probably better to use a - convenience function, rather than use this function directly. Try finding - the method for the specific setting you want to change. - - Setting you wish to set. - value of the setting. - - - - Gets/Sets settings stored for this test session. - - - - - Set the `ignoreUnimportantViews` setting. * Android-only method*. - Sets whether Android devices should use `setCompressedLayoutHeirarchy()` - which ignores all views which are marked IMPORTANT_FOR_ACCESSIBILITY_NO - or IMPORTANT_FOR_ACCESSIBILITY_AUTO(and have been deemed not important - by the system), in an attempt to make things less confusing or faster. - - ignores unimportant views if true, doesn't ignore otherwise. - - - - invoke {@code setWaitForIdleTimeout} in {@code com.android.uiautomator.core.Configurator} - - timeout in milliseconds. A negative value would reset to its default value - - - - invoke {@code setWaitForSelectorTimeout} in {@code com.android.uiautomator.core.Configurator} - - timeout in milliseconds. A negative value would reset to its default value - - - - invoke {@code setScrollAcknowledgmentTimeout} in {@code com.android.uiautomator.core.Configurator} - - timeout in milliseconds. A negative value would reset to its default value - - - - invoke {@code configuratorSetKeyInjectionDelay} in {@code com.android.uiautomator.core.Configurator} - - delay in milliseconds. A negative value would reset to its default value - - - - invoke {@code setActionAcknowledgmentTimeout} in {@code com.android.uiautomator.core.Configurator} - - timeout in milliseconds. A negative value would reset to its default value - - - - Saves a string as a file on the remote mobile device. - - Path to file to write data to on remote device - A string to write to remote device - - - - Saves base64 encoded data as a file on the remote mobile device. - - Path to file to write data to on remote device - Base64 encoded byte array of data to write to remote device - - - - Saves given file as a file on the remote mobile device. - - Path to file to write data to on remote device - A file to write to remote device - - - - Opens an arbitrary activity during a test. If the activity belongs to - another application, that application is started and the activity is opened. - - - The package containing the activity to start. - The activity to start. - Begin automation after this package starts. Can be null or empty. - Begin automation after this activity starts. Can be null or empty. - If true, target app will be stopped. - - - - Opens an arbitrary activity during a test. If the activity belongs to - another application, that application is started and the activity is opened. - - - The package containing the activity to start. - The activity to start. - Intent action which will be used to start activity. - Begin automation after this package starts. Can be null or empty. - Begin automation after this activity starts. Can be null or empty. - Intent category which will be used to start activity. - Flags that will be used to start activity. - Additional intent arguments that will be used to start activity. - If true, target app will be stopped. - - - - Gets Current Device Activity. - - - - - - Creates a new key event - - The key code. This is mandatory - - - - - Sets the key code. - This is mandatory. - - The key code - - - - - - Adds the meta key modifier - Flags indicating which meta keys are currently pressed. - Multiple meta key modifier flags can be combined into a single key event - - The meta state - - - - - - Adds the flag(s). - Multiple flags can be combined into a single key event - - The flag - - - - - - A convenience class to wrap Android UiScrollable method calls. - - - Docs: https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable - - - - - Creates a new scrollable searcher which will match the first scrollable widget - in the view. - - - - - Creates a new scrollable searcher which will match the first widget - which matches the given UISelector. - - - A UiSelector that will be used to find the scrollable container - - - - - Performs a backwards fling action with the default number of fling steps (5). If the swipe direction - is set to vertical, then the swipe will be performed from top to bottom. If the swipe direction is set - to horizontal, then the swipes will be performed from left to right. Make sure to take into account - devices configured with right-to-left languages like Arabic and Hebrew. - Maps to the UiScrollable.flingBackward() method. - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#flingbackward - - - - Performs a forward fling with the default number of fling steps (5). If the swipe direction is set - to vertical, then the swipes will be performed from bottom to top. If the swipe direction is set to - horizontal, then the swipes will be performed from right to left. Make sure to take into account - devices configured with right-to-left languages like Arabic and Hebrew. - Maps to the UiScrollable.flingForward() method. - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#flingforward - - - - Performs a fling gesture to reach the beginning of a scrollable layout element. The beginning can - be at the top-most edge in the case of vertical controls, or the left-most edge for horizontal - controls. Make sure to take into account devices configured with right-to-left languages like - Arabic and Hebrew. - Maps to the UiScrollable.flingToBeginning(int) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#flingtobeginning - - - - Performs a fling gesture to reach the end of a scrollable layout element. The end can be at the - bottom-most edge in the case of vertical controls, or the right-most edge for horizontal controls. - Make sure to take into account devices configured with right-to-left languages like Arabic and Hebrew. - Maps to the UiScrollable.flingToEnd() method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#flingtoend - - - - Searches for a child element in the present scrollable container. The search first looks for a - child element that matches the selector you provided, then looks for the content-description in - its children elements. If both search conditions are fulfilled, the method returns a {@ link UiObject} - representing the element matching the selector (not the child element in its subhierarchy containing - the content-description). By default, this method performs a scroll search. - Maps to the UiScrollable.getChildByDescription(UiSelector, String, boolean) method. - - - UiSelector for a child in a scollable layout element - - - Content-description to find in the children of the childPattern match (may be a partial match) - - - Set to true if scrolling is allowed - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#getchildbydescription_1 - - - - Searches for a child element in the present scrollable container that matches the selector you provided. - The search is performed without scrolling and only on visible elements. - Maps to the UiScrollable.getChildByInstance(UiSelector, int) method. - - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#getchildbyinstance - - - - Searches for a child element in the present scrollable container. The search first looks for - a child element that matches the selector you provided, then looks for the text in its children - elements. If both search conditions are fulfilled, the method returns a {@ link UiObject} - representing the element matching the selector (not the child element in its subhierarchy containing - the text). By default, this method performs a scroll search. - Maps to the UiScrollable.getChildByText(UiSelector, String, boolean) method. - - - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#getchildbytext - - - - Performs a backward scroll. If the swipe direction is set to vertical, then the swipes will be performed - from top to bottom. If the swipe direction is set to horizontal, then the swipes will be performed - from left to right. Make sure to take into account devices configured with right-to-left languages - like Arabic and Hebrew. - Maps to the UiScrollable.scrollBackward(int) method. - - - Number of steps. Use this to control the speed of the scroll action. - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#scrollbackward - - - - Performs a forward scroll action on the scrollable layout element until the content-description - is found, or until swipe attempts have been exhausted. See - Maps to the UiScrollable.scrollDescriptionIntoView(String) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#scrolldescriptionintoview - - - - Performs a forward scroll. If the swipe direction is set to vertical, then the swipes will be performed - from bottom to top. If the swipe direction is set to horizontal, then the swipes will be performed - from right to left. Make sure to take into account devices configured with right-to-left languages - like Arabic and Hebrew. - Maps to the UiScrollable.scrollForward(int) method. - - - Number of steps. Use this to control the speed of the scroll action. - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#scrollforward - - - - Performs a forward scroll action on the scrollable layout element until the text you - provided is visible, or until swipe attempts have been exhausted. See - Maps to the UiScrollable.scrollTextIntoView() method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#scrolltextintoview - - - - Scrolls to the beginning of a scrollable layout element. The beginning can be at the top-most - edge in the case of vertical controls, or the left-most edge for horizontal controls. Make sure - to take into account devices configured with right-to-left languages like Arabic and Hebrew. - Maps to the UiScrollable.scrollToBeginning(int, int) method. - - - - Use steps to control the speed, so that it may be a scroll, or fling - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#scrolltobeginning - - - - Scrolls to the end of a scrollable layout element. The end can be at the bottom-most edge in - the case of vertical controls, or the right-most edge for horizontal controls. Make sure to take - into account devices configured with right-to-left languages like Arabic and Hebrew. - Maps to the UiScrollable.scrollToEnd(int, int) method. - - - - Use steps to control the speed, so that it may be a scroll, or fling - - - - - - Sets the percentage of a widget's size that's considered as no-touch zone when swiping. - The no-touch zone is set as percentage of a widget's total width or height, denoting a margin - around the swipable area of the widget. Swipes must always start and end inside this margin. - This is important when the widget being swiped may not respond to the swipe if started at a - point too near to the edge. The default is 10% from either edge. - Maps to the UiScrollable.setSwipeDeadZonePercentage(double) method. - - - A percentage value from 0 to 1 - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#setswipedeadzonepercentage - - - - Sets the scrolling direction of the list. - Maps to UiScrollable.setAsHorizontalList() or UiScrollable.setAsVerticalList() depending on the provided . - - - - - - - Sets the maximum number of scrolls allowed when performing a scroll action in search of a child element. - See and . - Maps to the UiScrollable.setMaxSearchSwipes(int) method. - - - - - - - Perform a scroll forward action to move through the scrollable layout element until a visible item that matches the selector is found. - Maps to the UiScrollable.scrollIntoView(UiSelector) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiScrollable#scrollintoview - - - - Append raw text to this instance. The target language is Java. - Text entered here will not be checked for validity. Use this at your own risk. - - - Text to be appended to the UiScrollable command builder. - - - - - Compiles the current UiScrollable statements that have - been added to this instance. - - - - - - Compiles the current UiScrollable statements into a valid Java string which can be executed. - - - Should the statement be returned with a semicolon terminator at the end. Defaults to false. - The terminator is only appended to the returned statement string - this is not affected. - - - - - Append a statement that immediately ends the current statement chain. - - - A compatible formatting string - - - An array of objects to format - - - - - A convenience class to wrap Android UiSelector method calls. - The output of this class can be passed to some methods to find an element using - the Android UiSelector class. - - - Class docs: https://developer.android.com/reference/android/support/test/uiautomator/UiSelector.html - - - - - Creates a new UiSelector builder. - - - - - Creates a new UiSelector builder by copying all existing data - from the given selector. - - - The to copy into this new instance - - - - - Set the search criteria to match widgets that are checkable. Typically, using this search criteria - alone is not useful. You should also include additional criteria, such as text, content-description, - or the class name for a widget. If no other search criteria is specified, and there is more than one - matching widget, the first widget in the tree is selected. - Maps to the UiSelector.checkable(boolean) method. - - - When true, matches elements which are checkable. When false, matches elements which are not checkable. - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#checkable - - - - Set the search criteria to match widgets that are currently checked (usually for checkboxes). Typically, - using this search criteria alone is not useful. You should also include additional criteria, such as text, - content-description, or the class name for a widget. If no other search criteria is specified, and there is - more than one matching widget, the first widget in the tree is selected. - Maps to the UiSelector.checked(boolean) method. - - - When true, matches elements which are checked. When false, matches elements which are not checked. - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#checked - - - - Adds a child UiSelector criteria to this selector. Use this selector to narrow the search scope to child - widgets under a specific parent widget. - Maps to the UiSelector.childSelector(UiSelector) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#childselector - - - - Set the search criteria to match the class property for a widget (for example, "android.widget.Button"). - Maps to the UiSelector.className(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#classname - - - - Set the search criteria to match the class property for a widget (for example, "android.widget.Button"). - Maps to the UiSelector.classNameMatches(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#classnamematches - - - - Set the search criteria to match widgets that are clickable. Typically, using this search criteria alone is not - useful. You should also include additional criteria, such as text, content-description, or the class name for a - widget. If no other search criteria is specified, and there is more than one matching widget, the first widget - in the tree is selected. - Maps to the UiSelector.clickable(boolean) method. - - - When true, matches elements which are clickable. When false, matches elements which are not clickable. - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#clickable - - - - Set the search criteria to match the content-description property for a widget. The content-description - is typically used by the Android Accessibility framework to provide an audio prompt for the widget when - the widget is selected. The content-description for the widget must match exactly with the string in your - input argument. Matching is case-sensitive. - Maps to the UiSelector.description(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#description - - - - Set the search criteria to match the content-description property for a widget. The content-description is - typically used by the Android Accessibility framework to provide an audio prompt for the widget when the - widget is selected. The content-description for the widget must contain the string in your input argument. - Matching is case-insensitive. - Maps to the UiSelector.descriptionContains(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#descriptioncontains - - - - Set the search criteria to match the content-description property for a widget. The content-description is - typically used by the Android Accessibility framework to provide an audio prompt for the widget when the - widget is selected. The content-description for the widget must match exactly with the string in your input - argument. - Maps to the UiSelector.descriptionMatches(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#descriptionmatches - - - - Set the search criteria to match the content-description property for a widget. The content-description is - typically used by the Android Accessibility framework to provide an audio prompt for the widget when the - widget is selected. The content-description for the widget must start with the string in your input argument. - Matching is case-insensitive. - Maps to the UiSelector.descriptionStartsWith(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#descriptionstartswith - - - - Set the search criteria to match widgets that are enabled. Typically, using this search criteria alone is not - useful. You should also include additional criteria, such as text, content-description, or the class name for - a widget. If no other search criteria is specified, and there is more than one matching widget, the first - widget in the tree is selected. - Maps to the UiSelector.enabled(boolean) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#enabled - - - - Set the search criteria to match widgets that are focusable. Typically, using this search criteria alone is - not useful. You should also include additional criteria, such as text, content-description, or the class - name for a widget. If no other search criteria is specified, and there is more than one matching widget, - the first widget in the tree is selected. - Maps to the UiSelector.focusable(boolean) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#focusable - - - - Set the search criteria to match widgets that have focus. Typically, using this search criteria alone is - not useful. You should also include additional criteria, such as text, content-description, or the class - name for a widget. If no other search criteria is specified, and there is more than one matching widget, - the first widget in the tree is selected. - Maps to the UiSelector.focused(boolean) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#focused - - - - Adds a child UiSelector criteria to this selector which is used to start search from the parent widget. - Use this selector to narrow the search scope to sibling widgets as well all child widgets under a parent. - Maps to the UiSelector.fromParent(UiSelector) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#fromparent - - - - Set the search criteria to match the widget by its node index in the layout hierarchy. The index value must - be 0 or greater. Using the index can be unreliable and should only be used as a last resort for matching. - Instead, consider using the method. - Maps to the UiSelector.index(int) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#index - - - - Set the search criteria to match the widget by its instance number. The instance value must - be 0 or greater, where the first instance is 0. For example, to simulate a user click on the - third image that is enabled in a UI screen, you could specify a a search criteria where the - instance is 2, the className(String) matches the image widget class, and enabled(boolean) is - true. - Maps to the UiSelector.instance(int) method. - - - The 0-indexed instance to match on - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#instance - - - - Set the search criteria to match widgets that are long-clickable. Typically, using this search - criteria alone is not useful. You should also include additional criteria, such as text, - content-description, or the class name for a widget. If no other search criteria is specified, - and there is more than one matching widget, the first widget in the tree is selected. - Maps to the UiSelector.longClickable(int) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#longclickable - - - - Set the search criteria to match the package name of the application that contains the widget. - Maps to the UiSelector.packageName(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#packagename - - - - Set the search criteria to match the package name of the application that contains the widget. - Maps to the UiSelector.packageNameMatches(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#packagenamematches - - - - Set the search criteria to match the given resource ID. - Maps to the UiSelector.resourceId(String) method. - - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#resourceid - - - - Set the search criteria to match the resource ID of the widget, using a regular expression. - Maps to the UiSelector.resourceIdMatches(String) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiSelector.html#resourceidmatches - - - - Set the search criteria to match widgets that are scrollable. Typically, using this - search criteria alone is not useful. You should also include additional criteria, such - as text, content-description, or the class name for a widget. If no other search criteria - is specified, and there is more than one matching widget, the first widget in the tree - is selected. - Maps to the UiSelector.scrollable(boolean) method. - - - When true, matches elements which are scrollable. When false, matches elements which are not scrollable. - - https://developer.android.com/reference/android/support/test/uiautomator/UiSelector.html#scrollable - - - - Set the search criteria to match widgets that are currently selected. Typically, using this - search criteria alone is not useful. You should also include additional criteria, such as text, - content-description, or the class name for a widget. If no other search criteria is specified, and - there is more than one matching widget, the first widget in the tree is selected. - Maps to the UiSelector.selected(boolean) method. - - - When true, matches elements which are scrollable. When false, matches elements which are not scrollable. - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#selected - - - - Includes elements whose accessibility-id attribute is equal to the given text. - Maps to the UiSelector.text(String) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiSelector.html#text - - - - Includes elements whose text attribute is equal to the given text. - Maps to the UiSelector.text(String) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiSelector.html#text - - - - Set the search criteria to match the visible text in a widget where the visible text must contain the - string in your input argument. The matching is case-sensitive. - Maps to the UiSelector.textContains(String) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiSelector.html#textcontains - - - - Set the search criteria to match the visible text displayed in a layout element, using a regular expression. - The text in the widget must match exactly with the string in your input argument. - Maps to the UiSelector.textMatches(String) method. - - - A regular expression - - https://developer.android.com/reference/androidx/test/uiautomator/UiSelector#textmatches - - - - Set the search criteria to match visible text in a widget that is prefixed by the text parameter. - The matching is case-insensitive. - Maps to the UiSelector.textStartsWith(String) method. - - - https://developer.android.com/reference/android/support/test/uiautomator/UiSelector#textstartswith - - - - Append raw text to this instance. The target language is Java. - Text entered here will not be checked for validity. Use this at your own risk. - - - Text to be appended to the UiSelector command builder. - - - - - Compiles the current UiSelector statements that have - been added to this instance. - - - - - - Appium capabilities - - - - - Get the capabilities back as a dictionary - - This method uses Reflection and should be removed once - AppiumOptions class is avalaible for each driver - - - - - - Container class for the command tuple - - - - - This method adds Appium-specific commands to the given - CommandInfoRepository - - is a CommandInfoRepository instance which is used - The given CommandInfoRepository instance with added Appium-specific commands - - - - command type - - - - - Command - - - - - API Endpoint - - - - - - Prepares single command argument - - The parameter name - The parameter value - - - - - Prepares a collection of command arguments - - The array of parameter names - The array of parameter values - - - - - - Get all defined Strings from an app for the specified language and - strings filename - - a dictionary with localized strings defined in the app. - strings language code - strings filename - - - - Hides the device keyboard. - - - - - Hides the device keyboard. - - The button pressed by the mobile driver to attempt hiding the keyboard. - - - - Hides the device keyboard. - - Hide keyboard strategy (optional, UIAutomation only). Available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'. - The button pressed by the mobile driver to attempt hiding the keyboard. - - - - Whether or not the soft keyboard is shown. - - True if the keyboard is shown. (boolean) - - - - GPS Location - - - - - Get a list of IME engines available on the device - - List of available - - - - Get the currently active IME Engine on the device - - Active IME Engine - - - - Is the IME active on the device (NOTE: on Android, this is always true) - - true if IME is active, false otherwise - - - - Activate the given IME on Device - - IME to activate - - - - Deactivate the currently Active IME Engine on device - - - - - Gets device date and time for both iOS(Supports only real device) and Android devices - - A string which consists of date and time - - - - Performs images matching by features. Read - https://docs.opencv.org/3.0-beta/doc/py_tutorials/py_feature2d/py_matcher/py_matcher.html - for more details on this topic. - - base64-encoded representation of the first image - base64-encoded representation of the second image - comparison options - The matching result. The configuration of fields in the result depends on comparison options - - - - Performs images matching by template to find possible occurrence of - the partial image in the full image with default options. Read - https://docs.opencv.org/2.4/doc/tutorials/imgproc/histograms/template_matching/template_matching.html - for more details on this topic. - - base64-encoded representation of the full image - base64-encoded representation of the partial image - comparison options - The matching result. The configuration of fields in the result depends on comparison options. - - - - Performs images matching to calculate the similarity score between them. - The flow there is similar to the one used in - - but it is mandatory that both images are of equal size. - - base64-encoded representation of the first image - base64-encoded representation of the second image - comparison options - Matching result. The configuration of fields in the result depends on comparison options. - - - - Represents the Shake Device Mapping command - - - - - Represents the Lock Device Mapping command - - - - - Represents the Unlock Device Mapping command - - - - - Represents the Is Device Locked Mapping command - - - - - Toggle's the Airplane Mode ("Flight Safe Mode") Command - - - - - Toggle Wifi Command. - - - - - Set GSM signal strength - - - - - Set GSM voice state - - - - - Toggle Network Data Command - - - - - Press key code - - - - - Long press key code - - - - - Rotate Command. - - - - - Get CurrentActivity Command. - - - - - Get CurrentPackage Command. - - - - - Install App Command. - - - - - Remove App Command. - - - - - Activate App Command. - - - - - Remove App Command. - - - - - Is App Installed Command. - - - - - Push File Command. - - - - - Pull File Command. - - - - - Pull Folder Command. - - - - - Toggle Wifi Command. - - - - - Toggle Location Services Command. - - - - - Launch App Command. - - - - - Close App Command. - - - - - Reset App Command. - - - - - Background App Command. - - - - - End Test Coverage Command. - - - - - Get App Strings Command. - - - - - Get App State Command. - - - - - Represents the Hide Keyboard command - - - - - Whether or not the soft keyboard is shown - - - - - Open Notifications Command - - - - - Get System Bars - - - - - Get the time on the device - - - - - Get Display Density - - - - - The Start Activity command - - - - - Set GPS Location Command. - - - - - Get GPS Location Command. - - - - - Perform touch action - - - - - Perform multi touch action - - - - - Perform multi purpose W3C actions - - - - - Represents the Contexts command - - - - - Represents the Get Context command - - - - - Represents the Set Context command - - - - - Represents the Get Orientation Command - - - - - Represents the Set Orientation Command - - - - - Represents the Get Network Connection Command - - - - - Represents the Set Network Connection Command - - - - - Represents the Get Available Engines Command - - - - - Represents the Get Active Engine Command - - - - - Represents the is IME active Command - - - - - Represents the Activate Engine Command - - - - - Represents the Deactivate Engine Command - - - - - Represents the Screenshot Command - - - - - Represents the GetSettings Command - - - - - Represents the UpdateSettings Command - - - - - Represents the TouchID command - - - - - Represents the fingerPrint command - - - - - Generic browser options - - - - - The dictionary of capabilities - - - - - Add new capabilities - - Capability name - Capabilities value, which cannot be null or empty - - - - Turn the capabilities into an desired capability - - A desired capability - - - - AppiumElement allows you to have access to specific items that are found on the page. - - - - - - [Test] - public void TestGoogle() - { - driver = new AppiumDriver(); - AppiumElement elem = driver.FindElement(By.Name("q")); - elem.SendKeys("Cheese please!"); - } - - - - - - Initializes a new instance of the AppiumElement class. - - Driver in use. - ID of the element. - - - - - Finds the first element in the page that matches the OpenQA.Selenium.By object - - Mechanism to find element - first element found - - - - - - - Finds the first element in the page that matches the ID supplied - - ID of the element - First element found - - - - Finds a list of elements that match the ID supplied - - ID of the element - ReadOnlyCollection of elements found - - - - Finds the first element matching the specified CSS selector - - The CSS selector to match - First element found - - - - Finds a list of elements that match the CSS selector - - The CSS selector to match - ReadOnlyCollection of elements found - - - - Finds the first of elements that match the link text supplied - - Link text of element - First element found - - - - Finds a list of elements that match the link text supplied - - Link text of element - ReadOnlyCollection of elements found - - - - Finds the first of elements that match the name supplied - - Name of the element on the page - First element found - - - - Finds a list of elements that match the name supplied - - Name of the element on the page - ReadOnlyCollection of elements found - - - - Finds the first of elements that match the part of the link text supplied - - Part of the link text - First element found - - - - Finds a list of elements that match the part of the link text supplied - - Part of the link text - ReadOnlyCollection of elements found - - - - Finds the first of elements that match the DOM Tag supplied - - DOM tag name of the element being searched - First element found - - - - Finds a list of elements that match the DOM Tag supplied - - DOM tag name of the element being searched - ReadOnlyCollection of elements found - - - - Finds the first of elements that match the XPath supplied - - xpath to the element - First element found - - - - Finds a list of elements that match the XPath supplied - - xpath to the element - ReadOnlyCollection of elements found - - - - The list of Android-specific capabilities - Read: https://github.com/appium/appium/blob/1.5/docs/en/writing-running-appium/caps.md#android-only - - - - - Activity name for the Android activity you want to launch from your package. This often needs to be preceded - by a . (e.g., .MainActivity instead of MainActivity) - - - - - Java package of the Android app you want to run - - - - - Activity name for the Android activity you want to wait for - - - - - Java package of the Android app you want to wait for - - - - - Timeout in seconds while waiting for device to become ready - - - - - Fully qualified instrumentation class. Passed to -w in adb shell am instrument -e coverage true -w - - - - - (Chrome and webview only) Enable Chromedriver's performance logging (default false) - - - - - Timeout in seconds used to wait for a device to become ready after booting - - - - - Port used to connect to the ADB server (default 5037) - - - - - Devtools socket name. Needed only when tested app is a Chromium embedding browser. - The socket is open by the browser and Chromedriver connects to it as a devtools client. - - - - - Name of avd to launch - - - - - How long to wait in milliseconds for an avd to launch and connect to ADB (default 120000) - - - - - How long to wait in milliseconds for an avd to finish its boot animations (default 120000) - - - - - Additional emulator arguments used when launching an avd - - - - - Use a custom keystore to sign apks, default false - - - - - Path to custom keystore, default ~/.android/debug.keystore - - - - - Password for custom keystore - - - - - Alias for key - - - - - Password for key - - - - - The absolute local path to webdriver executable (if Chromium embedder provides its own webdriver, - it should be used instead of original chromedriver bundled with Appium) - - - - - Amount of time to wait for Webview context to become active, in ms. Defaults to 2000 - - - - - Intent action which will be used to start activity (default android.intent.action.MAIN) - - - - - Intent category which will be used to start activity (default android.intent.category.LAUNCHER) - - - - - Flags that will be used to start activity (default 0x10200000) - - - - - Additional intent arguments that will be used to start activity. See Intent arguments: - http://developer.android.com/tools/help/adb.html#IntentSpec - - - - - Doesn't stop the process of the app under test, before starting the app using adb. - If the app under test is created by another anchor app, setting this false, - allows the process of the anchor app to be still alive, during the start of the test app using adb. - In other words, with dontStopAppOnReset set to true, we will not include the -S flag in the adb shell am start call. - With this capability omitted or set to false, we include the -S flag. Default false - - - - - Enable Unicode input, default false - - - - - Reset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability. - Ignored if used alone. Default false - - - - - Skip checking and signing of app with debug keys, will work only with - UiAutomator and not with selendroid, default false - - - - - Calls the setCompressedLayoutHierarchy() uiautomator function. This capability can speed up test execution, - since Accessibility commands will run faster ignoring some elements. The ignored elements will not be findable, - which is why this capability has also been implemented as a toggle-able setting as well as a capability. - Defaults to false - - - - - Disables android watchers that watch for application not responding and application crash, - this will reduce cpu usage on android device/emulator. This capability will work only with - UiAutomator and not with selendroid, default false - - - - - Allows passing chromeOptions capability for ChromeDriver. For more information see chromeOptions: - https://sites.google.com/a/chromium.org/chromedriver/capabilities - - - - Kill ChromeDriver session when moving to a non-ChromeDriver webview. Defaults to false - - - - In a web context, use native (adb) method for taking a screenshot, rather than proxying - to ChromeDriver, default false. - - - - - The name of the directory on the device in which the screenshot will be put. - Defaults to /data/local/tmp. - - - - - Timeout in milliseconds used to wait for an apk to install to the device. Defaults to `90000`. - - - - - Timeout in seconds while waiting for device to become ready. - - - - - Have Appium automatically determine which permissions your app requires and grant them to the app on install. - Defaults to false. If noReset is true, this capability doesn't work. - - - - - The list of iOS-specific capabilities - Read: https://github.com/appium/appium/blob/1.5/docs/en/writing-running-appium/caps.md#ios-only - - - - - (Sim-only) Calendar format to set for the iOS Simulator - - - - - Bundle ID of the app under test. Useful for starting an app on a real device or for using other caps which require - the bundle ID during test startup. To run a test on a real device using the bundle ID, - you may omit the 'app' capability, but you must provide 'udid'. - - - - - Amount of time in ms to wait for instruments before assuming it hung and failing the session - - - - - (Sim-only) Force location services to be either on or off. Default is to keep current sim setting. - - - - - (Sim-only) Set location services to be authorized or not authorized for app via plist, so that location services - alert doesn't pop up. Default is to keep current sim setting. Note that - if you use this setting you MUST also use the bundleId capability to send in your app's bundle ID. - - - - - Accept all iOS alerts automatically if they pop up. This includes privacy access permission alerts - (e.g., location, contacts, photos). Default is false. - - - - - Dismiss all iOS alerts automatically if they pop up. - This includes privacy access permission alerts (e.g., - location, contacts, photos). Default is false. - - - - - Use native intruments lib (ie disable instruments-without-delay). - - - - - (Sim-only) Enable "real", non-javascript-based web taps in Safari. - Default: false. - Warning: depending on viewport size/ratio this might not accurately tap an element - - - - - (Sim-only) (>= 8.1) Initial safari url, default is a local welcome page - - - - - (Sim-only) Allow javascript to open new windows in Safari. Default keeps current sim setting - - - - - (Sim-only) Prevent Safari from showing a fraudulent website warning. Default keeps current sim setting. - - - - - (Sim-only) Whether Safari should allow links to open in new windows. Default keeps current sim setting. - - - - - (Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finished - - - - - Where to look for localizable strings. Default en.lproj - - - - - Arguments to pass to the AUT using instruments - - - - - The delay, in ms, between keystrokes sent to an element when typing. - - - - - Whether to show any logs captured from a device in the appium logs. Default false - - - - - strategy to use to type test into a test field. Simulator default: oneByOne. Real device default: grouped - - - - - Max timeout in sec to wait for a screenshot to be generated. default: 10 - - - - - The ios automation script used to determined if the app has been launched, - by default the system wait for the page source not to be empty. The result must be a boolean - - - - - Number of times to send connection message to remote debugger, to get webview. Default: 8 - - - - - The display name of the application under test. Used to automate backgrounding the app in iOS 9+. - - - - - It is native Android browser. - - - - - Capability name used for the apllication setting. - - - - - Capability name used for the target platform name setting. - - - - - Capability name used for the target platform version setting. - - - - - Capability name used for the automation name (e.g. Appium, Selendroid and so on) setting. - - - - - Time out for the waiting for a new command. - - - - - Name of mobile web browser to automate. Should be an empty string if automating an app instead. - - - - - Capability name used for the automation name (e.g. Appium, Selendroid and so on) setting. - - - - - Capability name used for the setting up of the required appium version. - - - - - - (Sim/Emu-only) Language to set for the simulator / emulator - - - - - (Sim/Emu-only) Locale to set for the simulator / emulator - - - - - (Sim/Emu-only) start in a certain orientation - - - - - Move directly into Webview context. Default false - - - - - Don't reset app state before this session. Default false - - - - - (iOS) Delete the entire simulator folder. (Android) Reset app state by uninstalling app instead of clearing app data. - On Android, this will also remove the app after the session is complete. Default false - - - - - The given value must not be null, otherwise an - will be thrown. - - - The value to test - - The name of the parameter which is being checked. This is to help identify - the parameter which did not meet the requirement. Use nameof() to ensure - proper refactoring support. - - - - - The given value must be greater than or equal to 0 (zero), otherwise - an will be thrown. - - The value to test - - The name of the parameter which is being checked. This is to help identify - the parameter which did not meet the requirement. Use nameof() to ensure - proper refactoring support. - - - - - The given value must be between 0 and 1, otherwise an - will be thrown. - - The value to test - - The name of the parameter which is being checked. This is to help identify - the parameter which did not meet the requirement. Use nameof() to ensure - proper refactoring support. - - - - - - Makes the endpoint to return an image, - which contains the visualized result of the corresponding - picture matching operation. This option is disabled by default. - - - - - The visualization of the matching result represented as base64-encoded PNG image. - - - - - Sets the detector name for features matching algorithm. - Some of these detectors (FAST, AGAST, GFTT, FAST, SIFT and MSER) are not available - in the default OpenCV installation and have to be enabled manually before - library compilation. The default detector name is 'ORB'. - - - - - The name of the matching function. - The default one is 'BruteForce'. - - - - - The maximum count of "good" matches (e. g. with minimal distances). - - - - - The count of matched edges on both images. - The more matching edges there are no both images the more similar they are. - - - - - The total count of matched edges on both images. - It is equal to `count` if `goodMatchesFactor` does not limit the matches, - otherwise it contains the total count of matches before `goodMatchesFactor` - is applied. - - - - - The list of matching points on the first image. - - - - - The list of matching points on the second image. - - - - - The bounding rect for the `points1` list or a zero rect if not enough matching points were found. - - - - - The bounding rect for the `points2` list or a zero rect if not enough matching points were found. - - - - - At what normalized threshold to reject an occurrence. - Value in range 0..1. 0.5 is the default value. - - - - - The region of the partial image occurence on the full image. - - - - - The similarity score as a float number in range [0.0, 1.0]. - 1.0 is the highest score (means both images are totally equal). - - - - - Provides a method by which optional attributes can be added to an Interactions. - - - - - Returns optional values that are set to extend the default interaction values. - - A representing the values that are set. - - - - Represents a collection of optional attributes for pen pointer interaction. - - - - - The normalized pressure of the pointer input in the range of [0,1] - - - - - The clockwise rotation (in degrees, in the range of [0,359]) of a transducer (e.g. pen stylus) around its own major axis - - - - - The plane angle (in degrees, in the range of [-90,90]) between the Y-Z plane and the plane containing both the transducer (e.g. pen stylus) axis and the Y axis - - - - - The plane angle (in degrees, in the range of [-90,90]) between the X-Z plane and the plane containing both the transducer (e.g. pen stylus) axis and the X axis - - - - - Returns optional values that are set to extend the default pen pointer interaction values. - - A representing the values that are set. - - - - Represents a collection of optional attributes for touch pointer interaction. - - - - - The normalized pressure of the pointer input in the range of [0,1] - - - - - The clockwise rotation (in degrees, in the range of [0,359]) of a transducer (e.g. pen stylus) around its own major axis - - - - - The width (magnitude on the X axis), in pixels of the contact geometry of the pointer - - - - - The height (magnitude on the Y axis), in pixels of the contact geometry of the pointer - - - - - Returns optional values that are set to extend the default touch pointer interaction values. - - A representing the values that are set. - - - - Specifies the button used during a pointer down or up action. - - - - - Neither buttons nor touch/pen contact changed since last event - - - - - Mouse left button - - - - - Default touch contact - - - - - The pen tip - - - - - Mouse middle button - - - - - Mouse right button - - - - - Pen barrel button - - - - - Mouse X1 (back) button - - - - - Mouse X1 (forward) button - - - - - The pen eraser button - - - - - Represents a pointer input device such as pen, touch, and mouse. This class extends - OpenQA.Selenium.Interactions.PointerUInputDevice to add optional interaction values - such as pressure, rotation, tilt angle, etc. - - - - - Initializes a new instance of the class. - - The kind of pointer represented by this input device. - - - - Initializes a new instance of the class. - - The kind of pointer represented by this input device. - The unique name for this input device. - - - - Creates a pointer down action. - - The button of the pointer that should be pressed. - The action representing the pointer down gesture. - - - - Creates a pointer up action. - - The button of the pointer that should be released. - The action representing the pointer up gesture. - - - - Creates a pointer down action. - - The button of the pointer that should be pressed. - Additional pointer attributes. - The action representing the pointer down gesture. - - - - Creates a pointer up action. - - The button of the pointer that should be released. - Additional pointer attributes. - The action representing the pointer up gesture. - - - - Creates a pointer move action to a specific element. - - The used as the target for the move. - The horizontal offset from the origin of the move. - The vertical offset from the origin of the move. - The length of time the move gesture takes to complete. - Additional pointer attributes. - The action representing the pointer move gesture. - - - - Creates a pointer move action to an absolute coordinate. - - The origin of coordinates for the move. Values can be relative to - the view port origin, or the most recent pointer position. - The horizontal offset from the origin of the move. - The vertical offset from the origin of the move. - The length of time the move gesture takes to complete. - Additional pointer attributes. - The action representing the pointer move gesture. - Thrown when passing CoordinateOrigin.Element into origin. - Users should use the other CreatePointerMove overload to move to a specific element. - - - - Some implementations of WebDriver, notably those that support native testing, need the ability - to switch between the native and web-based contexts. This can be achieved by using this - interface. - - - - - Switches the focus of future commands for this driver to the context with the given name - AND - returns an opaque handle to this context that uniquely identifies it within this driver - instance. - - - - - Return a list of context handles which can be used to iterate over all contexts of this - WebDriver instance - - - - - Execute a command on the remote server. - - A remote command - Parameters to execute - The result - - - - Execute a command on the remote server. - - A remote command - - - - Finds the first of elements that match the Accessibility Id selector supplied - - an Accessibility Id selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Accessibility Id selector supplied - - an Accessibility Id selector - IWebElement object so that you can interact that object - - - - Finds the first element in the page that matches the Android Espresso's Data Matcher selector supplied - - Selector for the element. - IWebElement object so that you can interact that object - - - IWebDriver driver = new WebDriver(new DriverOptions()); - IWebElement elem = driver.FindElementByAndroidDataMatcher('elements()')) - - - - - - Finds a list of elements that match the Android Espresso's Data Matcher selector supplied - - Selector for the elements. - ReadOnlyCollection of IWebElement object so that you can interact with those objects - - - IWebDriver driver = new WebDriver(new FirefoxOptions()); - ReadOnlyCollection]]> elem = driver.FindElementsByAndroidDataMatcher(elements()) - - - - - - Finds the first element in the page that matches the Android UIAutomator selector supplied - - Selector for the element. - IWebElement object so that you can interact that object - - - IWebDriver driver = new WebDriver(new FirefoxOptions()); - IWebElement elem = driver.FindElementByAndroidUIAutomator('elements()')) - - - - - - Finds the first element in the page that matches the Android UIAutomator selector supplied - - Selector for the element. - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Android UIAutomator selector supplied - - Selector for the elements. - ReadOnlyCollection of IWebElement object so that you can interact with those objects - - - IWebDriver driver = new WebDriver(new FirefoxOptions()); - ReadOnlyCollection]]> elem = driver.FindElementsByAndroidUIAutomator(elements()) - - - - - - Finds a list of elements that match the Android UIAutomator selector supplied - - Selector for the elements. - ReadOnlyCollection of IWebElement object so that you can interact with those objects - - - - Finds the first of elements that match the Ios UIAutomation selector supplied - - an Ios UIAutomation selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Ios UIAutomation selector supplied - - an Ios UIAutomation selector - IWebElement object so that you can interact that object - - - - Finds the first of elements that match the Tizen UIAutomation selector supplied - - a Tizen UIAutomation selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Tizen UIAutomation selector supplied - - a Tizen UIAutomation selector - ReadOnlyCollection of IWebElement objects so that you can interact with those objects - - - - Finds the first of elements that match the Windows UIAutomation selector supplied - - a Windows UIAutomation selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Windows UIAutomation selector supplied - - a Windows UIAutomation selector - ReadOnlyCollection of IWebElement objects so that you can interact with those objects - - - - Method performs the searching for a single element by some selector defined by string - and value of the given selector - - is a string selector - is a value of the given selector - the first found element - - - - Method performs the searching for a list of elements by some selector defined by string - and value of the given selector - - is a string selector - is a value of the given selector - a list of elements - - - - Performs the lookup for a single element by matching its image template - to the current full screen shot. This type of locator requires OpenCV libraries - and bindings for NodeJS to be installed on the server machine. - Lookup options fine-tuning might be done via . (Supported since Appium 1.8.2) - - base64-encoded template image string. - Supported image formats are the same as for OpenCV library. - - For the documentation on Image Comparison Features - For the settings available for lookup fine-tuning - The first element that matches the given selector - - - - Performs the lookup for a list of elements by matching its image template - to the current full screen shot. This type of locator requires OpenCV libraries - and bindings for NodeJS to be installed on the server machine. - Lookup options fine-tuning might be done via . (Supported since Appium 1.8.2) - - base64-encoded template image string. - Supported image formats are the same as for OpenCV library. - - For the documentation on Image Comparison Features - For the settings available for lookup fine-tuning - A list of elements that match the given selector or an empty list - - - - Finds the first of elements that match the IosClassChain selector supplied - - an IosClassChain selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the IosClassChain selector supplied - - an IosClassChain selector - ReadOnlyCollection of IWebElement objects so that you can interact with those objects - - - - Finds the first of elements that match the IosNsPredicate selector supplied - - an IosNsPredicate selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the IosNsPredicate selector supplied - - an IosNsPredicate selector - ReadOnlyCollection of IWebElement objects so that you can interact with those objects - - - - Sets the content to the clipboard - - - - - - - Get the content of the clipboard. - - - Android supports plaintext only - The content of the clipboard as base64-encoded string or an empty string if the clipboard is empty - - - - Sets text to the clipboard - - - For Android only - A user visible label for the clipboard content. - - - - Get the plaintext content of the clipboard. - - Android supports plaintext only - The string content of the clipboard or an empty string if the clipboard is empty - - - - Sets the url string to the clipboard - - - - - - Gets the url string from the clipboard - - The url string content of the clipboard or an empty string if the clipboard is empty - - - - Sets the image to the clipboard - - - - - - Gets the image from the clipboard - - The image content of the clipboard as base64-encoded string or an empty string the clipboard is empty - - - - Describes a contract by which you can get or set a GPS location on a mobile device. - - - - - Gets or sets the GPS location of this mobile device. - - - - - a dictionary of values that hold session details. - - - - - This property returns a certain session detail by it key - or null if there is no such detail. - - is the detail key-name - an object of null if there is no such detail - - - - This property returns a name of the mobile plathorm of the current - session. - - - - - This property returns a name of the automation type of the current - session. - - - - - This property should return true when - user's code is currently works on browser or web view. - false should be returned otherwice. - - - - - Hides the device keyboard. - - - - - Hides the device keyboard. - - The button pressed by the mobile driver to attempt hiding the keyboard. - - - - Hides the device keyboard. - - Hide keyboard strategy (optional, UIAutomation only). Available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'. - The button pressed by the mobile driver to attempt hiding the keyboard. - - - - Whether or not the soft keyboard is shown - - if keyboard is shown, if not. - - - - Hides the keyboard if it is showing. Hiding the keyboard often - depends on the way an app is implemented, no single strategy always - works. - - a String, representing the text displayed on the button of the - keyboard you want to press. For example: "Done". - - HideKeyboardStrategy - - - - Installs an App. - - a string containing the file path or url of the app. - - - - Launches the current app. - - - - - Checks If an App Is Installed. - - a string containing the bundle id. - a boolean indicating if the app is installed. - - - - Resets the current app. - - - - - Deactivates app completely (as "Home" button does). - - - - - Backgrounds the current app for the given number of seconds or deactivates app completely if negative number is given. - - an integer number containing the number of seconds. - - - - Backgrounds the current app for the given number of seconds or deactivates app completely if negative number is given. - - the timespan of running the app in the background. - - - - Removes an App. - - a string containing the id of the app. - - - - Activates the given app by moving to the foreground if it is running in the background or starting it if it is not running yet. - - a string containing the id of the app. - - - - Terminates an App. - - a string containing the id of the app. - a boolean indicating if the app was terminated. - - - - Terminates an App. - - a string containing the id of the app. - a TimeSpan for how long to wait until the application is terminated. - a boolean indicating if the app was terminated in the given timeout. - - - - Closes the current app. - - - - - Gets the State of the app. - - a string containing the id of the app. - an enumeration of the app state. - - - - Pulls a File. - - path on device to pull - - - - Pulls a Folder - - remote path to the folder to return - a base64 encoded string representing a zip file of the contents of the folder - - - - This interface extends IWebElement and defines specific behavior - for mobile. - - - - - Add touch actions to be performed - - - - - - Cancels the Multi Action - - - - - Performs the Multi Action - - - - - Gets the actions parameter dictionary for this multi touch action - - empty dictionary if no actions found, else dictionary of actions - - - - Toggle airplane mode on device. - Only supports below API 24 (Android 7) on emulators - - - - - - Switch the state of the WiFi service - - - - - Switch the state of the location service - - - - - Make GSM call (Emulator only) - - - - - - - Simulate an SMS message (Emulator only) - - - - - - - Sets GSM signal strength (Emulator only) - - - - - - - Set GSM voice state (Emulator only) - - - - - - Provides a mechanism for building advanced interactions with the browser/application. - - - - - Performs the multi-action sequence. - - Multi-action to perform. - - - - Perform the touch-action sequence. - - touch action to perform - - - - Sends a device key event with meta state - - Code for the long key pressed on the Android device - metastate for the long key press - - - - Sends a device long key event with meta state - - Code for the long key pressed on the Android device - metastate for the long key press - - - - Sends a key event to the device under test - - The generated key event - - - - Sends a long press key event to the device under test - - The generated key event - - - - Press at the specified location in the element until the context menu appears. - - The target element. - The x coordinate relative to the element. - The y coordinate relative to the element. - A self-reference to this . - - - - Press at the specified location until the context menu appears. - - The target element. - The x coordinate relative to the element. - The y coordinate relative to the element. - A self-reference to this . - - - - Move to the specified location in the element. - - The target element. - The x coordinate relative to the element. - The y coordinate relative to the element. - A self-reference to this . - - - - Move to the specified location. - - The x coordinate. - The y coordinate. - A self-reference to this . - - - - Press at the specified location in the element. - - The target element. - The x coordinate relative to the element. - The y coordinate relative to the element. - A self-reference to this . - - - - Press at the specified location. - - The x coordinate. - The y coordinate. - A self-reference to this . - - - - Release the pressure. - - A self-reference to this . - - - - Tap at the specified location in the element. - - The target element. - The x coordinate relative to the element. - The y coordinate relative to the element. - The number of times to tap. - A self-reference to this . - - - - Tap at the specified location. - - The x coordinate. - The y coordinate. - The number of times to tap. - A self-reference to this . - - - - Wait for the given duration. - - The amount of time to wait in milliseconds. - A self-reference to this . - - - - Cancels the Multi Action - - - - - Performs the Multi Action - - - - - This interface extends IWebElement and adds caching support. - To enable caching at the driver level, set the shouldUseCompactResponses capability: - shouldUseCompactResponses: true - To specify the attributes to be cached, set the elementResponseAttributes capability: - elementResponseAttributes: "name,text,rect,attribute/name,attribute/value" - Note: the cache uses W3C names for attributes. - For TagName, use "name" - For Size, Location use "rect" - - - - - Replace any existing values in the cache with the supplied values. - The cache is enabled for this element. - The new cache values - - - - - Disable the cache for this element. - - - - - Clear all values from the cache. - - - - - Simulate touchId event - - If true, simulates a successful fingerprint scan. - If false, simulates a failed fingerprint scan. - - - - Shakes the device. - - - - - Initializes a new instance of the IOSDriver class - - An object which executes commands for the driver. - An object containing the Appium options. - - - - Initializes a new instance of the IOSDriver class using Appium options - - An object containing the Appium options of the browser. - - - - Initializes a new instance of the IOSDriver class using Appium options and command timeout - - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the IOSDriver class using the AppiumServiceBuilder instance and Appium options - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - - - - Initializes a new instance of the IOSDriver class using the AppiumServiceBuilder instance, Appium options and command timeout - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the IOSDriver class using the specified remote address and Appium options - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - - - - Initializes a new instance of the IOSDriver class using the specified Appium local service and Appium options - - the specified Appium local service - An object containing the Appium options of the browser. - - - - Initializes a new instance of the IOSDriver class using the specified remote address, Appium options, and command timeout. - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the IOSDriver class using the specified Appium local service, Appium options, and command timeout. - - the specified Appium local service - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Locks the device. - - The number of seconds during which the device need to be locked for. - - - - Sets the content to the clipboard - - - - - - - Get the content of the clipboard. - - - Android supports plaintext only - The content of the clipboard as base64-encoded string or an empty string if the clipboard is empty - - - - Sets text to the clipboard - - - For Android only - A user visible label for the clipboard content. - - - - Get the plaintext content of the clipboard. - - Android supports plaintext only - The string content of the clipboard or an empty string if the clipboard is empty - - - - Sets the url string to the clipboard - - - - - - Gets the url string from the clipboard - - The url string content of the clipboard or an empty string if the clipboard is empty - - - - Sets the image to the clipboard - - - - - - Gets the image from the clipboard - - The image content of the clipboard as an Image object or null if there is no image on the clipboard - - - - Initializes a new instance of the IOSElement class. - - Driver in use. - ID of the element. - - - - The format of the screen capture to be recorded. - Available formats: "h264", "mp4" or "fmp4". Default is "mp4". - Only works for Simulator. - - one of available format names. - self instance for chaining. - - - - The format of the screen capture to be recorded. - Available formats: Execute ffmpeg -codecs in the terminal to see the list of supported video codecs. - ‘mjpeg’ by default. (Since Appium 1.10.0) - - one of available format names. - self instance for chaining. - - - - The video encoding quality (low, medium, high, photo - defaults to medium). - Only works for real devices. - - - - - - - The maximum recording time.The default value is 180 seconds (3 minutes). - The maximum value is 10 minutes. - Setting values greater than this or less than zero will cause an exception. The minimum - time resolution unit is one second. - - The actual time limit of the recorded video. - self instance for chaining. - - - - The Frames Per Second rate of the recorded video. - Change this value if the resulting video is too slow or too fast. - Defaults to 10. This can decrease the resulting file size. - - - self instance for chaining. - - - - The scaling value to apply. - Read here for possible values. - Example value of 720p scaling is '1280:720'. This can decrease/increase the resulting file size. - No scale is applied by default. - - - self instance for chaining. - - - - Output pixel format. - Run ffmpeg -pix_fmts to list possible values. - For QuickTime compatibility, set to “yuv420p” along with videoType: “libx264”. - Supported since Appium 1.12.0) - - - - - - - The ffmpeg video filters to apply. - These filters allow to scale, flip, rotate and do many other useful transformations on the source video stream. - The format of the property must comply with listed here - Supported since Appium 1.15) - - - - - - - Initializes a new instance of the MacDriver class - - An object which executes commands for the driver. - An object containing the Appium options. - - - - Initializes a new instance of the MacDriver class using Appium options - - An object containing the Appium options of the browser. - - - - Initializes a new instance of the MacDriver class using Appium options and command timeout - - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the MacDriver class using the AppiumServiceBuilder instance and Appium options - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - - - - Initializes a new instance of the MacDriver class using the AppiumServiceBuilder instance, Appium options and command timeout - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the MacDriver class using the specified remote address and Appium options - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - - - - Initializes a new instance of the MacDriver class using the specified Appium local service and Appium options - - the specified Appium local service - An object containing the Appium options of the browser. - - - - Initializes a new instance of the MacDriver class using the specified remote address, Appium options, and command timeout. - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the MacDriver class using the specified Appium local service, Appium options, and command timeout. - - the specified Appium local service - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the MacElement class. - - Driver in use. - ID of the element. - - - - Find a single element. - - Context used to find the element. - The element that matches - - - - Finds many elements - - Context used to find the element. - A readonly collection of elements that match. - - - - This method creates a strategy - that searches for elements by accessibility id - About Android accessibility - - About iOS accessibility - - - The selector to use in finding the element. - - - - - This method creates a strategy - that searches for elements using Android UI automation framework. - - - The selector to use in finding the element. - - - - - This method creates a strategy - that searches for elements using Android UI automation framework. - - - The selector to use in finding the element. - - - - - This method creates a strategy - that searches for elements using Espresso's Data Matcher. - - - The selector to use in finding the element. - - - - - This method creates a strategy - that searches for elements using iOS UI automation. - - - The selector to use in finding the element. - - - - - Finds element when the Accessibility Id selector has the specified value. - About Android accessibility - - About iOS accessibility - - - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Finds element when the Android UIAutomator selector has the specified value. - - - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Finds element when the Espresso's Data Matcher selector has the specified value. - - - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Finds element when the Ios UIAutomation selector has the specified value. - - - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Initializes a new instance of the class. - - The selector to use in finding the element. - - - - Initializes a new instance of the class. - - base64-encoded template image string. - - - - Initializes a new instance of the class. - - The the driver to be used. - - - - Add touch actions to be performed - - - - - - Gets the actions parameter dictionary for this multi touch action - - empty dictionary if no actions found, else dictionary of actions - - - - Cancels the Multi Action - - - - - Executes the Multi Action - - - - - - - - - - - Release the pressure. - - A self-reference to this . - - - - Tap at the specified location in the element. - - The target element. - The x coordinate relative to the element. - The y coordinate relative to the element. - The number of times to tap. - A self-reference to this . - - - - Tap at the specified location. - - The x coordinate relative to the element. - The y coordinate relative to the element. - The number of times to tap. - A self-reference to this . - - - - Wait for the given duration. - - The amount of time to wait in milliseconds. - A self-reference to this . - - - - Cancels the Touch Action - - - - - Executes the Touch Action - - - - - Determines if two instances are equal. - - One instance to compare. - The other instance to compare. - if the two instances are equal; otherwise, . - - - - Determines if two instances are unequal. - s - One instance to compare. - The other instance to compare. - if the two instances are not equal; otherwise, . - - - - Determines if one instance is greater than another. - - One instance to compare. - The other instance to compare. - if the first instance is greater than the second; otherwise, . - - - - Determines if one instance is less than another. - - One instance to compare. - The other instance to compare. - if the first instance is less than the second; otherwise, . - - - - Compares the current instance with another object of the same type and returns an - integer that indicates whether the current instance precedes, follows, or occurs - in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. The return value has these meanings: - - ValueMeaning - Less than zeroThis instance precedes in the sort order. - ZeroThis instance occurs in the same position in the sort order as . - Greater than zeroThis instance follows in the sort order. - - - - - - Determines whether the specified Object is equal - to the current Object. - - The Object to compare with the - current Object. - if the specified Object - is equal to the current Object; otherwise, - . - - - - Serves as a hash function for a particular type. - - A hash code for the current Object. - - - - Gets or sets a value indicating where this attribute should be evaluated relative to other instances - of this attribute decorating the same class member. - - - - - Sets the target element id - - - - - Sets the target element class name - - - - - Sets the target element tag name - - - - - Sets the target element xpath - - - - - Sets the target accessibility - - - - - Sets the target UI automator locator - - - - - Sets the target UI automation locator - - - - - Sets the target element link text. - This locator is supported by Selendroid - - - - - Sets the target element partial link text - This locator is supported by Selendroid - - - - - Sets the target element name - - - - - Marks elements to indicate that found elements should match the criteria of - all or - or on the field or property. - - - - When used with a set of , all criteria must be - matched to be returned. The criteria are used in sequence according to the - Priority property. Note that the behavior when setting multiple - or - or Priority properties to the same value, or not - specifying a Priority value, is undefined. - - - - // Will find the element with the class "SomeClass" that also has an ID - // attribute matching "elementId". - [MobileFindsByAll(Android = true)] - [FindsByAndroidUIAutomator(Class = "SomeClass", Priority = 0)] - [FindsByAndroidUIAutomator(Id = "elementId", Priority = 1)] - public IWebElement thisElement; - - - - - - - If this property is "true" then target elements should match the criteria of - all on the field or property. - - - - - If this property is "true" then target elements should match the criteria of - all on the field or property. - - - - - If this property is "true" then target elements should match the criteria of - all on the field or property. - - - - - If this property is "true" then target elements should match the criteria of - all on the field or property. - - - - - Marks elements to indicate that each or - or on the field or - property should be used in sequence to find the appropriate element. - - - - When used with a set of or - or , the criteria are used - in sequence according to the Priority property to find child elements. Note that - the behavior when setting multiple Priority - properties to the same value, or not specifying a Priority value, is undefined. - - - - // Will find the element with the ID attribute matching "elementId", then will find - // a child element with the ID attribute matching "childElementId". - [MobileFindsBySequence(Android = true)] - [FindsByAndroidUIAutomator(Id = "elementId", Priority = 0)] - [FindsByAndroidUIAutomator(Id = "childElementId", Priority = 1)] - public IWebElement targetElement; - - - - - - - If this property is "true" then each on the field or - property will be used in sequence to find the appropriate element. - - - - - If this property is "true" then each on the field or - property will be used in sequence to find the appropriate element. - - - - - If this property is "true" then each on the field or - property will be used in sequence to find the appropriate element. - - - - - If this property is "true" then each on the field or - property will be used in sequence to find the appropriate element. - - - - - This class stores the time of the waiting for elements. - It also allows to change this duration in runtime. - - - - - This method returns a wrapped IWebDriver instance - - - - - - Extension methods to convert to/from ScreenOrientation enum - - - - - Converts the Screen Orientation to the string needed by the JSON Wire Protocol - - - - - - - Converts the string to a screen orientation if possible, else throws ArgumentOutOfRangeException - - - Screen Orientation - - - - Upload options set for the recorded screen capture. - - Upload options - - - - - Get all setted parameters - - - - - - The maximum recording time. - - The actual time limit of the recorded video. - self instance for chaining. - - - - Whether to ignore the result of previous capture and start a new recording - immediately. By default the endpoint will try to catch and return the result of - the previous capture if it's still available. - - self instance for chaining. - - - - The remotePath upload option is the path to the remote location, - where the resulting video should be uploaded. - The following protocols are supported: http/https (multipart), ftp. - - Missing value (the default setting) means the content of the resulting - file should be encoded as Base64 and passed as the endpoint response value, but - an exception will be thrown if the generated media file is too big to - fit into the available process memory. - This option only has an effect if there is a screen recording session in progress - and forced restart is not enabled (the default setting). - - Upload options - self instance for chaining. - - - - The remotePath upload option is the path to the remote location, - where the resulting video should be uploaded. - The following protocols are supported: http/https (multipart), ftp. - Missing value (the default setting) means the content of resulting - file should be encoded as Base64 and passed as the endpoint response value, but - an exception will be thrown if the generated media file is too big to - fit into the available process memory. - - Upload options - self instance for chaining. - - - - The path to the remote location, where the resulting video should be uploaded. - - The path to a writable remote location. - self instance for chaining. - - - - Sets the credentials for remote ftp/http authentication (if needed). - This option only has an effect if remotePath is provided. - - The name of the user for the remote authentication. - The password for the remote authentication. - self instance for chaining. - - - - Sets the method name for http(s) upload. PUT is used by default. - This option only has an effect if remotePath is provided. - - method The HTTP method name. - self instance for chaining. - - - - Get all setted parameters - - - - - - Creates an instance of AppiumLocalService without special settings - - An instance of AppiumLocalService without special settings - - - - The base URL for the managed appium server. - - - - - Event that can be used to capture the output of the service - - - - - Starts the defined appium server - - - - - Stops this service if it is currently running. - - - - - Is the defined appium server being run or not - - - - - This thing accepts parameters and builds instances of AppiumLocalService - - - - - This method specifies Appium server options - - A collection of Appium server options - Self reference - - - - This method defines the desired Appium server binary - - Is a file path to the desired appium.js file - Self-reference - - - - This method defines the IP Address to listen on - - the IP Address to listen on - Self-reference - - - - Sets time value for the service starting up - - a time value for the service starting up - self-reference - - - - Command line arguments that will be passed to NodeJS when it starts up. - - - A collection of raw string arguments that will be passed to NodeJS. - Spaces will be automatically added between arguments. You are responsible for - properly escaping any special characters for your operating system. - Arguments cannot be null, empty strings, or only whitespace. - - - - - - - - Sets which Node.js the builder will use. - - The executable Node.js to use. - self-reference - - - - Sets which port the appium server should be started on. A value of 0 indicates that any - free port may be used. - - The port to use; must be non-negative. - self-reference - - - - Configures the appium server to start on any available port. - - self-reference - - - - Defines the environment for the launched appium server. - - A dictionary of the environment variables to launch the - appium server with. - self-reference - - - - Configures the appium server to write log to the given file. - - A file to write log to. - self-reference - - - - This method builds an instance of AppiumLocalService using defined parameters - - an instance of AppiumLocalService built using defined parameters - - - - The environmental variable used to define - the path to executable appium.js (1.4.x and lower) or - main.js (1.5.x and higher) - - - - - The environmental variable used to define - the path to executable NodeJS file (node.exe for WIN and - node for Linux/MacOS X) - - - - - Here is the list of Android specific server arguments. - All flags are optional, but some are required in conjunction with certain others. - The full list is available here: http://appium.io/slate/en/master/?ruby#appium-server-arguments - Android specific arguments are marked by (Android-only) - - - - - Port to use on device to talk to Appium
- Sample:
- --bootstrap-port 4724 - - - - - Local port used for communication with Selendroid
- Sample:
- --selendroid-port 8080 - - - - - - If set, prevents Appium from killing the adb server - instance
- - - - - Port upon which ChromeDriver will run
- Sample:
- --chromedriver-port 9515 - - - - - ChromeDriver executable full path - - - - - Here is the list of common Appium server arguments. - All flags are optional, but some are required in conjunction with certain others. - The full list is available here: http://appium.io/slate/en/master/?ruby#appium-server-arguments - - - - - Enter REPL mode - - - - - callback IP Address (default: same as address)
- Sample
- --callback-address 127.0.0.1 - - - - - callback port (default: same as port)
- Sample
- --callback-port 4723 - - - - - Enables session override (clobbering)
- - - - - Pre-launch the application before allowing the first session (Requires –app and, for Android, –app-pkg and –app-activity)
- - - - - The message log level to be shown
- Sample:
- --log-level debug - - - - - Show timestamps in console output
- - - - - Use local timezone for timestamps
- - - - - Don’t use colors in console output
- - - - - Also send log output to this HTTP listener
- Sample:
- --webhook localhost:9876 - - - - - Configuration JSON file to register Appium with selenium grid
- Sample:
- --nodeconfig /abs/path/to/nodeconfig.json - - - - - IP Address of robot
- Sample:
- --robot-address 0.0.0.0 - - - - - Port for robot
- Sample:
- --robot-port 4242 - - - - - Show info about the Appium server configuration and exit
- - - - - Bypass Appium’s checks to ensure we can read/write necessary files
- - - - - Cause sessions to fail if desired caps are sent in that Appium does not - recognize as valid for the selected device
- - - - - Absolute path to directory Appium can use to manage temporary files, like - built-in iOS apps it needs to move around. On *nix/Mac defaults to /tmp, - on Windows defaults to C:\Windows\Temp
- - - - - Add exaggerated spacing in logs to help with visual inspection
- - - - - Add long stack traces to log entries. Recommended for debugging only. - - - - - Here is the list of iOS specific server arguments. - All flags are optional, but some are required in conjunction with certain others. - The full list is available here: http://appium.io/slate/en/master/?ruby#appium-server-arguments - Android specific arguments are marked by (IOS-only) - - - - - absolute path to compiled .ipa file - Sample:
- --ipa /abs/path/to/my.ipa - - - - - How many times to retry launching Instruments before saying it - crashed or timed out
- Sample:
- --backend-retries 3 - - - - - Use the safari app
- - - - - use the default simulator that instruments launches - on its own
- - - - - Use the iPhone Simulator no matter what the app wants
- - - - - Use the iPad Simulator no matter what the app wants
- - - - - .tracetemplate file to use with Instruments
- Sample:
- --tracetemplate /Users/me/Automation.tracetemplate - - - - - custom path to the instruments commandline tool
- Sample:
- --instruments /path/to/instruments - - - - - Xcode 6 has a bug on some platforms where a certain simulator can only be - launched without error if all other simulator devices are first deleted. - This option causes Appium to delete all devices other than the one being - used by Appium. Note that this is a permanent deletion, and you are - responsible for using simctl or xcode to manage the categories of devices - used with Appium
. - - - - - Absolute path to directory Appium use to save ios instruments traces, - defaults to /appium-instruments
- - - - - Local port used for communication with ios-webkit-debug-proxy. - Sample:
- --webkit-debug-proxy-port 27753 - - - - - Adds an argument and its value - - is a structure where the first alement is a server argument and the second one - is string value of the passed argument - self reference - - - - Adds/merges server-specific capabilities - - is an instance of OpenQA.Selenium.Remote.AppiumOptions - the self-reference - - - - Builds a sequence of server arguments - - - - - Initializes a new instance of the TizenDriver class - - An object which executes commands for the driver. - An object containing the Appium options. - - - - Initializes a new instance of the TizenDriver class using Appium options - - An object containing the Appium options of the browser. - - - - Initializes a new instance of the TizenDriver class using Appium options and command timeout - - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the TizenDriver class using the AppiumServiceBuilder instance and Appium options - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - - - - Initializes a new instance of the TizenDriver class using the AppiumServiceBuilder instance, Appium options and command timeout - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the TizenDriver class using the specified remote address and Appium options - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - - - - Initializes a new instance of the TizenDriver class using the specified Appium local service and Appium options - - the specified Appium local service - An object containing the Appium options of the browser. - - - - Initializes a new instance of the TizenDriver class using the specified remote address, Appium options, and command timeout. - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the TizenDriver class using the specified Appium local service, Appium options, and command timeout. - - the specified Appium local service - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Finds the first of elements that match the Tizen UIAutomation selector supplied - - a Tizen UIAutomation selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Tizen UIAutomation selector supplied - - a Tizen UIAutomation selector - ReadOnlyCollection of IWebElement objects so that you can interact with those objects - - - - Initializes a new instance of the TizenElement class. - - Driver in use. - ID of the element. - - - - Initializes a new instance of the WindowsDriver class using Appium options - - An object containing the Appium options of the browser. - - - - Initializes a new instance of the WindowsDriver class using Appium options and command timeout - - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the WindowsDriver class using the AppiumServiceBuilder instance and Appium options - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - - - - Initializes a new instance of the WindowsDriver class using the AppiumServiceBuilder instance, Appium options and command timeout - - object containing settings of the Appium local service which is going to be started - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the WindowsDriver class using the specified remote address and Appium options - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - - - - Initializes a new instance of the WindowsDriver class using the specified Appium local service and Appium options - - the specified Appium local service - An object containing the Appium options of the browser. - - - - Initializes a new instance of the WindowsDriver class using the specified remote address, Appium options, and command timeout. - - URI containing the address of the WebDriver remote server (e.g. http://127.0.0.1:4723/wd/hub). - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Initializes a new instance of the WindowsDriver class using the specified Appium local service, Appium options, and command timeout. - - the specified Appium local service - An object containing the Appium options. - The maximum amount of time to wait for each command. - - - - Finds the first of elements that match the Windows UIAutomation selector supplied - - a Windows UIAutomation selector - IWebElement object so that you can interact that object - - - - Finds a list of elements that match the Windows UIAutomation selector supplied - - a Windows UIAutomation selector - ReadOnlyCollection of IWebElement objects so that you can interact with those objects - - - - Defines the interface through which the user finds elements by their CSS class. - - - - - Finds the first element matching the specified CSS class. - - The CSS class to match. - The first matching the criteria. - - - - Finds all elements matching the specified CSS class. - - The CSS class to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by their cascading style sheet (CSS) selector. - - - - - Finds the first element matching the specified CSS selector. - - The id to match. - The first matching the criteria. - - - - Finds all elements matching the specified CSS selector. - - The CSS selector to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by their ID. - - - - - Finds the first element matching the specified id. - - The id to match. - The first matching the criteria. - - - - Finds all elements matching the specified id. - - The id to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by their link text. - - - - - Finds the first element matching the specified link text. - - The link text to match. - The first matching the criteria. - - - - Finds all elements matching the specified link text. - - The link text to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by their name. - - - - - Finds the first element matching the specified name. - - The name to match. - The first matching the criteria. - - - - Finds all elements matching the specified name. - - The name to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by a partial match on their link text. - - - - - Finds the first element matching the specified partial link text. - - The partial link text to match. - The first matching the criteria. - - - - Finds all elements matching the specified partial link text. - - The partial link text to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by their tag name. - - - - - Finds the first element matching the specified tag name. - - The tag name to match. - The first matching the criteria. - - - - Finds all elements matching the specified tag name. - - The tag name to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface through which the user finds elements by XPath. - - - - - Finds the first element matching the specified XPath query. - - The XPath query to match. - The first matching the criteria. - - - - Finds all elements matching the specified XPath query. - - The XPath query to match. - A containing all - IWebElements matching the criteria. - - - - Defines the interface used to search for elements. - - - - - Finds the first using the given method. - - The locating mechanism to use. - The first matching on the current context. - If no element matches the criteria. - - - - Finds all IWebElements within the current context - using the given mechanism. - - The locating mechanism to use. - A of all WebElements - matching the current criteria, or an empty list if nothing matches. - - - diff --git a/src/Appium.Net/NOTICE.txt b/src/Appium.Net/NOTICE.txt deleted file mode 100644 index 0a5b036b6..000000000 --- a/src/Appium.Net/NOTICE.txt +++ /dev/null @@ -1 +0,0 @@ -Copyright 2014-2018 Appium Contributors \ No newline at end of file