ui-element.d.ts

import { Point } from "./point";
import { Direction } from "./direction";
import { INsCapabilities } from "./interfaces/ns-capabilities";
export declare class UIElement {
    private _element;
    private _driver;
    private _wd;
    private _webio;
    private _args;
    private _searchMethod;
    private _searchParams;
    private _index?;
    private static readonly DEFAULT_REFETCH_TIME;
    constructor(_element: any, _driver: any, _wd: any, _webio: any, _args: INsCapabilities, _searchMethod: string, _searchParams: string, _index?: number);
    /**
     * Click on element
     */
    click(): Promise<any>;
    tapCenter(): Promise<void>;
    tapAtTheEnd(): Promise<void>;
    /**
     * @deprecated
     * Tap on element
     * This method is not working very good with UiAutomator2
     * It is better to use click instead.
     */
    tap(): Promise<any>;
    /**
     * Double tap on element
     */
    doubleTap(): Promise<any>;
    /**
     * Get location of element
     */
    location(): Promise<Point>;
    /**
     * Get size of element
     */
    size(): Promise<Point>;
    /**
     * Get text of element
     */
    text(): Promise<any>;
    /**
    * Returns if an element is selected
    */
    isSelected(): Promise<any>;
    /**
     * Selected an element
     */
    select(retries?: number): Promise<any>;
    /**
     * Returns if an element is checked
     */
    isChecked(): Promise<boolean>;
    /**
     * Get web driver element
     */
    element(): Promise<any>;
    /**
     * Shows if element is displayed. Returns true or false. If the element doesn't exist it will return false
     */
    isDisplayed(): Promise<boolean>;
    /**
     * Returns true or false
     */
    exists(): Promise<boolean>;
    /**
     * Waits until the element exists not.
     * @param wait
     */
    waitForExistNot(wait?: number): Promise<any>;
    /**
     * Wait until the elements appear
     * @param wait
     */
    waitForExist(wait?: number): Promise<any>;
    /**
     * Get attribute of element
     * @param attr
     */
    getAttribute(attr: any): Promise<any>;
    /**
     * Get rectangle of element
     */
    getRectangle(): Promise<{
        x: number;
        y: number;
        width: number;
        height: number;
    }>;
    /**
     * Get rectangle of element in actual dimensions
     */
    getActualRectangle(): Promise<{
        x: number;
        y: number;
        width: number;
        height: number;
    }>;
    /**
     * Scroll with offset from element with minimum inertia
     * @param direction
     * @param yOffset
     * @param xOffset
     */
    scroll(direction: Direction, yOffset?: number, xOffset?: number): Promise<void>;
    /**
     * Scroll with offset from element with minimum inertia
     * @param direction
     * @param yOffset
     * @param xOffset
     */
    scrollTo(direction: Direction, elementToSearch: () => Promise<UIElement>, yOffset?: number, xOffset?: number, retries?: number): Promise<UIElement>;
    /**
 * Drag element with specific offset
 * @param direction
 * @param yOffset
 * @param xOffset - default value 0
 */
    drag(direction: Direction, yOffset: number, xOffset?: number): Promise<void>;
    /**
     * Click and hold over an element
     * @param time in milliseconds to increase the default press period.
     */
    hold(time?: number): Promise<void>;
    /**
     * Send keys to field or other UI component
     * @param text
     * @param shouldClearText, default value is true
     * @param useAdb, default value is false. Usable for Android ONLY !
     */
    sendKeys(text: string, shouldClearText?: boolean, useAdb?: boolean): Promise<void>;
    /**
    * Type text to field or other UI component
    * @param text
    * @param shouldClearText, default value is true
    */
    type(text: string, shouldClearText?: boolean): Promise<void>;
    /**
    * Send key code to device
    * @param key code
    */
    pressKeycode(keyCode: number): Promise<void>;
    /**
    * Clears text from ui element
    */
    clearText(): Promise<void>;
    /**
    * Clears text from ui element with ADB. Android ONLY !
    * @param charactersCount Characters count to delete. (Optional - default value 10)
    */
    adbDeleteText(charactersCount?: number): Promise<void>;
    log(): Promise<void>;
    refetch(): Promise<any>;
    /**
     * Easy to use in order to chain and search for nested elements
     */
    driver(): any;
    /**
    * Swipe element left/right
    * @param direction
    */
    swipe(direction: Direction): Promise<void>;
}