appium-xcuitest-driver/build/lib/commands/element.d.ts

Appium driver for iOS using XCUITest for backend

declare namespace _default {
    /**
     * @this {XCUITestDriver}
     */
    function elementDisplayed(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     */
    function elementEnabled(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     */
    function elementSelected(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     */
    function getName(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     */
    function getNativeAttribute(this: import("../driver").XCUITestDriver, attribute: any, el: any): Promise<string | null>;
    /**
     * @this {XCUITestDriver}
     */
    function getAttribute(this: import("../driver").XCUITestDriver, attribute: any, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     */
    function getProperty(this: import("../driver").XCUITestDriver, property: any, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     */
    function getText(this: import("../driver").XCUITestDriver, el: any): Promise<any>;
    /**
     * @this {XCUITestDriver}
     * @returns {Promise<import('@appium/types').Rect>}
     */
    function getElementRect(this: import("../driver").XCUITestDriver, el: any): Promise<import("@appium/types").Rect>;
    /**
     * Get the position of an element on screen
     *
     * @param {string|Element} elementId - the element ID
     * @returns {Promise<Position>} The position of the element
     * @deprecated Use {@linkcode XCUITestDriver.getElementRect} instead
     * @this {XCUITestDriver}
     */
    function getLocation(this: import("../driver").XCUITestDriver, elementId: string | Element): Promise<Position>;
    /**
     * Alias for {@linkcode XCUITestDriver.getLocation}
     * @param {string|Element} elementId - the element ID
     * @returns {Promise<Position>} The position of the element
     * @deprecated Use {@linkcode XCUITestDriver.getElementRect} instead
     * @this {XCUITestDriver}
     */
    function getLocationInView(this: import("../driver").XCUITestDriver, elementId: string | Element): Promise<Position>;
    /**
     * Get the size of an element
     * @param {string|Element} el - the element ID
     * @returns {Promise<Size>} The position of the element
     * @this {XCUITestDriver}
     */
    function getSize(this: import("../driver").XCUITestDriver, el: string | Element): Promise<Size>;
    /**
     * Alias for {@linkcode setValue}
     *
     * @param {string} value - the value to set
     * @param {string} el - the element to set the value of
     * @deprecated
     * @this {XCUITestDriver}
     */
    function setValueImmediate(this: import("../driver").XCUITestDriver, value: string, el: string): Promise<void>;
    /**
     * @this {XCUITestDriver}
     */
    function setValue(this: import("../driver").XCUITestDriver, value: any, el: any): Promise<void>;
    /**
     * Set value with Atom for Web. This method calls `type` atom only.
     * Expected to be called as part of {@linkcode setValue}.
     * @this {XCUITestDriver}
     * @param {import('./types').AtomsElement<string>} atomsElement A target element to type the given value.
     * @param {string|string[]} value The actual text to type.
     */
    function setValueWithWebAtom(this: import("../driver").XCUITestDriver, atomsElement: import("./types").AtomsElement<string>, value: string | string[]): Promise<void>;
    /**
     * Send keys to the app
     * @param {string[]} value - Array of keys to send
     * @this {XCUITestDriver}
     * @deprecated Use {@linkcode XCUITestDriver.setValue} instead
     */
    function keys(this: import("../driver").XCUITestDriver, value: string[]): Promise<void>;
    /**
     * @this {XCUITestDriver}
     */
    function clear(this: import("../driver").XCUITestDriver, el: any): Promise<void>;
    /**
     * @this {XCUITestDriver}
     */
    function getContentSize(this: import("../driver").XCUITestDriver, el: any): Promise<string>;
    /**
     * @this {XCUITestDriver}
     * @returns {Promise<Rect>}
     */
    function getNativeRect(this: import("../driver").XCUITestDriver, el: any): Promise<Rect>;
}
export default _default;
export type XCUITestDriver = import("../driver").XCUITestDriver;
export type Element = import("@appium/types").Element;
export type Position = import("@appium/types").Position;
export type Size = import("@appium/types").Size;
export type Rect = import("@appium/types").Rect;
//# sourceMappingURL=element.d.ts.map