All URIs are relative to http://localhost:9987/v2

Method	HTTP request	Description
am_force_stop_get	GET /am/forceStop	Completely stop the given application package.
configurator_get_wait_for_idle_timeout_get	GET /configurator/getWaitForIdleTimeout	Gets the current timeout used for waiting for the user interface to go into an idle state.
configurator_set_wait_for_idle_timeout_get	GET /configurator/setWaitForIdleTimeout	Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action.
culebra_help_api_get	GET /culebra/help/{api}	Gets help
culebra_info_get	GET /culebra/info	Gets information about this app.
culebra_quit_get	GET /culebra/quit	Quits culebra server.
device_display_real_size_get	GET /device/displayRealSize	Gets display real size.
device_dumpsys_get	GET /device/dumpsys
device_locale_get	GET /device/locale
device_locale_post	POST /device/locale
device_wait_for_new_toast_get	GET /device/waitForNewToast	Waits for a new Toast.
object_store_clear_get	GET /objectStore/clear	Clears all the objects in store.
object_store_list_get	GET /objectStore/list	Lists the objects in store.
object_store_remove_get	GET /objectStore/remove	Removes an object.
target_context_start_activity_get	GET /targetContext/startActivity	Starts an Activity.
ui_device_clear_last_traversed_text_get	GET /uiDevice/clearLastTraversedText	Clears the text from the last UI traversal event.
ui_device_click_get	GET /uiDevice/click	Clicks at the specified location.
ui_device_click_post	POST /uiDevice/click	Clicks at the specified locations.
ui_device_current_package_name_get	GET /uiDevice/currentPackageName	Gets the current package name.
ui_device_display_height_get	GET /uiDevice/displayHeight	Gets the display height.
ui_device_display_rotation_get	GET /uiDevice/displayRotation	Gets the display rotation.
ui_device_display_size_dp_get	GET /uiDevice/displaySizeDp	Gets the display size in DP.
ui_device_display_width_get	GET /uiDevice/displayWidth	Gets the display width.
ui_device_drag_get	GET /uiDevice/drag	Performs a swipe from one coordinate to another coordinate.
ui_device_dump_window_hierarchy_get	GET /uiDevice/dumpWindowHierarchy	Dumps the window hierarchy.
ui_device_find_object_get	GET /uiDevice/findObject	Finds an object.
ui_device_find_object_post	POST /uiDevice/findObject	Finds an object.
ui_device_find_objects_get	GET /uiDevice/findObjects	Finds all objects that match the selector criteria.
ui_device_find_objects_post	POST /uiDevice/findObjects	Finds all objects.
ui_device_freeze_rotation_get	GET /uiDevice/freezeRotation	Disables the sensors and freezes the device rotation at its current rotation state.
ui_device_has_object_get	GET /uiDevice/hasObject	Returns whether there is a match for the given selector criteria.
ui_device_has_object_post	POST /uiDevice/hasObject	Returns whether there is a match for the given selector criteria.
ui_device_is_natural_orientation_get	GET /uiDevice/isNaturalOrientation	Check if the device is in its natural orientation.
ui_device_is_screen_on_get	GET /uiDevice/isScreenOn	Checks the power manager if the screen is ON.
ui_device_last_traversed_text_get	GET /uiDevice/lastTraversedText	Retrieves the text from the last UI traversal event received.
ui_device_pixel_get	GET /uiDevice/pixel	Gets a pixel from device screen.
ui_device_press_back_get	GET /uiDevice/pressBack	Simulates a short press on the BACK button.
ui_device_press_d_pad_center_get	GET /uiDevice/pressDPadCenter	Simulates a short press on the CENTER button.
ui_device_press_d_pad_down_get	GET /uiDevice/pressDPadDown	Simulates a short press on the DOWN button.
ui_device_press_d_pad_left_get	GET /uiDevice/pressDPadLeft	Simulates a short press on the LEFT button.
ui_device_press_d_pad_right_get	GET /uiDevice/pressDPadRight	Simulates a short press on the RIGHT button.
ui_device_press_d_pad_up_get	GET /uiDevice/pressDPadUp	Simulates a short press on the UP button.
ui_device_press_delete_get	GET /uiDevice/pressDelete	Simulates a short press on the DELETE key.
ui_device_press_enter_get	GET /uiDevice/pressEnter	Simulates a short press on the ENTER key.
ui_device_press_home_get	GET /uiDevice/pressHome	Simulates a short press on the HOME button.
ui_device_press_key_code_get	GET /uiDevice/pressKeyCode	Simulates a short press using a key code.
ui_device_press_recent_apps_get	GET /uiDevice/pressRecentApps	Simulates a short press on the Recent Apps button.
ui_device_product_name_get	GET /uiDevice/productName	Retrieves the product name of the device.
ui_device_screenshot_get	GET /uiDevice/screenshot	Gets the device screenshot.
ui_device_swipe_get	GET /uiDevice/swipe	Performs a swipe.
ui_device_swipe_post	POST /uiDevice/swipe	Performs a swipe between points in the Point array.
ui_device_unfreeze_rotation_get	GET /uiDevice/unfreezeRotation	Re-enables the sensors and un-freezes the device rotation allowing its contents to rotate with the device physical rotation
ui_device_wait_for_idle_get	GET /uiDevice/waitForIdle	Waits for the current application to idle.
ui_device_wait_for_window_update_get	GET /uiDevice/waitForWindowUpdate	Waits for a window content update event to occur.
ui_device_wait_get	GET /uiDevice/wait	Waits for given the condition to be met.
ui_object2_oid_clear_get	GET /uiObject2/{oid}/clear	Clears the text content if this object is an editable field.
ui_object2_oid_click_and_wait_get	GET /uiObject2/{oid}/clickAndWait	Clicks on the specified object.
ui_object2_oid_click_get	GET /uiObject2/{oid}/click	Clicks on the specified object.
ui_object2_oid_dump_get	GET /uiObject2/{oid}/dump	Dumps the specified object.
ui_object2_oid_find_object_get	GET /uiObject2/{oid}/findObject	Finds an object.
ui_object2_oid_find_object_post	POST /uiObject2/{oid}/findObject	Finds an object.
ui_object2_oid_get_child_count_get	GET /uiObject2/{oid}/getChildCount	Returns the number of child elements directly under this object.
ui_object2_oid_get_children_get	GET /uiObject2/{oid}/getChildren
ui_object2_oid_get_content_description_get	GET /uiObject2/{oid}/getContentDescription	Returns the content description for this object.
ui_object2_oid_get_text_get	GET /uiObject2/{oid}/getText	Gets the text content.
ui_object2_oid_long_click_get	GET /uiObject2/{oid}/longClick	Long-clicks on the specified object.
ui_object2_oid_set_text_get	GET /uiObject2/{oid}/setText	Sets the text content if this object is an editable field.
ui_object2_oid_set_text_post	POST /uiObject2/{oid}/setText	Sets the text content if this object is an editable field.
ui_object_oid_clear_text_field_get	GET /uiObject/{oid}/clearTextField	Clears the existing text contents in an editable field.
ui_object_oid_click_and_wait_for_new_window_get	GET /uiObject/{oid}/clickAndWaitForNewWindow	Clicks on the specified object.
ui_object_oid_click_get	GET /uiObject/{oid}/click	Clicks on the specified object.
ui_object_oid_dump_get	GET /uiObject/{oid}/dump	Dumps the specified object.
ui_object_oid_exists_get	GET /uiObject/{oid}/exists	This basically returns immediately whether the view represented by this UiObject exists or not. If you need to wait longer for this view, then see waitForExists.
ui_object_oid_get_bounds_get	GET /uiObject/{oid}/getBounds	Returns the view's bounds property.
ui_object_oid_get_child_count_get	GET /uiObject/{oid}/getChildCount	Counts the child views immediately under the present UiObject.
ui_object_oid_get_child_get	GET /uiObject/{oid}/getChild	The child
ui_object_oid_get_class_name_get	GET /uiObject/{oid}/getClassName	Retrieves the className property of the UI element.
ui_object_oid_get_content_description_get	GET /uiObject/{oid}/getContentDescription	Reads the content_desc property of the UI element.
ui_object_oid_get_from_parent_get	GET /uiObject/{oid}/getFromParent	Creates a new UiObject for a sibling view or a child of the sibling view, relative to the present UiObject.
ui_object_oid_perform_two_pointer_gesture_post	POST /uiObject/{oid}/performTwoPointerGesture
ui_object_oid_pinch_in_get	GET /uiObject/{oid}/pinchIn
ui_object_oid_pinch_out_get	GET /uiObject/{oid}/pinchOut
ui_object_oid_wait_for_exists_get	GET /uiObject/{oid}/waitForExists	This method waits until the view becomes visible on the display, or until the timeout has elapsed. You can use this method in situations where the content that you want to select is not immediately displayed.
until_find_object_get	GET /until/findObject	Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
until_find_object_post	POST /until/findObject	Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
until_find_objects_get	GET /until/findObjects	Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
until_find_objects_post	POST /until/findObjects	Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
until_new_window_get	GET /until/newWindow	Returns a condition that depends on a new window having appeared.
until_oid_dump_get	GET /until/{oid}/dump	Dumps the specified object.

am_force_stop_get

StatusResponse am_force_stop_get(pkg)

Completely stop the given application package.

Completely stop the given application package.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
pkg = 'pkg_example' # str | The package name

try:
    # Completely stop the given application package.
    api_response = api_instance.am_force_stop_get(pkg)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->am_force_stop_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
pkg	str	The package name

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configurator_get_wait_for_idle_timeout_get

Timeout configurator_get_wait_for_idle_timeout_get()

Gets the current timeout used for waiting for the user interface to go into an idle state.

Gets the current timeout used for waiting for the user interface to go into an idle state. By default, all core uiautomator objects except UiDevice will perform this wait before starting to search for the widget specified by the object's UiSelector. Once the idle state is detected or the timeout elapses (whichever occurs firs), the object will start to wait for the selector to find match. See setWaitForSelectorTimeout(long)

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets the current timeout used for waiting for the user interface to go into an idle state.
    api_response = api_instance.configurator_get_wait_for_idle_timeout_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configurator_get_wait_for_idle_timeout_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Timeout

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

configurator_set_wait_for_idle_timeout_get

StatusResponse configurator_set_wait_for_idle_timeout_get(timeout)

Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action.

Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action. By default, all core uiautomator objects except UiDevice will perform this wait before starting to search for the widget specified by the object's UiSelector. Once the idle state is detected or the timeout elapses (whichever occurs first), the object will start to wait for the selector to find a match. See setWaitForSelectorTimeout(long)

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
timeout = 789 # int | Timeout value in milliseconds

try:
    # Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action.
    api_response = api_instance.configurator_set_wait_for_idle_timeout_get(timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configurator_set_wait_for_idle_timeout_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
timeout	int	Timeout value in milliseconds

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

culebra_help_api_get

Help culebra_help_api_get(api)

Gets help

Gets help info about the API specified as parameter. For example you can obtain information about * /uiDevice/click * /device/displayRealSize * /uiDevice/screenshot * etc.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
api = 'api_example' # str | Specify the API help is about

try:
    # Gets help
    api_response = api_instance.culebra_help_api_get(api)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->culebra_help_api_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
api	str	Specify the API help is about

Return type

Help

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

culebra_info_get

CulebraInfo culebra_info_get()

Gets information about this app.

Gets information about this app.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets information about this app.
    api_response = api_instance.culebra_info_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->culebra_info_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CulebraInfo

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

culebra_quit_get

StatusResponse culebra_quit_get()

Quits culebra server.

Quits cuebra server.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Quits culebra server.
    api_response = api_instance.culebra_quit_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->culebra_quit_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_display_real_size_get

DisplayRealSize device_display_real_size_get()

Gets display real size.

Gets the display real size.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets display real size.
    api_response = api_instance.device_display_real_size_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->device_display_real_size_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DisplayRealSize

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_dumpsys_get

device_dumpsys_get(service, arg1=arg1, arg2=arg2, arg3=arg3)

dumpsys is a tool that runs on Android devices and provides information about system services. You can call dumpsys from the command line using the Android Debug Bridge (ADB) to get diagnostic output for all system services running on a connected device.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
service = NULL # object | dumps only service SERVICE
arg1 = NULL # object | argument 1 for dumpsys service command (optional)
arg2 = NULL # object | argument 2 for dumpsys service command (optional)
arg3 = NULL # object | argument 3 for dumpsys service command (optional)

try:
    api_instance.device_dumpsys_get(service, arg1=arg1, arg2=arg2, arg3=arg3)
except ApiException as e:
    print("Exception when calling DefaultApi->device_dumpsys_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
service	object	dumps only service SERVICE
arg1	object	argument 1 for dumpsys service command	[optional]
arg2	object	argument 2 for dumpsys service command	[optional]
arg3	object	argument 3 for dumpsys service command	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_locale_get

Locale device_locale_get()

Gets the device locale

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    api_response = api_instance.device_locale_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->device_locale_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Locale

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_locale_post

StatusResponse device_locale_post(body)

Changes the device locale

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Locale() # Locale | The locale

try:
    api_response = api_instance.device_locale_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->device_locale_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Locale	The locale

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

device_wait_for_new_toast_get

Text device_wait_for_new_toast_get(timeout=timeout)

Waits for a new Toast.

Waits for a new Toast until timeout.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
timeout = 789 # int | The timeout in ms (optional)

try:
    # Waits for a new Toast.
    api_response = api_instance.device_wait_for_new_toast_get(timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->device_wait_for_new_toast_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
timeout	int	The timeout in ms	[optional]

Return type

Text

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

object_store_clear_get

StatusResponse object_store_clear_get()

Clears all the objects in store.

Clears all the objects in store.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Clears all the objects in store.
    api_response = api_instance.object_store_clear_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->object_store_clear_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

object_store_list_get

list[InlineResponse200] object_store_list_get()

Lists the objects in store.

Lists the objects in store.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Lists the objects in store.
    api_response = api_instance.object_store_list_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->object_store_list_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[InlineResponse200]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

object_store_remove_get

StatusResponse object_store_remove_get(oid)

Removes an object.

Removes an object that has been stored in ObjectStore.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Removes an object.
    api_response = api_instance.object_store_remove_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->object_store_remove_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

target_context_start_activity_get

StatusResponse target_context_start_activity_get(pkg, cls, uri=uri)

Starts an Activity.

Starts an Activity.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
pkg = 'pkg_example' # str | the package name
cls = 'cls_example' # str | the class name
uri = 'uri_example' # str | the URI (i. e. https://example.com) (optional)

try:
    # Starts an Activity.
    api_response = api_instance.target_context_start_activity_get(pkg, cls, uri=uri)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->target_context_start_activity_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
pkg	str	the package name
cls	str	the class name
uri	str	the URI (i. e. https://example.com)	[optional]

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_clear_last_traversed_text_get

StatusResponse ui_device_clear_last_traversed_text_get()

Clears the text from the last UI traversal event.

Clears the text from the last UI traversal event.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Clears the text from the last UI traversal event.
    api_response = api_instance.ui_device_clear_last_traversed_text_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_clear_last_traversed_text_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_click_get

StatusResponse ui_device_click_get(x, y)

Clicks at the specified location.

Clicks at the specified location.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
x = 56 # int | x coordinate
y = 56 # int | y coordinate

try:
    # Clicks at the specified location.
    api_response = api_instance.ui_device_click_get(x, y)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_click_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x	int	x coordinate
y	int	y coordinate

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_click_post

StatusResponse ui_device_click_post(body)

Clicks at the specified locations.

Clicks at the specified locations.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.ClickBody() # ClickBody | 

try:
    # Clicks at the specified locations.
    api_response = api_instance.ui_device_click_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_click_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ClickBody

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_current_package_name_get

CurrentPackageName ui_device_current_package_name_get()

Gets the current package name.

Gets the current package name.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets the current package name.
    api_response = api_instance.ui_device_current_package_name_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_current_package_name_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

CurrentPackageName

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_display_height_get

DisplayHeight ui_device_display_height_get()

Gets the display height.

Gets the display height.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets the display height.
    api_response = api_instance.ui_device_display_height_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_display_height_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DisplayHeight

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_display_rotation_get

DisplayRotationResponse ui_device_display_rotation_get()

Gets the display rotation.

Gets the display rotation.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets the display rotation.
    api_response = api_instance.ui_device_display_rotation_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_display_rotation_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DisplayRotationResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_display_size_dp_get

DisplaySizeDp ui_device_display_size_dp_get()

Gets the display size in DP.

Gets the display size in DP.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets the display size in DP.
    api_response = api_instance.ui_device_display_size_dp_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_display_size_dp_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DisplaySizeDp

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_display_width_get

DisplayWidth ui_device_display_width_get()

Gets the display width.

Gets the display width.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Gets the display width.
    api_response = api_instance.ui_device_display_width_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_display_width_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DisplayWidth

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_drag_get

StatusResponse ui_device_drag_get(start_x, start_y, end_x, end_y, steps)

Performs a swipe from one coordinate to another coordinate.

Performs a swipe from one coordinate to another coordinate. You can control the smoothness and speed of the swipe by specifying the number of steps. Each step execution is throttled to 5 milliseconds per step, so for a 100 steps, the swipe will take around 0.5 seconds to complete.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
start_x = 56 # int | from x
start_y = 56 # int | from y
end_x = 56 # int | to x
end_y = 56 # int | end y
steps = 56 # int | is the number of move steps sent to the system

try:
    # Performs a swipe from one coordinate to another coordinate.
    api_response = api_instance.ui_device_drag_get(start_x, start_y, end_x, end_y, steps)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_drag_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_x	int	from x
start_y	int	from y
end_x	int	to x
end_y	int	end y
steps	int	is the number of move steps sent to the system

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_dump_window_hierarchy_get

WindowHierarchy ui_device_dump_window_hierarchy_get(format=format)

Dumps the window hierarchy.

Dumps the window hierarchy.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
format = 'format_example' # str | the output format (optional)

try:
    # Dumps the window hierarchy.
    api_response = api_instance.ui_device_dump_window_hierarchy_get(format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_dump_window_hierarchy_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
format	str	the output format	[optional]

Return type

WindowHierarchy

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_find_object_get

ObjectRef ui_device_find_object_get(resource_id=resource_id, ui_selector=ui_selector, by_selector=by_selector)

Finds an object.

Finds an object. The object found, if any, can be later used in other call like API.click.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
resource_id = 'resource_id_example' # str | the resource id (optional)
ui_selector = 'ui_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - clazz or className - clickable - depth - desc - index - instance - package - parentIndex - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)
by_selector = 'by_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # Finds an object.
    api_response = api_instance.ui_device_find_object_get(resource_id=resource_id, ui_selector=ui_selector, by_selector=by_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_find_object_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	str	the resource id	[optional]
ui_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - clazz or className - clickable - depth - desc - index - instance - package - parentIndex - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]
by_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_find_object_post

ObjectRef ui_device_find_object_post(body)

Finds an object.

Finds an object. The object found, if any, can be later used in other call like API.click.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Selector() # Selector | Selector

try:
    # Finds an object.
    api_response = api_instance.ui_device_find_object_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_find_object_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Selector	Selector

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_find_objects_get

list[ObjectRef] ui_device_find_objects_get(by_selector=by_selector)

Finds all objects that match the selector criteria.

Finds objects. The object found, if any, can be later used in other call like API.click.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
by_selector = 'by_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # Finds *all* objects that match the selector criteria.
    api_response = api_instance.ui_device_find_objects_get(by_selector=by_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_find_objects_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
by_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

list[ObjectRef]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_find_objects_post

list[ObjectRef] ui_device_find_objects_post(body)

Finds all objects.

Finds all objects. The objects found, if any, can be later used in other call like API.click.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Selector() # Selector | Selector

try:
    # Finds *all* objects.
    api_response = api_instance.ui_device_find_objects_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_find_objects_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Selector	Selector

Return type

list[ObjectRef]

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_freeze_rotation_get

StatusResponse ui_device_freeze_rotation_get()

Disables the sensors and freezes the device rotation at its current rotation state.

Disables the sensors and freezes the device rotation at its current rotation state.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Disables the sensors and freezes the device rotation at its current rotation state.
    api_response = api_instance.ui_device_freeze_rotation_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_freeze_rotation_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_has_object_get

BooleanResponse ui_device_has_object_get(by_selector)

Returns whether there is a match for the given selector criteria.

Returns whether there is a match for the given selector criteria.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
by_selector = 'by_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created.

try:
    # Returns whether there is a match for the given selector criteria.
    api_response = api_instance.ui_device_has_object_get(by_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_has_object_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
by_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_has_object_post

BooleanResponse ui_device_has_object_post(body)

Returns whether there is a match for the given selector criteria.

Returns whether there is a match for the given selector criteria.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Selector() # Selector | Selector

try:
    # Returns whether there is a match for the given selector criteria.
    api_response = api_instance.ui_device_has_object_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_has_object_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Selector	Selector

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_is_natural_orientation_get

BooleanResponse ui_device_is_natural_orientation_get()

Check if the device is in its natural orientation.

This is determined by checking if the orientation is at 0 or 180 degrees.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Check if the device is in its natural orientation.
    api_response = api_instance.ui_device_is_natural_orientation_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_is_natural_orientation_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_is_screen_on_get

BooleanResponse ui_device_is_screen_on_get()

Checks the power manager if the screen is ON.

Checks the power manager if the screen is ON.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Checks the power manager if the screen is ON.
    api_response = api_instance.ui_device_is_screen_on_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_is_screen_on_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_last_traversed_text_get

LastTraversedText ui_device_last_traversed_text_get()

Retrieves the text from the last UI traversal event received.

Retrieves the text from the last UI traversal event received.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Retrieves the text from the last UI traversal event received.
    api_response = api_instance.ui_device_last_traversed_text_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_last_traversed_text_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

LastTraversedText

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_pixel_get

Pixel ui_device_pixel_get(x, y)

Gets a pixel from device screen.

Gets a pixel on the device screen screenshot.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
x = 56 # int | The x coordinate
y = 56 # int | The y coordinate

try:
    # Gets a pixel from device screen.
    api_response = api_instance.ui_device_pixel_get(x, y)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_pixel_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
x	int	The x coordinate
y	int	The y coordinate

Return type

Pixel

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_back_get

StatusResponse ui_device_press_back_get()

Simulates a short press on the BACK button.

Simulates a short press on the BACK button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the BACK button.
    api_response = api_instance.ui_device_press_back_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_back_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_d_pad_center_get

StatusResponse ui_device_press_d_pad_center_get()

Simulates a short press on the CENTER button.

Simulates a short press on the CENTER button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the CENTER button.
    api_response = api_instance.ui_device_press_d_pad_center_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_d_pad_center_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_d_pad_down_get

StatusResponse ui_device_press_d_pad_down_get()

Simulates a short press on the DOWN button.

Simulates a short press on the DOWN button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the DOWN button.
    api_response = api_instance.ui_device_press_d_pad_down_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_d_pad_down_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_d_pad_left_get

StatusResponse ui_device_press_d_pad_left_get()

Simulates a short press on the LEFT button.

Simulates a short press on the LEFT button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the LEFT button.
    api_response = api_instance.ui_device_press_d_pad_left_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_d_pad_left_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_d_pad_right_get

StatusResponse ui_device_press_d_pad_right_get()

Simulates a short press on the RIGHT button.

Simulates a short press on the RIGHT button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the RIGHT button.
    api_response = api_instance.ui_device_press_d_pad_right_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_d_pad_right_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_d_pad_up_get

StatusResponse ui_device_press_d_pad_up_get()

Simulates a short press on the UP button.

Simulates a short press on the UP button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the UP button.
    api_response = api_instance.ui_device_press_d_pad_up_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_d_pad_up_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_delete_get

StatusResponse ui_device_press_delete_get()

Simulates a short press on the DELETE key.

Simulates a short press on the DELETE key.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the DELETE key.
    api_response = api_instance.ui_device_press_delete_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_delete_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_enter_get

StatusResponse ui_device_press_enter_get()

Simulates a short press on the ENTER key.

Simulates a short press on the ENTER key.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the ENTER key.
    api_response = api_instance.ui_device_press_enter_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_enter_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_home_get

StatusResponse ui_device_press_home_get()

Simulates a short press on the HOME button.

Simulates a short press on the HOME button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the HOME button.
    api_response = api_instance.ui_device_press_home_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_home_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_key_code_get

StatusResponse ui_device_press_key_code_get(key_code, meta_state=meta_state)

Simulates a short press using a key code.

Simulates a short press using a key code.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
key_code = 56 # int | the key code of the event.
meta_state = 56 # int | an integer in which each bit set to 1 represents a pressed meta key (optional)

try:
    # Simulates a short press using a key code.
    api_response = api_instance.ui_device_press_key_code_get(key_code, meta_state=meta_state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_key_code_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
key_code	int	the key code of the event.
meta_state	int	an integer in which each bit set to 1 represents a pressed meta key	[optional]

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_press_recent_apps_get

StatusResponse ui_device_press_recent_apps_get()

Simulates a short press on the Recent Apps button.

Simulates a short press on the Recent Apps button.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Simulates a short press on the Recent Apps button.
    api_response = api_instance.ui_device_press_recent_apps_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_press_recent_apps_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_product_name_get

ProductName ui_device_product_name_get()

Retrieves the product name of the device.

Retrieves the product name of the device.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Retrieves the product name of the device.
    api_response = api_instance.ui_device_product_name_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_product_name_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ProductName

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_screenshot_get

str ui_device_screenshot_get(scale=scale, quality=quality)

Gets the device screenshot.

Gets the device screenshot and can be influenced by the parameters. For example the scale of the screenshot or its quality can be specified. NOTE: UiDevice.takeScreenshot() usually ignores these parameters so expect no change.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
scale = 3.4 # float | The scale of the screenshot (i.e. 0.5) (optional)
quality = 56 # int | The quality of the screenshot (i.e. 100) (optional)

try:
    # Gets the device screenshot.
    api_response = api_instance.ui_device_screenshot_get(scale=scale, quality=quality)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_screenshot_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
scale	float	The scale of the screenshot (i.e. 0.5)	[optional]
quality	int	The quality of the screenshot (i.e. 100)	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: image/png, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_swipe_get

StatusResponse ui_device_swipe_get(start_x, start_y, end_x, end_y, steps)

Performs a swipe.

Performs a swipe from one coordinate to another using the number of steps to determine smoothness and speed. Each step execution is throttled to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
start_x = 56 # int | from x
start_y = 56 # int | from y
end_x = 56 # int | to x
end_y = 56 # int | end y
steps = 56 # int | is the number of move steps sent to the system

try:
    # Performs a swipe.
    api_response = api_instance.ui_device_swipe_get(start_x, start_y, end_x, end_y, steps)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_swipe_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_x	int	from x
start_y	int	from y
end_x	int	to x
end_y	int	end y
steps	int	is the number of move steps sent to the system

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_swipe_post

StatusResponse ui_device_swipe_post(body)

Performs a swipe between points in the Point array.

Each step execution is throttled to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.SwipeBody() # SwipeBody | 

try:
    # Performs a swipe between points in the Point array.
    api_response = api_instance.ui_device_swipe_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_swipe_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SwipeBody

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_unfreeze_rotation_get

StatusResponse ui_device_unfreeze_rotation_get()

Re-enables the sensors and un-freezes the device rotation allowing its contents to rotate with the device physical rotation

During a test execution, it is best to keep the device frozen in a specific orientation until the test case execution has completed.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Re-enables the sensors and un-freezes the device rotation allowing its contents to rotate with the device physical rotation
    api_response = api_instance.ui_device_unfreeze_rotation_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_unfreeze_rotation_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_wait_for_idle_get

StatusResponse ui_device_wait_for_idle_get(timeout=timeout)

Waits for the current application to idle.

Waits for the current application to idle.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
timeout = 10000 # int | in milliseconds (optional) (default to 10000)

try:
    # Waits for the current application to idle.
    api_response = api_instance.ui_device_wait_for_idle_get(timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_wait_for_idle_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
timeout	int	in milliseconds	[optional] [default to 10000]

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_wait_for_window_update_get

StatusResponse ui_device_wait_for_window_update_get(timeout, package_name=package_name)

Waits for a window content update event to occur.

If a package name for the window is specified, but the current window does not have the same package name, the function returns immediately.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
timeout = 789 # int | in milliseconds
package_name = 'package_name_example' # str | the specified window package name (can be null or not present). If null, a window update from any front-end window will end the wait. (optional)

try:
    # Waits for a window content update event to occur.
    api_response = api_instance.ui_device_wait_for_window_update_get(timeout, package_name=package_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_wait_for_window_update_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
timeout	int	in milliseconds
package_name	str	the specified window package name (can be null or not present). If null, a window update from any front-end window will end the wait.	[optional]

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_device_wait_get

AnyValue ui_device_wait_get(oid, timeout=timeout)

Waits for given the condition to be met.

The final result returned by the condition, or null if the condition was not met before the timeout.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 789 # int | The search condition object ID
timeout = 789 # int | The timeout in ms (optional)

try:
    # Waits for given the condition to be met.
    api_response = api_instance.ui_device_wait_get(oid, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_device_wait_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The search condition object ID
timeout	int	The timeout in ms	[optional]

Return type

AnyValue

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_clear_get

StatusResponse ui_object2_oid_clear_get(oid)

Clears the text content if this object is an editable field.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Clears the text content if this object is an editable field.
    api_response = api_instance.ui_object2_oid_clear_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_clear_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_click_and_wait_get

StatusResponse ui_object2_oid_click_and_wait_get(oid, event_condition_ref, timeout=timeout)

Clicks on the specified object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
event_condition_ref = 789 # int | The event condition
timeout = 10000 # int | in milliseconds (optional) (default to 10000)

try:
    # Clicks on the specified object.
    api_response = api_instance.ui_object2_oid_click_and_wait_get(oid, event_condition_ref, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_click_and_wait_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
event_condition_ref	int	The event condition
timeout	int	in milliseconds	[optional] [default to 10000]

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_click_get

StatusResponse ui_object2_oid_click_get(oid)

Clicks on the specified object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Clicks on the specified object.
    api_response = api_instance.ui_object2_oid_click_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_click_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_dump_get

Selector ui_object2_oid_dump_get(oid)

Dumps the specified object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Dumps the specified object.
    api_response = api_instance.ui_object2_oid_dump_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_dump_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

Selector

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_find_object_get

ObjectRef ui_object2_oid_find_object_get(oid, by_selector=by_selector)

Finds an object.

Searches all elements under this object and returns the first object to match the criteria, or not found if no matching objects are found.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
by_selector = 'by_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # Finds an object.
    api_response = api_instance.ui_object2_oid_find_object_get(oid, by_selector=by_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_find_object_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
by_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_find_object_post

ObjectRef ui_object2_oid_find_object_post(body, oid)

Finds an object.

Searches all elements under this object and returns the first object to match the criteria, or not found if no matching objects are found.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Selector() # Selector | Selector
oid = 56 # int | The object ID

try:
    # Finds an object.
    api_response = api_instance.ui_object2_oid_find_object_post(body, oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_find_object_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Selector	Selector
oid	int	The object ID

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_get_child_count_get

NumberResponse ui_object2_oid_get_child_count_get(oid)

Returns the number of child elements directly under this object.

Returns the number of child elements directly under this object.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Returns the number of child elements directly under this object.
    api_response = api_instance.ui_object2_oid_get_child_count_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_get_child_count_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

NumberResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_get_children_get

list[ObjectRef] ui_object2_oid_get_children_get(oid)

Returns a collection of the child elements directly under this object.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    api_response = api_instance.ui_object2_oid_get_children_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_get_children_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

list[ObjectRef]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_get_content_description_get

Text ui_object2_oid_get_content_description_get(oid)

Returns the content description for this object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Returns the content description for this object.
    api_response = api_instance.ui_object2_oid_get_content_description_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_get_content_description_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

Text

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_get_text_get

Text ui_object2_oid_get_text_get(oid)

Gets the text content.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Gets the text content.
    api_response = api_instance.ui_object2_oid_get_text_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_get_text_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

Text

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_long_click_get

StatusResponse ui_object2_oid_long_click_get(oid)

Long-clicks on the specified object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Long-clicks on the specified object.
    api_response = api_instance.ui_object2_oid_long_click_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_long_click_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_set_text_get

StatusResponse ui_object2_oid_set_text_get(oid, text)

Sets the text content if this object is an editable field.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
text = 'text_example' # str | Text to enter in the field

try:
    # Sets the text content if this object is an editable field.
    api_response = api_instance.ui_object2_oid_set_text_get(oid, text)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_set_text_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
text	str	Text to enter in the field

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object2_oid_set_text_post

StatusResponse ui_object2_oid_set_text_post(body, oid)

Sets the text content if this object is an editable field.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Text() # Text | Text to enter in the field
oid = 56 # int | The object ID

try:
    # Sets the text content if this object is an editable field.
    api_response = api_instance.ui_object2_oid_set_text_post(body, oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object2_oid_set_text_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Text	Text to enter in the field
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_clear_text_field_get

StatusResponse ui_object_oid_clear_text_field_get(oid)

Clears the existing text contents in an editable field.

Clears the existing text contents in an editable field. The UiSelector of this object must reference a UI element that is editable. When you call this method, the method sets focus on the editable field, selects all of its existing content, and clears it by sending a DELETE key press.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Clears the existing text contents in an editable field.
    api_response = api_instance.ui_object_oid_clear_text_field_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_clear_text_field_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_click_and_wait_for_new_window_get

BooleanResponse ui_object_oid_click_and_wait_for_new_window_get(oid, timeout=timeout)

Clicks on the specified object.

Performs a click at the center of the visible bounds of the UI element represented by this UiObject and waits for window transitions. This method differ from click only in that this method waits for a a new window transition as a result of the click.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
timeout = 10000 # int | Timeout in milliseconds (optional) (default to 10000)

try:
    # Clicks on the specified object.
    api_response = api_instance.ui_object_oid_click_and_wait_for_new_window_get(oid, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_click_and_wait_for_new_window_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
timeout	int	Timeout in milliseconds	[optional] [default to 10000]

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_click_get

StatusResponse ui_object_oid_click_get(oid)

Clicks on the specified object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Clicks on the specified object.
    api_response = api_instance.ui_object_oid_click_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_click_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_dump_get

Selector ui_object_oid_dump_get(oid)

Dumps the specified object.

The target object should have been found using findObject with a selector.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Dumps the specified object.
    api_response = api_instance.ui_object_oid_dump_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_dump_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

Selector

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_exists_get

BooleanResponse ui_object_oid_exists_get(oid)

This basically returns immediately whether the view represented by this UiObject exists or not. If you need to wait longer for this view, then see waitForExists.

Check if view exists. This methods performs a waitForExists with zero timeout.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # This basically returns immediately whether the view represented by this UiObject exists or not. If you need to wait longer for this view, then see waitForExists.
    api_response = api_instance.ui_object_oid_exists_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_exists_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_get_bounds_get

Rect ui_object_oid_get_bounds_get(oid)

Returns the view's bounds property.

Returns the view's bounds property. See getVisibleBounds.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Returns the view's bounds property.
    api_response = api_instance.ui_object_oid_get_bounds_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_get_bounds_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

Rect

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_get_child_count_get

NumberResponse ui_object_oid_get_child_count_get(oid)

Counts the child views immediately under the present UiObject.

Counts the child views immediately under the present UiObject.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Counts the child views immediately under the present UiObject.
    api_response = api_instance.ui_object_oid_get_child_count_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_get_child_count_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

NumberResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_get_child_get

ObjectRef ui_object_oid_get_child_get(oid, ui_selector=ui_selector)

The child

Creates a new UiObject for a child view that is under the present UiObject.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
ui_selector = 'ui_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - clazz or className - clickable - depth - desc - index - instance - package - parentIndex - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # The child
    api_response = api_instance.ui_object_oid_get_child_get(oid, ui_selector=ui_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_get_child_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
ui_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - clazz or className - clickable - depth - desc - index - instance - package - parentIndex - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_get_class_name_get

StringResponse ui_object_oid_get_class_name_get(oid)

Retrieves the className property of the UI element.

Retrieves the className property of the UI element.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Retrieves the className property of the UI element.
    api_response = api_instance.ui_object_oid_get_class_name_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_get_class_name_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StringResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_get_content_description_get

StringResponse ui_object_oid_get_content_description_get(oid)

Reads the content_desc property of the UI element.

Reads the content_desc property of the UI element.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Reads the content_desc property of the UI element.
    api_response = api_instance.ui_object_oid_get_content_description_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_get_content_description_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

StringResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_get_from_parent_get

ObjectRef ui_object_oid_get_from_parent_get(oid, ui_selector=ui_selector)

Creates a new UiObject for a sibling view or a child of the sibling view, relative to the present UiObject.

Creates a new UiObject for a sibling view or a child of the sibling view, relative to the present UiObject.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
ui_selector = 'ui_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - clazz or className - clickable - depth - desc - index - instance - package - parentIndex - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # Creates a new UiObject for a sibling view or a child of the sibling view, relative to the present UiObject.
    api_response = api_instance.ui_object_oid_get_from_parent_get(oid, ui_selector=ui_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_get_from_parent_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
ui_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - clazz or className - clickable - depth - desc - index - instance - package - parentIndex - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_perform_two_pointer_gesture_post

StatusResponse ui_object_oid_perform_two_pointer_gesture_post(oid, body=body)

Generates a two-pointer gesture with arbitrary starting and ending points.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
body = culebratester_client.PerformTwoPointerGestureBody() # PerformTwoPointerGestureBody |  (optional)

try:
    api_response = api_instance.ui_object_oid_perform_two_pointer_gesture_post(oid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_perform_two_pointer_gesture_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
body	PerformTwoPointerGestureBody		[optional]

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_pinch_in_get

StatusResponse ui_object_oid_pinch_in_get(oid, percentage, steps)

Performs a two-pointer gesture, where each pointer moves diagonally toward the other, from the edges to the center of this UiObject.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
percentage = 56 # int | percentage of the object's diagonal length for the pinch gesture
steps = 56 # int | the number of steps for the gesture. Steps are injected about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.

try:
    api_response = api_instance.ui_object_oid_pinch_in_get(oid, percentage, steps)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_pinch_in_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
percentage	int	percentage of the object's diagonal length for the pinch gesture
steps	int	the number of steps for the gesture. Steps are injected about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_pinch_out_get

StatusResponse ui_object_oid_pinch_out_get(oid, percentage, steps)

Performs a two-pointer gesture, where each pointer moves diagonally opposite across the other, from the center out towards the edges of the this UiObject.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
percentage = 56 # int | percentage of the object's diagonal length for the pinch gesture
steps = 56 # int | the number of steps for the gesture. Steps are injected about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.

try:
    api_response = api_instance.ui_object_oid_pinch_out_get(oid, percentage, steps)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_pinch_out_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
percentage	int	percentage of the object's diagonal length for the pinch gesture
steps	int	the number of steps for the gesture. Steps are injected about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.

Return type

StatusResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ui_object_oid_wait_for_exists_get

BooleanResponse ui_object_oid_wait_for_exists_get(oid, timeout)

This method waits until the view becomes visible on the display, or until the timeout has elapsed. You can use this method in situations where the content that you want to select is not immediately displayed.

Waits a specified length of time for a view to become visible.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID
timeout = 789 # int | the amount of time to wait (in milliseconds)

try:
    # This method waits until the view becomes visible on the display, or until the timeout has elapsed. You can use this method in situations where the content that you want to select is not immediately displayed.
    api_response = api_instance.ui_object_oid_wait_for_exists_get(oid, timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->ui_object_oid_wait_for_exists_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID
timeout	int	the amount of time to wait (in milliseconds)

Return type

BooleanResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

until_find_object_get

ObjectRef until_find_object_get(by_selector=by_selector)

Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.

The condition will return the first matching element.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
by_selector = 'by_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
    api_response = api_instance.until_find_object_get(by_selector=by_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->until_find_object_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
by_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

until_find_object_post

ObjectRef until_find_object_post(body)

Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.

The condition will return the first matching element.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Selector() # Selector | Selector

try:
    # Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
    api_response = api_instance.until_find_object_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->until_find_object_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Selector	Selector

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

until_find_objects_get

ObjectRef until_find_objects_get(by_selector=by_selector)

Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.

Finds an object. The object found, if any, can be later used in other call like API.click.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
by_selector = 'by_selector_example' # str | the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\\$]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `$` then a `Pattern` is created. (optional)

try:
    # Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
    api_response = api_instance.until_find_objects_get(by_selector=by_selector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->until_find_objects_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
by_selector	str	the selector sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the selector parameter and all other criteria for this selector are met. The format of the selector string is `sel@[\]value,...` Where `sel` can be one of - checkable - clazz - clickable - depth - desc - package - res - scrollable - text `@` replaces the `=` sign that is used to separate parameters and values in the URL. If the first character of value is `` then a `Pattern` is created.	[optional]

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

until_find_objects_post

ObjectRef until_find_objects_post(body)

Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.

Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
body = culebratester_client.Selector() # Selector | Selector

try:
    # Returns a SearchCondition that is satisfied when at least one element matching the selector can be found.
    api_response = api_instance.until_find_objects_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->until_find_objects_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Selector	Selector

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

until_new_window_get

ObjectRef until_new_window_get()

Returns a condition that depends on a new window having appeared.

Returns a condition that depends on a new window having appeared.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()

try:
    # Returns a condition that depends on a new window having appeared.
    api_response = api_instance.until_new_window_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->until_new_window_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ObjectRef

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

until_oid_dump_get

str until_oid_dump_get(oid)

Dumps the specified object.

Dumps the Until object.

Example

from __future__ import print_function
import time
import culebratester_client
from culebratester_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = culebratester_client.DefaultApi()
oid = 56 # int | The object ID

try:
    # Dumps the specified object.
    api_response = api_instance.until_oid_dump_get(oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->until_oid_dump_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
oid	int	The object ID

Return type

str

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]