Constants

Virtual Remote Control (VRC) button key codes

VRC buttons are used via suitest.VRC.*, * being a key code from below. For example suitest.VRC.FAST_FWD.

Smart TVs

Code Key name IR-controlled Android TV Apple tvOS Roku
BACK Back -
BLUE Blue - ✓ (B)
BUTTON_10 Gamepad button 10 - - -
BUTTON_11 Gamepad button 11 - - -
BUTTON_12 Gamepad button 12 - - -
CH_DOWN Channel down - -
CH_UP Channel up - -
D_PAD_CENTER D-pad center - - -
DOWN Down
ENTER Enter - -
EXIT Exit - ✓ (home)
FAST_FWD Fast forward -
GREEN Green - ✓ (A)
GUIDE Guide - -
HOME Home - -
LEFT Left
LOCK Lock - - - -
MENU Menu -
MUTE Mute - -
NUM_0 Numpad 0 - -
NUM_1 Numpad 1 - -
NUM_2 Numpad 2 - -
NUM_3 Numpad 3 - -
NUM_4 Numpad 4 - -
NUM_5 Numpad 5 - -
NUM_6 Numpad 6 - -
NUM_7 Numpad 7 - -
NUM_8 Numpad 8 - -
NUM_9 Numpad 9 - -
OK Ok -
PAUSE Pause - -
PLAY Play - -
PLAY_PAUSE Play/pause one button
POWER Power - - -
RECORD Record - -
RED Red - -
REPLAY Replay - - -
REWIND Rewind -
RIGHT Right
SELECT Select - - -
SETTINGS Settings -
SMART Smart - -
SOURCE Source - -
SPECIAL_NETFLIX Netflix - - -
SPECIAL_YOUTUBE YouTube - - -
STOP Stop - -
TELETEXT Teletext - -
TV TV (switch to live TV) - -
UP Up
VOL_DOWN Volume down - -
VOL_UP Volume up - -
YELLOW Yellow - -

Gaming consoles

Code Key name Xbox * PlayStation 4/5
A A button ✓ (green)
B B button ✓ (red)
BACK Back
CIRCLE Circle -
D_PAD_DOWN D-pad down
D_PAD_LEFT D-pad left
D_PAD_RIGHT D-pad right
D_PAD_UP D-pad up
DOWN Down
ENTER Enter
HOME Home
L1 L1
L2 L2
LEFT Left
LEFT_BUMPER Left bumper
LEFT_THUMBSTICK_BUTTON Left thumbstick button
LEFT_THUMBSTICK_DOWN Left thumbstick down
LEFT_THUMBSTICK_LEFT Left thumbstick left
LEFT_THUMBSTICK_RIGHT Left thumbstick right
LEFT_THUMBSTICK_UP Left thumbstick up
LEFT_TRIGGER Left trigger
MENU Menu -
OK Ok
OPTIONS Options -
POWER Power
R1 R1
R2 R2
RIGHT Right
RIGHT_BUMPER Right bumper
RIGHT_THUMBSTICK_BUTTON Right thumbstick button
RIGHT_THUMBSTICK_DOWN Right thumbstick down
RIGHT_THUMBSTICK_LEFT Right thumbstick left
RIGHT_THUMBSTICK_RIGHT Right thumbstick right
RIGHT_THUMBSTICK_UP Right thumbstick up
RIGHT_TRIGGER Right trigger
SHARE Share -
SQUARE Square
TRIANGLE Triangle
UP Up
VIEW View -
X X (Blue) button
Y Y (Yellow) button

* Xbox (One, Series X/S)

Mobile devices

Code Key name Android mobile Apple iOS
BACK Back
HOME Home
LOCK Lock
RECENT_APPS Recent applications -
VOL_DOWN Volume down
VOL_UP Volume up

Element properties

Element properties are used via suitest.PROP.*, * being a key code from below. For example suitest.PROP.CLASS.

Code Property description HTML-based Android Xbox Native * tvOS Roku
ACCESSIBILITY_IDENTIFIER unique identifier for element in scripts using UI Automation interface - - - -
ALPHA Transparency level from 0 to 1 - - -
AUTOMATION_ID Uniquely identifies the element in UI automation tools - - - -
AUTOMATION_NAME Name of an element used in UI automation tools - - - -
BAR_TINT_COLOR Color applied to the bar's background - - - -
BG_COLOR Color applied to the element background -
BORDER_COLOR Color applied to the border line of the element - - -
BORDER_STYLE Variant of the border line - - -
BORDER_WIDTH Width of the border line - - -
CLASS Class attribute - - - -
CONTENT_DESCRIPTION Value for accessibility services - - - -
CONTENT_MODE States how element's content layout changes when bounds change - - - -
FOCUS_MARGIN Only if UseSystemFocusVisuals is enabled - - - -
FOCUS_PRIMARY_COLOR Only if UseSystemFocusVisuals is enabled - - - -
FOCUS_PRIMARY_WIDTH Only if UseSystemFocusVisuals is enabled - - - -
FOCUS_SECONDARY_COLOR Only if UseSystemFocusVisuals is enabled - - - -
FOCUS_SECONDARY_WIDTH Only if UseSystemFocusVisuals is enabled - - - -
FONT_FAMILY Font of text - - -
FONT_NAME name of the font name - - - -
FONT_SIZE Size of text - - -
FONT_URI URI of font - - - -
FONT_WEIGHT Font weight of text - - - -
HAS_FOCUS Does the element have focus - - - -
HAS_META_DATA Video property has metadata - - - -
HAS_NAV_MARKERS Video property has navigation markers groups - - - -
HEIGHT Height of an element
HINT Default text for editable text fields - - - -
HREF If the element is a link the href attribute will hold the URL - - - -
ID Id attribute of the element - -
IMAGE URL of an image - -
IMAGE_HASH Base64 string of the image converted to MD5 hash - - -
IMAGE_LOAD_STATE Current status of the image state - - - -
IS_CHECKED If the element is in a checked state - - -
IS_CLICKABLE If the element is clickable (reacts to click events) - - - -
IS_COMPLETELY_DISPLAYED If the complete view width and height is visible - - - -
IS_ENABLED If the element is in an enabled state - -
IS_FOCUSABLE If the element is able to change to a focus state - - - -
IS_FOCUSED Is the element currently focused - - - -
IS_OPAQUE Is the element currently opaque - - - -
IS_SELECTED If the element is currently in the selected state - - -
IS_TOUCHABLE If the element has a touchable area - - - -
ITEMS_FOCUSED Element focused in list - - - -
LEFT Relative horizontal position to the parent element (in pixels)
LEFT_ABSOLUTE Element's left coordinate according to window origin - - -
MARGIN Value of the margin space around the element - - - -
NAME Name given to the element - - -
NUMBER_OF_SEGMENTS The number of segments in Segmented Control - - - -
OPACITY Opacity of the element - -
PACKAGE_NAME Name-space of the view - - - -
PADDING Value of the element's padding in all directions - - -
PIVOT_X The X coordinate around which the element is rotated - - - -
PIVOT_Y The Y coordinate around which the element is rotated - - - -
PLACEHOLDER String that is displayed when no text is in the input field - - - -
PROPOSAL_URL Video element that is proposed to be played next - - - -
SCALE_X The X coordinate around which the element is scaled - - - -
SCALE_Y The Y coordinate around which the element is scaled - - - -
SELECTED_IMAGE_TINT_COLOR Color applied to selected tab bar item - - - -
STATE Constant describing the state of the element - - - -
TAG String representation of the elements tag - - - -
TAG_INT Non-unique identifier for view objects - - - -
TEXT_ALIGNMENT Alignment of text inside the element - - - -
TEXT_COLOR Color of the text - -
TEXT_CONTENT Plain text of an element -
TEXT_SIZE Size of the elements text in pixels - - - -
TINT_COLOR Color tint of the element - - - -
TOP Relative vertical position to the parent element (in pixels)
TOP_ABSOLUTE Element's top coordinate according to the window origin - - -
TRANSLATION_X The horizontal location of the element relative to its left position - - - -
TRANSLATION_Y The vertical location of the element relative to its top position - - - -
URL URL of WebView component - - - -
VIDEO_LENGTH Total length of a video
VIDEO_POSITION Current position of a video
VIDEO_STATE Current state of a video
VIDEO_URL URL of a video
VISIBILITY If the element is visible on screen - -
WIDTH Width of the element
Z_INDEX Value of the CSS z-index property - - - -

* Xbox (One, Series X/S)

Roku Lite element properties

Code Property description
CHILDREN Element child count
EXTENDS Extends element
HEIGHT Height of an element
ID Id attribute of the element
IMAGE URL of an image
IMAGE_LOAD_STATE Current status of the image state
INDEX Value of the index property
IS_FOCUSABLE If the element is able to change to a focus state
IS_FOCUSED Is the element currently focused
ITEMS_FOCUSED Element focused in list
LEFT Relative horizontal position to the parent element (in pixels)
OPACITY Opacity of the element
TEXT_COLOR Color of the text
TEXT_CONTENT Plain text of an element
TOP Relative vertical position to the parent element (in pixels)
UI_ELEMENT_ID Identifier for the element
VISIBILITY If the element is visible on screen
WIDTH Width of the element

Property comparators

Code Comparator description
APPROX Approximately
CONTAIN Contains
END Ends with
EQUAL =
EQUAL_GREATER >=
EQUAL_LESSER <=
GREATER >
LESSER <
NOT_CONTAIN Does not contain
NOT_END Does not end with
NOT_EQUAL !=
NOT_START Does not start with
START Starts with

Element special values

Code Special value description
REPO Value for element property is taken from Element repository

Video states

Video states can be found in suitest.VIDEO_STATE.

Code State description HTML-Based Android Xbox Native * Apple TV Roku
BUFFERING Player is downloading video source over network to create a buffer - -
CONNECTING Player is trying to connect to video source - -
ERROR Error occurred during video initialization or playback
FINISHED Playback has finished, video source was played till the end -
IDLE Video is in pre-preparing phase - - - -
PAUSED Paused
PLAYBACK_COMPLETED Playback has finished, video source was played till the end - - - -
PLAYING Playing
PREPARED Video is prepared for playback - - - -
PREPARING Video is being prepared for playback - - - -
REVERSING Video is being played in reverse - - - -
STOPPED Playback stopped - -
UNKNOWN State cannot be obtained - - - -

* Xbox (One, Series X/S)

Element visibility states

Element visibility states can be found in suitest.VISIBILITY_STATE.

Code State description Android Xbox Native *
COLLAPSED Element is not visible -
GONE Element is not visible
INVISIBLE Element is not visible
VISIBLE Element is visible

* Xbox (One, Series X/S)

Session types

Code Session name
ACCESS_TOKEN Access token
AUTOMATED Automated mode
INTERACTIVE Interactive mode

Network properties

Network properties can be found in suitest.NETWORK_PROP.

Code
BODY
METHOD
STATUS

Network methods

Network methods can be found in suitest.NETWORK_METHOD.

Code
CONNECT
DELETE
GET
HEAD
OPTIONS
PATCH
POST
PUT
TRACE

Border style

Border style properties can be found in suitest.BORDER_STYLE.

Code HTML-Based Apple TV
BEZEL -
DASHED -
DOTTED -
DOUBLE -
GROOVE -
HIDDEN -
INHERIT -
INITIAL -
INSET -
NONE
OUTSET -
RECTANGLE -
RIDGE -
ROUNDED -
SOLID -

Launch modes (Android/LG webOS applications)

Launch modes can be found in suitest.LAUNCH_MODE.

Code
RESUME
RESTART

Screen orientations (Android mobile/iOS/iPadOS devices)

Screen orientations can be found in suitest.SCREEN_ORIENTATION.

Code Analogue in Test Editor
PORTRAIT Portrait
PORTRAIT_REVERSED Portrait (upside down / reversed)
LANDSCAPE Landscape (left)
LANDSCAPE_REVERSED Landscape (right / reversed)

Content Mode (Apple TV)

Content modes can be found in suitest.CONTENT_MODE.

Code
BOTTOM
BOTTOM_LEFT
BOTTOM_RIGHT
CENTER
LEFT
REDRAW
RIGHT
SCALE_ASPECT_FILL
SCALE_ASPECT_FIT
SCALE_TO_FILL
TOP
TOP_LEFT
TOP_RIGHT

State (Apple TV)

States can be found in suitest.ELEMENT_STATE. Check the Apple Developer guide for Focus and Selection for some visual examples.

Code
APPLICATION
DISABLED
FOCUSED
HIGHLIGHTED
NORMAL
RESERVED
SELECTED

Text Alignment (Apple TV)

Text alignment states can be found in suitest.TEXT_ALIGNMENT.

Code
CENTER
JUSTIFIED
LEFT
NATURAL
RIGHT